The workflowInstanceList is a GraphQL API schema that retrieves and paginates through a list of workflow instances.
The tenant string specifies the client's information for identification purposes.
This is a string used to filter out data that meets certain criteria.
This integer specifies the current page in the paginated list.
This integer determines the number of items per page.
This string is used to specify the sorting order of the items.
The workflowInstanceList returns a data object that includes the following fields:
Unique identifier for the specific attempt to execute the workflow instance.
Timestamp of when the workflow instance was created.
User who created the workflow instance.
Unique identifier for the dispatch job related to the workflow instance.
Unique identifier for the workflow instance.
Defines the input parameters that were used for this instance of the workflow.
Unique identifier for the job related to the workflow instance.
The last recorded state of the workflow instance.
Identifier for the most recent sequence within the workflow instance.
The current status of the workflow instance.
Identifier for the tenant that the workflow instance belongs to.
Timestamp of when the workflow instance was last updated.
User who last updated the workflow instance.
Detailed workflow object that the instance was created from.
- pagination: A nested object that contains details for navigating the paginated list.
The current page number in the paginated list.
A boolean indicating whether there is a next page.
The number of the next page, if it exists.
The number of items per page.
The number of the previous page, if it exists.
The total count of items in the list.
In addition to retrieving the WorkflowInstanceList data object, developers will also receive the workflowDetails. The attributes such as createdAt, createdBy, id, inputs, status, tenantId, updatedAt, and updatedBy remain consistent for the workflowDetails. The remaining data objects are defined below:
A boolean indicating if the workflow can be merged.
Specifies the conditions for the workflow's execution.
Descriptive text providing more details about the workflow.
Contains the sequence of steps and paths in the workflow.
The JSON schema represents the structure of the workflow.
Contains additional metadata associated with the workflow.
The name of the workflow.