Welcome 👋 to the Platform API Documentation that defines the use of each REST API endpoint in the sandbox environment.

 for more information about the various services that the Platform offers.

This Platform API Documentation for the sandbox environment offers comprehensive information on various API endpoints and services provided by the Platform. Discover a wide range of functionalities including authentication, participants, containers, dispa

API Reference Overview

clientID

API Documentation

OS1 APIs

How to use the API 'Try It' feature

Overview

Ping

Health Check

Health

Register an Application

Get Application By Listing ID

Update Application Properties

Delete Application Version

Get Application By App Version ID

Get compatible solutions for application

Add a compatible solution to an application

Remove compatible solutions from an application

Get application by application ID.

Get Application Production Credentials

Update the lifecycle of an application version.

Add a new version to an application

Application

Get Solution By Solution ID

Get Solution By Version ID

Update solution

Delete Solution Version

Get Solution By Listing ID

Register Solution

Add a new version to a solution

Delete List of Applications from Solution

Add/Update List of Applications In Solution

Update the lifecycle state of a solution

Solution

Uploads an artifact for an app or a soln.

Gets the artifacts for an app or a soln.

Download the artifact for an app/soln version given artifact Id

Deletes the artifacts for an app or a soln.

Onboard Item to Tenants without init sequence

Get Organization and Team List for User.

Onboard Item to Tenant

Get Onboarding activity based on either tenantId, itemId or the versionId

Get all applications for a given organization.

Get all solutions for a given organization.

Get logs by listing id

Get diff between versions of an app or a solution

Get permissions difference by version id and tenant id

Get versions diff or permissions diff

Get all tenants for a given stack

Common

Get access token based on username and password

Authentication

Register a Banner

Get active banners of the current day

Update Banner properties

Delete a banner by its Id.

Get a banner by its Id

Banner

Download OpenAPI file

Apps And Solns

Create App Role

Get all Roles

Update a Role

Get specific role information.

Role Management

Create User

Get all Users.  Deprecated. It will reach EOL on Sept 30, 2023.

Update User

Get User

Get User Roles

Get Apps assigned to User

Block a User

Active a User by id

Unblock a blocked User. This API is deprecated. Use unblock user by userId

Get the user info from access token

Update (Add/remove) groups of the users

User Management

Otp generate request to Grant Token using otp mode of authentication

Otp verification to get the userId associated with that api.

Client credentials grant token

Get all Connections

Create a Social Connection

Get Social Connection

Update Social Connection

Create SAML Connection

Get SAML Connection

Update SAML Connection

Create OIDC client

Update OIDC client

Get OIDC connection

Connection Management

Create Group

Get all Group

Update Group

Get Groups

Update users mapping for a Group. Please note that requests that exceed the 375KB size limit will be rejected. Avoid passing large payloads to prevent exceeding this limit.

Get all users in a Group

Update Roles mapping for a Group

Group Management

Authentication And Authorization (AAA) Service

Create Folder

Get all Folders

Get Folder

Update Folder

Folders

Upload File

Search File

Generates File ID

Get File

Update File

Get File Status

Files

File Management Service

Register Application

Get App Details

Update App Public Key

Create Vault

Get Vault

Update Vault

Vault

Create Data

Get Data

Update Data

Get secure data

Delete secure data

Data

SDS Service

Introduction

Send messages

Send Notifications

/two-way/messages

Messages

Get configs of all provider types

Get provider type

Create Service Provider Configs

Get all providers

Get specific provider instance by name

Modify specific service provider instance

Service Provider Management

Create templates

Get ALL templates

Get Template with template name

Update template with template name

Update default external ref

Templates Management

Get the statistics for messages sent

Metering

Register tenant config

Update tenant config

Get tenant config

Tenant Config Management

create notification

Get all notifications.

update notification's templates

Get notifications details

update notification accces modes

Notification Management

Messaging Service

Register new app

Get all registered apps

Get app registration detail

Update app registration detail

Add app notification configuration

Get App Notification Config

Update App Notification Config

App Notification

Push Event to Kafka

Event

Notification

Notification Service

Create a new job type

Get configuration of job types

Get configuration of a job type

update a job type

Job Type

Create a new job workflow draft

Create a new job workflow

Get job workflow by job workflow id

Update job workflow status

Job Workflow

Create a new job

Update job by job ref

Get job by job id

Update job by id

Update some values of custom data for a job

Change status and subStatus of a job

Change sub status of a job

Change sub status of jobs

cancel the job

Get attribute config of a job type

Post attribute config for job

Job - Config

Create a new dispatch type

Get configuration of dispatch types

Get configuration of a dispatch type

Dispatch Type

Create a new dispatch

Update all the values of custom data for a dispatch

Update some values of custom data for a dispatch

Dispatch

Dispatch Service

Service	API Reference
App	Link
Solution	Link
Common	Link

Service Name	API Reference
Authentication and Authorization	Link
File Management	Link
Secure Data Storage	Link
Dispatch	Link
Orchestrator	Link
Workflow	Link
State Machine	Link
Notification	Link
Location	Link
Motion Tracking System	Link
Platform Order Management	Link

Service Name	Description	API Reference
Participant	Onboard different types of Participants like Vehicle, Facility, User, Device, etc	Link
Entity	Store the data and perform operations on the data for an Entity.	Link
Container	Create and manage containers such as Package and Box.	Link

Service Name	Reference
LogiticsOrder API	Link
User API	Link
Facility API	Link
Vehicle API	Link

API Reference Overview

App & Solution

Foundational

Data Domain

Dispatch One