GraphQl Schemas
GraphQL: Dispatch Queries
jobWorkflowListV2
2min
The jobWorkflowListV2 GraphQL schema defines a query for retrieving a list of job workflows. The schema accepts the following parameters:
- aggregations (String): This parameter specifies the type of aggregations to be performed on the job workflow list.
- tenant (String, Required): This parameter is used to identify the tenant or the specific subset of data for which the job workflows list should be aggregated.
- filter (String): This parameter allows for filtering the job workflow lists based on certain criteria or conditions.
- The data field contains an array of job workflows with the following object and field definitions:
- createdAt: A field representing the date and time when the job workflow was created.
- createdBy: A field indicating the user or entity responsible for creating the job workflow.
- description: A field providing a description or summary of the job workflow.
- id: A unique identifier for the job workflow.
- jobWorkflowStatus: A field indicating the status of the job workflow.
- name: A field representing the name or title of the job workflow.
- objectives: An object containing information about the objectives associated with the job workflow. It consists of the following fields:
- next: An object representing the next objective in the workflow, with the following fields:
- code: A field indicating the code or identifier of the next objective.
- nextObjective: A field specifying the name or title of the next objective.
- reason: A field providing a reason or explanation for the next objective.
- objectiveRef: A field referring to a specific objective within the workflow.
- workflow: A field indicating the workflow associated with the objectives.
- start: A field representing the start date and time of the job workflow.
- tag: An object representing a tag associated with the job workflow, with the following fields:
- name: A field indicating the name or label of the tag.
- value: A field specifying the value or content of the tag.
- tenantId: A field representing the identifier of the tenant or organization associated with the job workflow.
- updatedAt: A field indicating the date and time when the job workflow was last updated.
- updatedBy: A field indicating the user or entity responsible for the most recent update to the job workflow.
- The pagination field provides information about the pagination of the results and includes the following fields:
- currPage: A field indicating the current page number of the returned results.
- hasNextPage: A boolean field indicating whether there is a next page of results available.
- nextPage: A field specifying the page number of the next page, if it exists.
- pageSize: A field indicating the number of items per page in the result set.
- prevPage: A field specifying the page number of the previous page, if it exists.
- totalCount: A field indicating the total number of job workflows in the result set.

Updated 03 Aug 2023
Did this page help you?