Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Introduction
Overview
Getting started with the OS1 Platform
Getting started with building Apps
Concepts
Working with Callbacks
Console UI Overview
Custom Code
Working with GraphQL
Custom Attributes Ownership
Attribute-Based Access Control (ABAC)
Data Listing and Query (DLQS) Search
Core API dev guides
Overview
Authentication And Authorization
Participant
Container
Dispatch
Orchestrator
Workflow
Secure Data Storage
File Management
State Machine
Entity
Notification
Motion Tracking System
Location
Platform Order Management
Address
Scheduler
Logistics Framework API Dev guides
Overview
LogisticsOrder API
User API
Facility API
Vehicle API
How-To Guides
Integrate Your Application with Console UI
Integrate with Participants
Integrate with Containers
Integrate with Users
Integrate with Vehicles
Integrate with Facilities
Integrate with Entities
Integrate with Dispatch
Integrate with Logistics Order
Integrate with Platform Order Management
Integrate with Location Service
Integrate with Orchestrator
GraphQl Schemas
GraphQL: Dispatch Queries
GraphQL: Order Queries
GraphQL: Workflow Queries
GraphQL: Container Queries
Platform SDKs
SDK Overview
Sample Apps
Vehicle Management App
Container App
Resources
FAQs
Glossary
Data Types Used in OS1
Development Guidelines
Entity, Event, and Reason Codes
Service/API Level Error Codes
Docs powered by Archbee
GraphQl Schemas
GraphQL: Dispatch Queries

jobIdsListV2

6min

Overview

The jobIdsListV2 API is a GraphQL query that returns a list of job IDs associated with specified container IDs. The API also provides pagination functionality.

Schema

The jobIdsListV2 is defined with the following arguments and fields:

Arguments:

  • containerIds (String, Required): A comma-separated string of container IDs for which job IDs are to be returned.
  • tenant (String, Required): The tenant context in which the operation is performed.
  • page (Integer, Optional): The page number from which to start the query.

Objects

data

This is the main response object of the query.

  • containerId (String): The container ID for the returned job.
  • jobId (String): The job ID associated with the returned container.

pagination

This is the pagination object in the response, allowing for easy navigation through large lists of jobs.

  • currPage (Integer): The current page of the data set.
  • hasNextPage (Boolean): A flag indicating whether there are more pages of data to load.
  • nextPage (Integer): The number of the next page in the data set, if it exists.
  • pageSize (Integer): The number of entries per page.
  • prevPage (Integer): The number of the previous page in the data set, if it exists.
  • totalCount (Integer): The total number of entries in the data set.


Example Request:

Text
{
  jobIdsListV2(containerIds: "1,2,3", tenant: "tenant1", page: 1) {
    data {
      containerId
      jobId
    }
    pagination {
      currPage
      hasNextPage
      nextPage
      pageSize
      prevPage
      totalCount
    }
  }
}




Updated 03 Aug 2023
Did this page help you?
PREVIOUS
JobListV2
NEXT
jobsByReferenceV2
Docs powered by Archbee
TABLE OF CONTENTS
Overview
Schema
Arguments:
Objects
data
pagination
Example Request:
Docs powered by Archbee