GraphQl Schemas
GraphQL: Dispatch Queries
jobsByReferenceV2
3min
The jobsByReferenceV2 GraphQL schema represents a query for retrieving job information based on a reference value. This query includes various arguments, fields, and objects. Let's define them in a tech writing style:
- jobRef (String): The reference value used to filter jobs. Provide a specific job reference for accurate results.
- tenant (String): The identifier for the tenant associated with the jobs. Use the appropriate tenant ID to retrieve jobs specific to that tenant.
- page (Int): The page number of the results. Specify the desired page number to retrieve a specific set of jobs.
- size (Int): The number of jobs to be included per page. Specify the desired size to control the number of jobs in each page.
- sort (String): The sorting criteria for the jobs. Specify the field name to sort the jobs accordingly. For example, "createdAt" to sort by creation date.
- filter (String): Additional filters to narrow down the job search. Use a filter expression to specify custom criteria.
- data (Object): The container object for the retrieved job data.
- assets (Object[]): An array of asset objects associated with the job.
- description (String): The description of the asset.
- documentType (String): The type of document associated with the asset.
- documentUrl (String): The URL pointing to the location of the document.
- assignedAt (DateTime): The timestamp indicating when the job was assigned.
- batchId (String): The identifier of the batch to which the job belongs.
- cancelled (Boolean): A flag indicating whether the job has been canceled or not.
- completedAt (DateTime): The timestamp indicating when the job was completed.
- containers (Int): The number of containers associated with the job.
- createdAt (DateTime): The timestamp indicating when the job was created.
- createdBy (String): The identifier of the user who created the job.
- customData (String): Additional custom data associated with the job.
- dispatchRef (String): The reference value associated with the dispatch of the job.
- id (String): The unique identifier of the job.
- jobRef (String): The reference value of the job.
- jobTypeId (String): The identifier of the job type.
- jobTypeName (String): The name of the job type.
- objectives (Object[]): An array of objective objects associated with the job.
- contact (String): The contact information related to the objective.
- groupId (String): The identifier of the group associated with the objective.
- location (Object): The location information related to the objective.
- address (String): The address of the location.
- createdAt (DateTime): The timestamp indicating when the location was created.
- createdBy (String): The identifier of the user who created the location.
- description (String): The description of the location.
- geolocation (String): The geolocation coordinates of the location.
- locationId (String): The identifier of the location.
- similarityId (String): The identifier indicating similarity between locations.
- tags (String[]): An array of tags associated with the location.
- tenantId (String): The identifier of the tenant associated with the location.
- updatedAt (DateTime): The timestamp indicating when the location was last updated.
- updatedBy (String): The identifier of the user who last updated the location.
- next (Object): The next objective related to the current objective.
- code (String): The code associated with the next objective.
- nextObjective (String): The description of the next objective.
- reason (String): The reason for the next objective.
- objectiveRef (String): The reference value of the objective.
- status (String): The status of the objective.
- timeSlot (Object): The time slot information related to the objective.
- from (DateTime): The start time of the time slot.
- to (DateTime): The end time of the time slot.
- workflowInstance (Object): The workflow instance associated with the objective.
- attemptId (String): The identifier of the workflow attempt.
- createdAt (DateTime): The timestamp indicating when the workflow instance was created.
- createdBy (String): The identifier of the user who created the workflow instance.
- dispatchId (String): The identifier of the dispatch associated with the workflow instance.
- id (String): The unique identifier of the workflow instance.
- inputs (String): The input data associated with the workflow instance.
- jobId (String): The identifier of the job associated with the workflow instance.
- lastState (String): The last state of the workflow instance.
- latestSequenceId (String): The identifier of the latest sequence in the workflow instance.
- status (String): The status of the workflow instance.
- tenantId (String): The identifier of the tenant associated with the workflow instance.
- updatedAt (DateTime): The timestamp indicating when the workflow instance was last updated.
- updatedBy (String): The identifier of the user who last updated the workflow instance
- workflow (String): The workflow associated with the workflow instance.
- parentJobId (String): The identifier of the parent job, if applicable.
- scheduledFor (Object): The scheduled time frame for the job.
- endDateTime (DateTime): The end time of the scheduled period.
- startDateTime (DateTime): The start time of the scheduled period.
- start (Boolean): A flag indicating whether the job has started or not.
- status (String): The status of the job.
- subStatus (String): The sub-status of the job.
- tenantId (String): The identifier of the tenant associated with the job.
- updatedAt (DateTime): The timestamp indicating when the job was last updated.
- updatedBy (String): The identifier of the user who last updated the job.
- pagination (Object): The pagination information for the query results.
- currPage (Int): The current page number.
- hasNextPage (Boolean): A flag indicating whether there is a next page available or not.
- nextPage (Int): The page number of the next page, if available.
- pageSize (Int): The number of jobs per page.
- prevPage (Int): The page number of the previous page, if available.
- totalCount (Int): The total count of jobs matching the query.

Updated 03 Aug 2023
Did this page help you?