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: Workflow Queries

workflowDraftList

5min

Overview

The workflowDraftList is a GraphQL API schema that allows you to retrieve and paginate through a list of workflow drafts.

Arguments

Argument

Description

tenant

The tenant string specifies the client's information for identification purposes.

filter

This is a string used to filter out data that meets certain criteria.

page

This integer specifies the current page in the paginated list.

size

This integer determines the number of items per page.

sort

This string is used to specify the sorting order of the items.

Data Object Fields

The workflowDraftList returns a data object that includes the following fields:

Field

Description

canMerge

Indicates if the workflow draft can be merged with others.

createdAt

Timestamp of when the workflow draft was created.

createdBy

User who created the workflow draft.

description

Descriptive text providing more details about the workflow draft.

expire

The date/time when the workflow draft is set to expire.

id

Unique identifier for the workflow draft.

meta

Contains additional metadata associated with the workflow draft.

name

The name of the workflow draft.

tenantId

Identifier for the tenant that the workflow draft belongs to.

updatedAt

Timestamp of when the workflow draft was last updated.

updatedBy

User who last updated the workflow draft.

Nested Object:

  • pagination: A nested object that contains details for navigating the paginated list.

Pagination Fields

Field

Description

currPage

The current page number in the paginated list.

hasNextPage

A boolean indicating whether there is a next page.

nextPage

The number of the next page, if it exists.

pageSize

The number of items per page.

prevPage

The number of the previous page, if it exists.

totalCount

The total count of items in the list.



Updated 03 Aug 2023
Did this page help you?
PREVIOUS
workflowDraft
NEXT
workflowInstance
Docs powered by Archbee
TABLE OF CONTENTS
Overview
Arguments
Data Object Fields
Nested Object:
Pagination Fields
Docs powered by Archbee