Integration Queue Jobs

post

https://app.financekey.com/OData/v_IntegrationQueueJobs

Shows a list of jobs created for an integration queue item. This entity view was created for the purpose of displaying the jobs associated with an integration queue to assist in the process of troubleshooting problematic integrations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

integrationQueueId

int32

The IntegrationQueueId field is an integer data type in the IntegrationQueueJob table that serves as a unique identifier for each integration queue job. This field is used to track and manage the order in which integration tasks are processed within the queue. It allows for efficient organization and execution of integration jobs, ensuring smooth and accurate data integration between systems. The IntegrationQueueId field plays a crucial role in the overall functionality and performance of the IntegrationQueueJob table.

jobId

int32

The JobId field in the IntegrationQueueJob table is a data type of int, or integer, and is used to uniquely identify each job within the integration queue. This field allows for easier tracking and organization of jobs within the queue, ensuring that they are processed accurately and efficiently. The JobId serves as a reference point for other fields and data in the IntegrationQueueJob table, making it a crucial component for the successful execution of integration tasks. This field is used to assign jobs to specific queues and to prioritize and manage the flow of data. Overall, the JobId field plays a key role in the smooth functioning of the integration process.

actionId

int32

The ActionId field in the IntegrationQueueJob table is a primary key that uniquely identifies each record within the table. It is of the data type int, which stands for integer, and is used to store numerical values. This field is essential for maintaining the integrity of the data in the table and for efficient querying and organizing of the records. Each record within the IntegrationQueueJob table must have a unique ActionId, ensuring that no two records can share the same identifier. This makes it an ideal candidate for referencing and joining with other tables in the database.

queueTypeId

string | null

The QueueTypeId field is a string of variable length (nvarchar) that can hold a maximum of 450 characters within the IntegrationQueueJob table. This field is used to identify the type of job or task that is currently in the queue for integration. The data stored in this field allows for efficient sorting and organization of queued jobs, making it an essential component of the integration process. With a high maximum length, this field can accommodate a variety of job types and descriptions, providing flexibility and scalability for the integration process.

scheduledStart

date-time | null

The ScheduledStart field in the IntegrationQueueJob table is a datetime2 data type that records the scheduled start time for a specific job in the queue. This field is used to manage and track the execution of integration tasks, ensuring that they are initiated at the designated time. It provides information on the date and time when a job is expected to begin, allowing for more efficient and timely processing. The datetime2 data type offers a high level of precision and can store a range of values from January 1, 0001 to December 31, 9999. The ScheduledStart field is an essential element of the IntegrationQueueJob table and plays a crucial role in maintaining the smooth operation of scheduled tasks.

started

date-time | null

The Started field is a datetime2 data type that belongs to the IntegrationQueueJob table. This field represents the date and time at which a job in the integration queue was started. It serves as a record of when the integration process began and is useful for tracking and monitoring job progress. Its precision in the datetime2 data type allows for a high level of accuracy in recording start times. This field is crucial for efficient management and organization of data integration tasks within the table.

completed

date-time | null

The Completed field in the IntegrationQueueJob table is of data type datetime2 and is used to record the date and time when a specific job was completed in the integration queue. This field is useful for tracking the progress and timing of tasks within the integration process. It provides a clear and accurate timestamp for when a job was successfully executed, giving stakeholders visibility into the status and efficiency of the integration queue. The Completed field serves as a crucial data point for analysis and reporting, aiding in the identification of bottlenecks or delays in the integration process.

jobStatusId

string | null

The JobStatusId field in the IntegrationQueueJob table is of data type nvarchar with a maximum length of 450 characters. This field is used to store the status of a particular job in the integration queue. It can contain various values such as 'pending,' 'in progress,' 'completed,' or 'failed' to indicate the current status of the job. The JobStatusId field is an essential component for tracking and monitoring the progress of jobs in the integration queue, allowing for efficient management and organization of tasks.

workerId

int32 | null

The WorkerId field in the IntegrationQueueJob table is a numerical data type that represents the unique identifier for each worker responsible for processing job requests. This field serves as a reference point for tracking the progress of a job and the associated worker assigned to it. The data stored in this field allows for efficient and accurate management of job assignments and ensures that tasks are completed by the designated worker. With a range of possible numerical values, the WorkerId field provides a scalable solution for organizing and distributing job tasks in the IntegrationQueueJob table.

actionCaption

string

required

length ≥ 1

The ActionCaption field in the IntegrationQueueJob table is a nvarchar data type that is used to store a descriptive caption for a specific action in an integration job. This field is typically used to provide additional context and information about the action being performed, making it easier to identify and manage the job. It could contain a brief summary of the task, the intended result, or any other relevant details. This field is essential for tracking and organizing integration jobs, and it helps to ensure that tasks are completed accurately and efficiently.

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!