Integration Queues

patch

https://app.financekey.com/OData/IntegrationQueues({key})

The Integration Queue defines the items that need to be 'pulled' or 'pushed' to the integrated platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

integrationId

int32

IntegrationId is a unique identifier of type int used to identify each record in the IntegrationQueue database table. It is a primary key that identifies the source and target information to be integrated.

itemName

string

required

length between 1 and 450

The ItemName field of data type nvarchar in the IntegrationQueue table contains the name of the item that is to be integrated.

actionLogId

int32 | null

ActionLogId is an int data type used in the IntegrationQueue table to store and track a unique integer identifier for each entry in the IntegrationQueue table. This is used to record the process when a message log is required for traceability and for troubleshooting.

itemId

string

required

length between 1 and 450

The ItemId field in the IntegrationQueue table is an nvarchar data type with a maximum length of 450 characters. It is used to store a unique identifier for each item that is added to the queue. This identifier is used to distinguish each item from other items that have been added.

itemUpdatedOn

date-time

required

The field ItemUpdatedOn in the IntegrationQueue table is of data type datetime2 and stores the timestamp of when a specific item in the queue was last updated.

attempt

int32

Attempt is an integer field in the IntegrationQueue table which keeps track of how many times the integration procedure has been attempted. It is reset to 0 whenever an integration attempt is successful.

itemRowVersion

string | null

integrationQueueStateId

string | null

IntegrationQueueStateId is a nvarchar field in the IntegrationQueue table that stores a unique identifier (up to 450 characters) associated with a specific state in a queueing integration process.

clientIntegrationId

int32 | null

ClientIntegrationId: An integer representing the unique identifier for the client’s integration instance within the IntegrationQueue. This field is used to associate specific integration tasks with corresponding client identifiers, ensuring efficient tracking and management of integration processes.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!