Jump to Content

Docs REST API Reference Release Notes

Docs REST API Reference Release Notes

Overview

API Reference Overview
How to use the API 'Try It' feature

Authentication And Authorization (AAA) Service

Role Management
User Management
Authentication
- Client credentials grant tokenpost
Connection Management
Group Management

Participant Service

Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
- Get core attributes configurations of a participant typeget
- Update core attributes configurations for a participant typeput
Participant Type - State Machine
Participant
Templates
Participant State
- Get the current state of the participant.get
- Transition the current state of the participant.put
Change Log
- Get the participant type change logget
- Get the audit trail of the participant details.get
Participant - Batch Processing

Container Service

Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
- Get core attributes configurations of a container typeget
- Update core attributes configurations for a Container type.put
Container Type - State Machine Config
Container
Container State
New Mock
mock
- mockget
Container Group
Container - Batch Processing

Dispatch Service

Job Type
Job Workflow
Job
Job - Config
- Get attribute config of a job typeget
- Post attribute config for jobput
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
- Get attribute config of dispatchget
- Post attribute config for dispatchput
Ledger
- Apply CustodyIn Scanpost
- Apply CustodyOut Scanpost
Ledger in batch
- Apply CustodyIn Scanpost
- Apply CustodyOut Scanpost
Custom Code Config

Workflow Service

Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
- DB Server Healthget

Workflow Wrapper

Job Workflow
Execution Macro
- Register a macropost
- Get a specific execution macroget
Execution Workflow
Upload Image
- Upload workflow svg to s3 (image/svg+xml)post
Health Check
- Health of the DB Serverget

SDS Service

App
Vault
Data
File
Change Log

File Management Service

Folders
Files
ChangeLog
- Folder Change Logget
- File Change Logget

State Machine Service

State Machine Config
Entity
Events
Reasons
Instance State
Change Log

Entity Service

Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
- Get current state of the entity instanceget
- Apply Event to the entity instanceput
Templates
Change Log
- Get the entity type change logget
- Get the audit trail of the Entity details.get
Entity - Batch Processing

Notification Service

App Notification
Filter
Event
- Push Event to Kafkapost
Change Log
- Get App Change Logget
- Get Filter Change Logget

Location Service

Location
Country

Movement Tracking Service

Trace Data
- GET Trace Dataget
- Update Trace Dataput
Missing Sequence Numbers
- GET Missing Sequence Numbersget
IOT Device
Geofence
MTS Subscription

Order Service

Order Config
Order State Machine Configuration
- update state machine configuration for an orderput
- get state machine configuration for an orderget
Order State Machine Transition
- apply event on the order.put
- apply event on the order.put
Work Order State Machine Configuration
- update state machine configuration for a work-orderput
- get state machine configuration for a work-orderget
Work Order State Transition
- Transition the current state of a work-orderput
- Transition the current state of a work-order using client-detailsput
Order
Batch Order
- Create orders in batchpost
Custom Code Config
Plugin Callback
- plugin callbackpost
External Reference APIs
Work Order Config
Work Order Status
- update work order statusput
Plugins
PluginWorkflow

Address Service

Address Config
Address

User framework app

User FPA API

Facility API

Facility FPA API
Property API

Vehicle FPA

Vehicle FPA API

LogisticsOrder API

Order
Batch Order
- Create orders in batchpost

External Authorizer

Authorization
- Validate the input token.post
- Authorizes the input request.post

Orchestrator

Plugins
PluginWorkflow
Rules
Get Entity Status

Powered by

Overview

API Reference Overview
How to use the API 'Try It' feature

Authentication And Authorization (AAA) Service

Role Management
User Management
Authentication
- Client credentials grant tokenpost
Connection Management
Group Management

Participant Service

Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
- Get core attributes configurations of a participant typeget
- Update core attributes configurations for a participant typeput
Participant Type - State Machine
Participant
Templates
Participant State
- Get the current state of the participant.get
- Transition the current state of the participant.put
Change Log
- Get the participant type change logget
- Get the audit trail of the participant details.get
Participant - Batch Processing

Container Service

Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
- Get core attributes configurations of a container typeget
- Update core attributes configurations for a Container type.put
Container Type - State Machine Config
Container
Container State
New Mock
mock
- mockget
Container Group
Container - Batch Processing

Dispatch Service

Job Type
Job Workflow
Job
Job - Config
- Get attribute config of a job typeget
- Post attribute config for jobput
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
- Get attribute config of dispatchget
- Post attribute config for dispatchput
Ledger
- Apply CustodyIn Scanpost
- Apply CustodyOut Scanpost
Ledger in batch
- Apply CustodyIn Scanpost
- Apply CustodyOut Scanpost
Custom Code Config

Workflow Service

Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
- DB Server Healthget

Workflow Wrapper

Job Workflow
Execution Macro
- Register a macropost
- Get a specific execution macroget
Execution Workflow
Upload Image
- Upload workflow svg to s3 (image/svg+xml)post
Health Check
- Health of the DB Serverget

SDS Service

App
Vault
Data
File
Change Log

File Management Service

Folders
Files
ChangeLog
- Folder Change Logget
- File Change Logget

State Machine Service

State Machine Config
Entity
Events
Reasons
Instance State
Change Log

Entity Service

Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
- Get current state of the entity instanceget
- Apply Event to the entity instanceput
Templates
Change Log
- Get the entity type change logget
- Get the audit trail of the Entity details.get
Entity - Batch Processing

Notification Service

App Notification
Filter
Event
- Push Event to Kafkapost
Change Log
- Get App Change Logget
- Get Filter Change Logget

Location Service

Location
Country

Movement Tracking Service

Trace Data
- GET Trace Dataget
- Update Trace Dataput
Missing Sequence Numbers
- GET Missing Sequence Numbersget
IOT Device
Geofence
MTS Subscription

Order Service

Order Config
Order State Machine Configuration
- update state machine configuration for an orderput
- get state machine configuration for an orderget
Order State Machine Transition
- apply event on the order.put
- apply event on the order.put
Work Order State Machine Configuration
- update state machine configuration for a work-orderput
- get state machine configuration for a work-orderget
Work Order State Transition
- Transition the current state of a work-orderput
- Transition the current state of a work-order using client-detailsput
Order
Batch Order
- Create orders in batchpost
Custom Code Config
Plugin Callback
- plugin callbackpost
External Reference APIs
Work Order Config
Work Order Status
- update work order statusput
Plugins
PluginWorkflow

Address Service

Address Config
Address

User framework app

User FPA API

Facility API

Facility FPA API
Property API

Vehicle FPA

Vehicle FPA API

LogisticsOrder API

Order
Batch Order
- Create orders in batchpost

External Authorizer

Authorization
- Validate the input token.post
- Authorizes the input request.post

Orchestrator

Plugins
PluginWorkflow
Rules
Get Entity Status

Powered by

Participant

Use this API to create, update, and retrieve Participants.

📘
If you are creating your first Participant, do check out this link for guidance.