API Reference
Developer Account Setup
Get API Base URL
Base URL Format
https://{{ENVIRONMENT}}-api.parkoursc.com/external-api
Contact an admin user to provision a user account for you. Every user is created with a valid email address and a user ID.
Once your account has been created, you will receive an email asking you to verify your email address and set your account password.
Log in to the ParkourSC desktop application with your user ID and password.
Click the logo in the top right of the page and then select
account settings. You will be taken to your user profile page.Below your personal details, you will see a section that says
External API referencefollowed by a URL.This URL is the
base URLfor any REST APIs that you call with this user.
Authenticate API Calls
Login with cURL and store response in variable
POST {{Base URL}}/api/2/token
{
"login": "{{userID}}",
"secret": "{{password}}"
}
Required token header for all REST APIs
-H 'token: "{{token}}"'
ParkourSC APIs use token-based authentication that follows the JWT standard.
Once you have obtained your user login credentials, you can use them to log in via API as well. Calling the login API with your userId and password will return a temporary access token along with a UNIX timestamp for the token's time of expiration. This token will vary depending on the user and cluster.
A valid (non-expired) token must be included as a header in all subsequent REST API calls.
Request (JSON)
| Field | Type | Usage |
|---|---|---|
login |
string | User ID |
secret |
string | Password |
Response (JSON)
| Field | Type | Usage |
|---|---|---|
token |
string | JSON Web Token |
expiry |
string | Time in ISO8601 format("expiry": "2023-11-02T08:08:55.155+00:00") |
Entity Types
Every domain entity in the ParkourSC system has an Entity Type. Each Entity Type falls under one of the following Base Categories:
The sections below detail the general format of an Entity Type along with the system-defined Entity Types for each Base Category.
General Format
Entity Type JSON Format
{
"id": "",
"name": "",
"base": "",
"description": ,
"image": "",
"properties": [
{
"id": "",
"name": "",
"displayLabel":"",
"type": "",
"required": true,
"regex": null,
"value": "",
"defaultvalue": null,
"group": "System",
"autoGenerated": false,
"format": null,
"tooltip": null,
"searchable": false,
"filterable": true,
"editable": false,
"entityName": null,
"entityKey": null,
"entityValue": null,
"displayable": true,
"instanceUserEditable": false,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": null,
"apiResponseSelectKey": null,
"apiResponseSelectValue": null,
"order": 1,
"tenantDefault": false
},
{
// property 2
},
{
// property 3
},
...
]
}
Every Entity Type follows the general format described here.
Entity Type Fields
| Field | Type | Usage |
|---|---|---|
id |
String | Internally generated id for Catalog Type |
name |
String | Name of Catalog Type; Used as path parameter in GET calls |
base |
String | Base category of Catalog Type |
description |
String | User friendly description of Catalog Type |
image |
String | URL for image |
properties |
Array | Contains property objects for Catalog Type |
The properties array may contain any number of property objects, each representing a single property of that Catalog Type. If a property has "required": true, then that property must be supplied when creating an Instance of this Catalog Type. Each property object has the following fields:
Property Fields
| Field | Type | Usage |
|---|---|---|
id |
String | |
name |
String | |
displayLabel |
String | |
type |
String | |
required |
Boolean | |
regex |
String | |
value |
String | |
defaultValue |
String | |
group |
String | |
autoGenerated |
Boolean | |
format |
String | |
tooltip |
String | |
searchable |
Boolean | |
filterable |
Boolean | |
editable |
Boolean | |
entityName |
String | |
entityKey |
String | |
entityValue |
String | |
displayable |
Boolean | |
instanceUserEditable |
Boolean | |
instanceUserCreatable |
Boolean | |
apiFlag |
Boolean | |
apiUrl |
String | |
apiResponseSelectKey |
String | |
apiResponseSelectValue |
String | |
order |
Integer | |
tenantDefault |
Boolean |
Use the Catalog APIs to query for Entity Types and determine the required properties for any Entity Type you want to instantiate.
Use the Model APIs to create Instances of an Entity Type.
Asset
Asset (Default)
Asset Entity Type (JSON)
{
"id": "8327b968-a155-4137-ac81-5e669e03efe721",
"name": "Asset",
"base": "Asset",
"description": null,
"image": null,
"properties": [
{
"id" : "80056498-f3e6-4a07-a5de-c65e40679d10",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bca4fa11-b807-4891-afff-5d5f0bb6ec07",
"label" : "externalId",
"displayLabel" : "Asset ID",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "2b68f607-251b-48b0-9ea6-f3dc0dcd5d51",
"label" : "type",
"displayLabel" : "Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "8ddaa314-7316-45c4-b74f-7e7ad52f0dfb",
"label" : "imageURL",
"displayLabel" : "Image URL",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "5229c2ff-70bf-47a7-8101-3a08341e5cbf",
"label" : "monitoredStatus",
"displayLabel" : "Monitored Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"UNMONITORED",
"MONITORED"
],
"defaultvalue" : "UNMONITORED",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "15855940-a3f0-49a0-94ca-dd5efb6352da",
"label" : "status",
"displayLabel" : "Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"DRAFT",
"ACTIVE",
"IN-ACTIVE"
],
"defaultvalue" : "DRAFT",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(6),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "e7430533-415c-4135-ae21-61615a2d2d8b",
"label" : "catalogName",
"displayLabel" : "Catalog Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(7),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e38b1cee-e10e-41fa-9e30-35753ebaa21c",
"label" : "category",
"displayLabel" : "Category",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(8),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "9c4ddccb-292e-4336-96cc-7a48dde5154b",
"label" : "locationId",
"displayLabel" : "Location",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(9),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "896b5492-8cf4-4e68-808f-e234065ca66c",
"label" : "qrBarCode",
"displayLabel" : "QR/Bar Code",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(10),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Custody Asset
Custody Asset Entity Type (JSON)
{
"id": "8b683753-5400-464f-a53a-a9cfc2f3197e",
"name": "CustodyAsset",
"base": "Asset",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/custody+assets.svg",
"properties": [
{
"id" : "3cddd220-a283-4d7a-b019-9059cf4b1443",
"label" : "externalId",
"displayLabel" : "Asset ID",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "885e2a6a-a44e-4ae7-b7d9-a988c616fead",
"label" : "checkedoutBy",
"displayLabel" : "Checked Out By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(11),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "c0602440-44df-4ab8-9d79-9da573c45fb0",
"label" : "checkedoutToUserId",
"displayLabel" : "Checked Out To",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(12),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "10d13a82-14eb-42a1-a273-9d36f0cd01d4",
"label" : "checkedoutTo",
"displayLabel" : "Checked Out To User",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(13),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "461c571a-9ddf-4ce6-812e-de1b13854954",
"label" : "checkedoutAt",
"displayLabel" : "Checked Out At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(14),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "a8364866-5918-4a45-99ef-bddee4be0937",
"label" : "fromParty",
"displayLabel" : "From Party",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(15),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "b615fce6-350f-4f04-8ee9-895ca647d7b3",
"label" : "toParty",
"displayLabel" : "To Party",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/toparty/users?text=<text>",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(16),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "6ec398e2-c1dd-44ea-91b4-b9eecc394ef0",
"label" : "condition",
"displayLabel" : "Condition",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"Good",
"Damaged"
],
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(17),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "278d7552-7e4f-4e1d-9bf1-235d9152f342",
"label" : "custodyStatus",
"displayLabel" : "Custody Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"AVAILABLE",
"IN POSSESSION",
"IN TRANSFER",
"IN SERVICE",
"IN AUDIT",
"UNKNOWN",
"LOST"
],
"defaultvalue" : "AVAILABLE",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(18),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "8f52ddae-4b32-4e10-be95-cc37f482553a",
"label" : "custodyAuditId",
"displayLabel" : "Custody Audit Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(19),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "46ff6bbd-a5f0-41d4-a874-e893bd198899",
"label" : "custodyAuditVersion",
"displayLabel" : "Custody Audit Version",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(20),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "000a0c1e-ff4e-42cf-b76c-271adcd116be",
"label" : "custodyAuditStatus",
"displayLabel" : "Custody Audit Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"Initialized",
"InProgress",
"Completed"
],
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(21),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "e1d776eb-1f9e-4767-a766-67b1d1dbc69c",
"label" : "custodyAuditBy",
"displayLabel" : "Custody Audit By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(22),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "c56e0c10-7933-4e6d-93fa-5a03c7658d77",
"label" : "custodyAuditPending",
"displayLabel" : "Custody Audit Pending",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(23),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "c2e8c83b-d3c4-432c-a263-9d3f3a566638",
"label" : "custodyAuditInitiatedAt",
"displayLabel" : "Custody Audit Initiated At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(24),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "82e60fb3-26e2-4833-b29d-32ad61fd22d9",
"label" : "custodyAuditCompletedAt",
"displayLabel" : "Custody Audit Completed At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(25),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "ebca1bac-6ae1-42a8-9cce-9c7ef3fbbcc9",
"label" : "custodyAuditBegunAt",
"displayLabel" : "Custody Audit Begun At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(26),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "4507c32a-6577-45a6-a9ed-2e0ad9c590c9",
"label" : "lastCustodyAuditId",
"displayLabel" : "Last Custody Audit Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(27),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "e22f7115-e4c5-4379-bbdf-ce6676547b1e",
"label" : "lastCustodyAuditAt",
"displayLabel" : "Last Custody Audit At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(28),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "55c5efe9-a6c7-4161-a9df-74fbfdd464bc",
"label" : "lastCustodyAuditBy",
"displayLabel" : "Last Custody Audit By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(29),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f5d16d0a-5f13-4e6a-b8d0-3cbb9799ed92",
"label" : "lastCustodyStatusUpdateAt",
"displayLabel" : "Last Custody Update At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(30),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "80056498-f3e6-4a07-a5de-c65e40679d10",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bca4fa11-b807-4891-afff-5d5f0bb6ec07",
"label" : "externalId",
"displayLabel" : "Asset ID",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "2b68f607-251b-48b0-9ea6-f3dc0dcd5d51",
"label" : "type",
"displayLabel" : "Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "8ddaa314-7316-45c4-b74f-7e7ad52f0dfb",
"label" : "imageURL",
"displayLabel" : "Image URL",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "5229c2ff-70bf-47a7-8101-3a08341e5cbf",
"label" : "monitoredStatus",
"displayLabel" : "Monitored Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"UNMONITORED",
"MONITORED"
],
"defaultvalue" : "UNMONITORED",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "15855940-a3f0-49a0-94ca-dd5efb6352da",
"label" : "status",
"displayLabel" : "Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"DRAFT",
"ACTIVE",
"IN-ACTIVE"
],
"defaultvalue" : "DRAFT",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(6),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "e7430533-415c-4135-ae21-61615a2d2d8b",
"label" : "catalogName",
"displayLabel" : "Catalog Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(7),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e38b1cee-e10e-41fa-9e30-35753ebaa21c",
"label" : "category",
"displayLabel" : "Category",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(8),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "9c4ddccb-292e-4336-96cc-7a48dde5154b",
"label" : "locationId",
"displayLabel" : "Location",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(9),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "896b5492-8cf4-4e68-808f-e234065ca66c",
"label" : "qrBarCode",
"displayLabel" : "QR/Bar Code",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(10),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Device
Sensor
Sensor Entity Type (JSON)
{
"id": "8f83d319-f09f-47bb-9010-047bd1e2a12d",
"name": "Sensor",
"base": "Device",
"description": null,
"image": null,
"properties": [
{
"id" : "add8be64-0af4-403b-97c7-4b0fb55abddf",
"label" : "sensorId",
"displayLabel" : "Sensor Id",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "e674dd04-c96c-4e41-9dcd-b1f785eaffc2",
"label" : "sensorType",
"displayLabel" : "Sensor Type",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/cloudos/api/1/meta/pTypes?status=enabled&deviceType=sensor",
"apiResponseSelectKey" : "label",
"apiResponseSelectValue" : "label",
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "37e8b4d8-7dae-4073-ad49-6c8ea0df7663",
"label" : "model",
"displayLabel" : "Model",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "7b42532f-7c15-4168-b083-f79a993416f9",
"label" : "sku",
"displayLabel" : "SKU",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "61b0cc6f-5f51-4d15-bcd5-43fd436f3c81",
"label" : "mfgdate",
"displayLabel" : "MFGDate",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(6),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "d61c117e-e92e-43e9-8645-a141a503fdef",
"label" : "update",
"displayLabel" : "Update",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(7),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "46909222-f4b3-47d4-b4ea-70444a109689",
"label" : "version",
"displayLabel" : "Version",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(8),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "62ce3a95-f41e-41d8-bcb4-e6699b41167b",
"label" : "fwrev",
"displayLabel" : "FWRev",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(9),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "5ed0c280-6bb4-4d25-aea2-3919ef5f02ed",
"label" : "hwrev",
"displayLabel" : "HWRev",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(10),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "2cf3db2a-9710-43d9-8ef8-b2b2b505aa44",
"label" : "timestamp",
"displayLabel" : "TimeStamp",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(11),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "18c200df-28b3-41b5-aa24-6dacfd153c10",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Tracker
Tracker Entity Type (JSON)
{
"id": "7062724e-f987-40b1-936c-ac82f67c8a2a",
"name": "Tracker",
"base": "Device",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/tracker2.svg",
"properties": [
{
"id" : "83c8807d-eaf9-41e9-95f8-296f8084309d",
"label" : "sensorId",
"displayLabel" : "Tracker ID",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "3e27a2bf-b1d0-4337-a79f-6046f6e45017",
"label" : "sensorType",
"displayLabel" : "Sensor Type",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/cloudos/api/1/meta/pTypes?status=enabled&deviceType=tracker",
"apiResponseSelectKey" : "label",
"apiResponseSelectValue" : "label",
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "0aa147ef-7946-42ee-949a-8eb13f79a051",
"label" : "accountId",
"displayLabel" : "Account Name",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "1427ec89-5085-42d4-81ef-2d682b380d0d",
"label" : "eventProfileName",
"displayLabel" : "Profile Name",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "84c3a4e2-869f-4fe1-a7a9-0849fb5fd1c2",
"label" : "fwrev",
"displayLabel" : "Tracker version",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : true,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "329ccdc2-0978-43b0-8509-5ed32f261444",
"label" : "model",
"displayLabel" : "Model",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "1e255262-9b05-449d-8527-246a50923aad",
"label" : "sku",
"displayLabel" : "SKU",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "dcc20db1-558d-41b4-83d2-1ae7754fc904",
"label" : "mfgdate",
"displayLabel" : "MFGDate",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "bd95b5ce-634c-42ea-8be6-5677236e296b",
"label" : "update",
"displayLabel" : "Update",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "c7d0a3e3-3cff-4d2b-bb34-e6e5d7568c18",
"label" : "version",
"displayLabel" : "Version",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "bd29c631-463a-42f0-87e1-07284dd75834",
"label" : "hwrev",
"displayLabel" : "HWRev",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "da740abb-15c7-466d-a903-563cf461be3a",
"label" : "timestamp",
"displayLabel" : "TimeStamp",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "add8be64-0af4-403b-97c7-4b0fb55abddf",
"label" : "sensorId",
"displayLabel" : "Sensor Id",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "e674dd04-c96c-4e41-9dcd-b1f785eaffc2",
"label" : "sensorType",
"displayLabel" : "Sensor Type",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/cloudos/api/1/meta/pTypes?status=enabled&deviceType=sensor",
"apiResponseSelectKey" : "label",
"apiResponseSelectValue" : "label",
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "37e8b4d8-7dae-4073-ad49-6c8ea0df7663",
"label" : "model",
"displayLabel" : "Model",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "7b42532f-7c15-4168-b083-f79a993416f9",
"label" : "sku",
"displayLabel" : "SKU",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "61b0cc6f-5f51-4d15-bcd5-43fd436f3c81",
"label" : "mfgdate",
"displayLabel" : "MFGDate",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(6),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "d61c117e-e92e-43e9-8645-a141a503fdef",
"label" : "update",
"displayLabel" : "Update",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(7),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "46909222-f4b3-47d4-b4ea-70444a109689",
"label" : "version",
"displayLabel" : "Version",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(8),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "62ce3a95-f41e-41d8-bcb4-e6699b41167b",
"label" : "fwrev",
"displayLabel" : "FWRev",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(9),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "5ed0c280-6bb4-4d25-aea2-3919ef5f02ed",
"label" : "hwrev",
"displayLabel" : "HWRev",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(10),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "2cf3db2a-9710-43d9-8ef8-b2b2b505aa44",
"label" : "timestamp",
"displayLabel" : "TimeStamp",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(11),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "18c200df-28b3-41b5-aa24-6dacfd153c10",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Gateway
Gateway Entity Type (JSON)
{
"id": "5af980ea-6c78-4e51-adf0-cf3210391308",
"name": "Gateway",
"base": "Device",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/gateway.svg",
"properties": [
{
"id" : "d8562532-962b-4a24-9de6-f67cec98495e",
"label" : "physicalId",
"displayLabel" : "Mac Id",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "3ebfa086-61b1-40fc-ae6c-e615787ad4a3",
"label" : "status",
"displayLabel" : "Status",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"UNPROVISIONED",
"PROVISIONED"
],
"defaultvalue" : "UNPROVISIONED",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "7e72ba01-037a-4c0f-9340-1facd57aa173",
"label" : "type",
"displayLabel" : "Gateway Type",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : [
"Gateway",
"Zone Sensor"
],
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cdb4d944-a8ff-4049-819c-b60d48407cb1",
"label" : "rssiRange",
"displayLabel" : "RSSI Range",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : [
"SHORT (-55)",
"MEDIUM (-70)",
"LARGE (-95)",
"CUSTOM"
],
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "18c200df-28b3-41b5-aa24-6dacfd153c10",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Location
Area
Area Entity Type (JSON)
{
"id": "86c6a7a6-14c8-4d9d-9f95-7157dbd122d7",
"name": "Area",
"base": "Location",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/area.svg",
"properties": [
{
"id" : "dcf9cf53-442c-464b-861c-dd32b19c6387",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "4de0970f-26fb-47fb-9f73-a26b79dbb6fd",
"label" : "externalId",
"displayLabel" : "Area ID",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f951e49b-1316-4ad6-a6de-c6043894729e",
"label" : "address",
"displayLabel" : "Address",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "92f95a32-1b46-4bcb-8bde-fc515d5f0947",
"label" : "size",
"displayLabel" : "Radius(mi)",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(6),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "fcaf75d7-3767-4074-91ee-ea536118ef7c",
"label" : "parentLocation",
"displayLabel" : "Site (Area Placement)",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : "Site",
"entityKey" : "cloudLeafId",
"entityValue" : "assetName",
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "3c2a5551-642c-49f8-a905-25b14a5daa7a",
"label" : "coordinates",
"displayLabel" : "Coordinates",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : false
},
{
"id" : "f88817c3-bb9f-462d-9ca8-9c8e23fe0113",
"label" : "physicalId",
"displayLabel" : "Gateway Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(7),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "6afc1109-6561-4cc2-9345-fa192db56366",
"label" : "areaFenceType",
"displayLabel" : "Area Fence Type",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"circle",
"polygon",
"point"
],
"defaultvalue" : "circle",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f1434662-3ce5-4961-8e2b-5d3dcdbd5ee3",
"label" : "type",
"displayLabel" : "Area Type",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : [
"WorkArea",
"Warehouse",
"Airport",
"Seaport",
"Railway Station"
],
"defaultvalue" : "WorkArea",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "5d8d30a2-4fb3-4f62-b855-3d7a1e38764a",
"label" : "carrierHubCode",
"displayLabel" : "Airport Code",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(8),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bd8ca8ce-70b3-41a9-9fa7-043dafb3c82c",
"label" : "position",
"displayLabel" : "Position (lat,lon)*",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Site
Site Entity Type (JSON)
{
"id": "ca568385-cd97-409b-828f-62b89abea586",
"name": "Site",
"base": "Location",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/Site.svg",
"properties": [
{
"id" : "cab2ac98-92d1-4611-8ee3-e8372900054b",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "b84c93b6-38b9-4b90-8ba4-f1a5ef192755",
"label" : "size",
"displayLabel" : "Radius(mi)",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(11),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "979cb0c5-bd18-4629-a7fe-c32504cc46c6",
"label" : "externalId",
"displayLabel" : "Site ID",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "4303a279-9396-446e-b2b2-fc129cc2c609",
"label" : "areaFenceType",
"displayLabel" : "Geo Fence Type",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : [
"circle",
"polygon",
"point"
],
"defaultvalue" : "circle",
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "61a91da7-2c37-4c56-be5e-1d43899bb7d8",
"label" : "coordinates",
"displayLabel" : "Coordinates",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(10),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "5cd97941-ae4b-4b28-9899-53dd9cc592e8",
"label" : "siteType",
"displayLabel" : "Site Type",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : [
"Service centers",
"Hubs",
"Return Locations",
"Pickups Locations"
],
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "5814f18d-1b30-4070-b857-36b215db36f6",
"label" : "address",
"displayLabel" : "Address",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "67e524fe-8416-48a7-a40f-b3e139fee7a8",
"label" : "city",
"displayLabel" : "City",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(6),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "a9918a5a-151d-47f0-97db-2c18a2285b4f",
"label" : "state",
"displayLabel" : "State",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(7),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "416a3564-f425-4077-991d-7db882dffd08",
"label" : "zip",
"displayLabel" : "Postal Code",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(8),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "3ec9ad2b-189b-4683-b34e-671715ce66e0",
"label" : "country",
"displayLabel" : "Country",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(9),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bd8ca8ce-70b3-41a9-9fa7-043dafb3c82c",
"label" : "position",
"displayLabel" : "Position (lat,lon)*",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Route
Route Entity Type (JSON)
{
"id": "84fa08be-f5d0-4276-b7a6-68fd11e13262",
"name": "Route",
"base": "Location",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/pin_route.svg",
"properties": [
{
"id" : "a79ec5f7-ec8f-47d7-b8b0-8c6659741eb3",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "7f171768-871f-41ef-9d08-c8f719da4034",
"label" : "externalId",
"displayLabel" : "Route ID",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "767492da-4cf8-4b8b-978b-79859674e71c",
"label" : "source",
"displayLabel" : "Source",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/cloudos/api/1/intransit/areas/search",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "be5fe74c-6284-45e6-84ee-531bde68461e",
"label" : "destination",
"displayLabel" : "Destination",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/cloudos/api/1/intransit/areas/search",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "04ed9c73-57e5-44df-a121-408d5f8a71bf",
"label" : "locationDetails",
"displayLabel" : "locationDetails",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Gateway Zone
Gateway Zone Entity Type (JSON)
{
"id": "f7141b81-c23a-4f1b-b2ae-b13799f9c746",
"name": "GatewayZone",
"base": "Location",
"description": null,
"image": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/gateway+zone.svg",
"properties": [
{
"id" : "2f83cd73-8bd5-4597-94f9-24c5eba2b65e",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "3dd3a532-4d6c-4689-a8fb-143df64cec66",
"label" : "parentLocation",
"displayLabel" : "Parent Location",
"type" : "ENUMERATION",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : "Site",
"entityKey" : "cloudLeafId",
"entityValue" : "assetName",
"displayable" : false,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(2),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "161cf3e5-66d5-44ce-80f3-ddcc506fb650",
"label" : "address",
"displayLabel" : "Address",
"type" : "STRING",
"required" : true,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "12e8adda-0798-40b9-942b-d9a648cf911c",
"label" : "position",
"displayLabel" : "position(lat,lon)",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(4),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "1b2f40ba-b17a-47c1-a4ab-d8a7cad35c15",
"label" : "physicalId",
"displayLabel" : "Gateway Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : false,
"editable" : false,
"entityName" : "Gateway",
"entityKey" : "physicalId",
"entityValue" : "physicalId",
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(5),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bd8ca8ce-70b3-41a9-9fa7-043dafb3c82c",
"label" : "position",
"displayLabel" : "Position (lat,lon)*",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "73bbd9bc-9051-11ed-a1eb-0242ac120002",
"label" : "organization",
"displayLabel" : "Organization",
"type" : "ENUMERATION",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : true,
"apiUrl" : "/clfgraphapp/api/graph/org/list",
"apiResponseSelectKey" : "id",
"apiResponseSelectValue" : "name",
"order" : NumberInt(100),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "bdfd091b-2eae-46e7-b378-55dad385c29a",
"label" : "deleted",
"displayLabel" : "Deleted",
"type" : "BOOLEAN",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "e6994ff9-ce99-4c0a-8de6-b370172cd2df",
"label" : "modifiedAt",
"displayLabel" : "Modified At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "87051f3e-df6e-4fef-b8e2-edcd6c4a7c24",
"label" : "modifiedBy",
"displayLabel" : "Modified By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "600dc45b-c08b-4e7a-a672-f2253dfb3883",
"label" : "createdAt",
"displayLabel" : "Created At",
"type" : "DATE",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "184f7d0a-2a4d-4b72-b01c-e4bb9abc5073",
"label" : "createdBy",
"displayLabel" : "Created By",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "85ddedf6-9af6-11ed-a8fc-0242ac120002",
"label" : "entityTypeId",
"displayLabel" : "Catalog Type Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "85ddeb9e-9af6-11ed-a8fc-0242ac120002",
"label" : "parentEntityType",
"displayLabel" : "Parent Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cef93db8-9ad0-11ed-a8fc-0242ac120002",
"label" : "entityTypeKey",
"displayLabel" : "Catalog Type Key",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "cf7a08cb-5f7f-472b-a9eb-516ca864a188",
"label" : "entityType",
"displayLabel" : "Catalog Type",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "df8e9851-922d-4ed6-82f6-34c91cee76bc",
"label" : "baseClass",
"displayLabel" : "baseClass",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "d9923471-400f-446f-bf30-6258fba6d38f",
"label" : "name",
"displayLabel" : "Name",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : false,
"format" : null,
"tooltip" : null,
"searchable" : true,
"filterable" : true,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : true,
"instanceUserEditable" : true,
"instanceUserCreatable" : true,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(3),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : true,
"isDisplayableOnDetails" : true,
"isDisplayableOnCatalog" : true,
"isDisplayableOnList" : true
},
{
"id" : "f9b26272-dd57-4e07-b68d-116551e55896",
"label" : "tenantId",
"displayLabel" : "Tenant Id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : null,
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : false,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
},
{
"id" : "a2da42cc-8703-4e29-8260-918cacaddc29",
"label" : "id",
"displayLabel" : "id",
"type" : "STRING",
"required" : false,
"regex" : null,
"value" : null,
"defaultvalue" : null,
"group" : "System",
"autoGenerated" : true,
"format" : "UUID",
"tooltip" : null,
"searchable" : false,
"filterable" : false,
"editable" : false,
"entityName" : null,
"entityKey" : null,
"entityValue" : null,
"displayable" : false,
"instanceUserEditable" : false,
"instanceUserCreatable" : false,
"apiFlag" : false,
"apiUrl" : null,
"apiResponseSelectKey" : null,
"apiResponseSelectValue" : null,
"order" : NumberInt(-1),
"tenantDefault" : false,
"unique" : true,
"isDisplayableOnSummary" : false,
"isDisplayableOnDetails" : false,
"isDisplayableOnCatalog" : false,
"isDisplayableOnList" : false
}
]
}
Logistics
Standard Shipment
Standard Shipment Entity Type (JSON)
{
"id": "ee474ae1-8d87-4882-99bc-ea3aaf3d3dc6",
"name": "Standard Shipment",
"group": "System",
"type": "shipment",
"superClassId": "597c578d-259b-4886-a1d7-76873845fa49",
"enabled": true,
"show": true,
"classType": "EntityClass",
"graphType": "Node",
"objectType": "standardshipment",
"catalogType": "standardshipment",
"objectClass": "com.cloudleaf.cloudos.graph.core.dto.ClfNode",
"scope": "public",
"tenantDefault": "true",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/standard+s.svg",
"properties": [
{
"id": "26ffef9a-f10e-4d2d-9b18-7cc9fdde94e1",
"name": "status",
"displayLabel": "Shipment Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "Draft,Planned,Pending,Ready to Ship,In-Transit,Exception,At Destination,Completed,InComplete",
"order": 3,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "d07d6459-1c62-41dc-a95b-6c0973acf220",
"name": "subStatus",
"displayLabel": "Shipment Sub-Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"value": "Draft,Planned,Pending,ReadyToShip,InTransit,AtDestination,Completed,Terminated,InCompleted",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 4,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "19cc4803-8ef6-4fc6-ba1c-e76ffacb3c7e",
"name": "orderNum",
"displayLabel": "Order Number",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 5,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "0b83e442-9a96-47e7-a8eb-a3a8c8819052",
"name": "shipperName",
"displayLabel": "Shipper Name",
"type": "String",
"size": "30",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 6,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "117324f0-1523-470b-9ba9-206982fff7f1",
"name": "carrierName",
"displayLabel": "Carrier Name",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 7,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "7d84cac8-b52e-443e-81c3-0f33f82f8e87",
"name": "carrierCode",
"displayLabel": "Carrier Code",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"required": false,
"group": "System",
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 8,
"instanceUserEditable": false,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "e368c65a-b80d-48d2-b4ce-bcaf151384f8",
"name": "custName",
"displayLabel": "Customer Name",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 9,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "793f6b73-864e-480d-83fb-95e4dd73d66a",
"name": "custCode",
"displayLabel": "Customer Code",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 10,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "5a810af1-ef86-410a-b38d-aaf2884f8b6d",
"name": "custOrdRef",
"displayLabel": "Customer Order Reference",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 11,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "da3e09c9-df9d-415f-9a58-bfdb6291d6ad",
"name": "recipientName",
"displayLabel": "Recipient Name",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 12,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "48163313-571e-4cce-a4f0-d352851f76e6",
"name": "directToResidence",
"displayLabel": "Direct to Residence?",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"value": "YES,NO",
"group": "System",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 13,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "1f34940e-d3e7-4747-8ab9-4c2759698e43",
"name": "direction",
"displayLabel": "Direction",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"value": "Inbound,Outbound,Return",
"group": "System",
"required": "true",
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 14,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "6e9d9b97-b4de-4214-95f9-77a958a24316",
"name": "sensorProfile",
"displayLabel": "Sensor Profile",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 16,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "290ce971-474a-421f-b4f1-ae2e0af3586e",
"name": "plannedDeparture",
"displayLabel": "Planned Departure",
"type": "DATE",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 17,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "a296777a-4724-492d-b5bf-46ce8402eb3b",
"name": "plannedArrival",
"displayLabel": "Planned Arrival",
"type": "DATE",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 18,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "b23aff6f-c497-44d7-8c37-38a424473ba2",
"name": "shipmentETA",
"displayLabel": "ETA",
"type": "DATE",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 19,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "060f7186-5ecd-4c73-8567-eef93b487a1d",
"name": "notes",
"displayLabel": "Notes",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 20,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "2768a455-a641-4e1e-a328-f9f37bbc81cf",
"name": "status",
"displayLabel": "Shipment Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "Draft,Planned,Pending,Ready to Ship,In-Transit,Exception,At Destination,Completed,InComplete",
"order": null,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "8e507dbc-c43c-4f84-b111-2aec6e7c2b6d",
"name": "subStatus",
"displayLabel": "Shipment Sub-Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"value": "Draft,Planned,Pending,ReadyToShip,InTransit,AtDestination,Completed,Terminated,InCompleted",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": null,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "e831ae78-e11a-4e10-b586-83f16e757755",
"name": "stage",
"displayLabel": "Stage",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 21,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "a114f5b4-ad6f-4883-92f8-b6abca2d8401",
"name": "modeOfTransport",
"displayLabel": "Mode of Transport",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"value": "Air,Parcel,Multimodal,Ocean/ Marine,Rail,Road,Road-FTL (Full truck load),Road-LTL (Less than truck load)",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 22,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "a2ae1285-d556-47b0-9eae-62a3413263c0",
"name": "permalinkFull",
"displayLabel": "Permalink eURL Full Details",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 23,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "236f1b3e-a321-4fc4-af41-d39f752858e8",
"name": "permalinkLimited",
"displayLabel": "Permalink eURL Limited Details",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 24,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "dee5ccf3-8948-4c84-ac7f-924c08afacae",
"name": "route",
"displayLabel": "Route",
"type": "String",
"size": "200",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"catalogType": "route",
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 25,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "0899827f-0d9b-4c91-a42c-c6b58e230cc3",
"name": "assets",
"displayLabel": "Assets",
"type": "List<String>",
"size": "200",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 26,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "d3b95e11-1d28-4a9d-a744-b4ecb54716ab",
"name": "mawb",
"displayLabel": "MAWB",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 27,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "549714da-5d75-47ed-93de-dbfb10031d70",
"name": "payloadOf",
"displayLabel": "PayloadOf",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 15,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "9b8ad2d4-3093-477e-9e82-09d2bd806098",
"name": "previousShipmentId",
"displayLabel": "Previous ShipmentId",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 15,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "04fe0f22-a725-41f8-a37e-648fe6ca0d16",
"name": "containedTime",
"displayLabel": "Contained Time",
"type": "DATE",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 15,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
}
]
}
Parcel Shipment
Parcel Shipment Entity Type (JSON)
{
"id": "53247309-6e4d-40d1-8c55-c1873fc12350",
"name": "Parcel Shipment",
"group": "System",
"type": "shipment",
"superClassId": "597c578d-259b-4886-a1d7-76873845fa49",
"enabled": true,
"show": true,
"classType": "EntityClass",
"graphType": "Node",
"objectType": "parcelshipment",
"objectClass": "com.cloudleaf.cloudos.graph.core.dto.ClfNode",
"scope": "public",
"catalogType": "parcelshipment",
"tenantDefault": "true",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/parcel+s+2.svg",
"properties": [
{
"id": "f65e4682-4ef9-11ed-bdc3-0242ac120002",
"name": "status",
"displayLabel": "Shipment Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "Draft,Planned,Pending,Ready to Ship,In-Transit,Exception,At Destination,Completed,InComplete",
"order": 3,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "b5d33f64-9053-11ed-a1eb-0242ac120002",
"name": "subStatus",
"displayLabel": "Shipment Sub-Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"value": "Draft,Planned,Pending,ReadyToShip,InTransit,AtDestination,Completed,Terminated,InCompleted",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 4,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "6169b385-9b16-4f21-8bd4-14e662211389",
"name": "orderNum",
"displayLabel": "Order Number",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 5,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "a05dbcbd-67e4-4fe5-be6d-dfd4e43743ca",
"name": "shipperName",
"displayLabel": "Shipper Name",
"type": "String",
"size": "30",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 6,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "0bcda2d6-f175-4235-9d26-0de0a77467a7",
"name": "carrierName",
"displayLabel": "Carrier Name",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 7,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "bef2c9b9-dbb2-41ff-bb45-56d44614059a",
"name": "carrierCode",
"displayLabel": "Carrier Code",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"required": false,
"group": "System",
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 8,
"instanceUserEditable": false,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "3e81dd64-968e-4cfc-8a5e-fafa331c11d4",
"name": "custName",
"displayLabel": "Customer Name",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 9,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "f63d9b00-2500-4598-bec0-e9ee9f72b00f",
"name": "custCode",
"displayLabel": "Customer Code",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 10,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "fbecdcb9-62cc-432e-a404-59c7919a8586",
"name": "custOrdRef",
"displayLabel": "Customer Order Reference",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 11,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "f64d91b2-02ed-4228-b957-770868e2ba7c",
"name": "recipientName",
"displayLabel": "Recipient Name",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 12,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "07ea766b-9dc3-4749-8127-11bc69fe5941",
"name": "directToResidence",
"displayLabel": "Direct to Residence?",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"value": "YES,NO",
"group": "System",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 13,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "a7f5e3b7-7d52-44c3-a85a-b22155ab33ac",
"name": "direction",
"displayLabel": "Direction",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"value": "Inbound,Outbound,Return",
"group": "System",
"required": "true",
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 14,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "49bd86d7-678f-456a-8771-9592a843b2f4",
"name": "sensorProfile",
"displayLabel": "Sensor Profile",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 16,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "3580203e-22e1-40da-8283-18b6ccf1d72b",
"name": "plannedDeparture",
"displayLabel": "Planned Departure",
"type": "DATE",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 17,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "9a8e5061-6e47-40c4-a6e9-114e66455c8a",
"name": "plannedArrival",
"displayLabel": "Planned Arrival",
"type": "DATE",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 18,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "7623572d-bb49-4428-90cb-07674228a99a",
"name": "shipmentETA",
"displayLabel": "ETA",
"type": "DATE",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 19,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "e5fb5d7b-4198-47d1-af89-b8b1c0562da0",
"name": "notes",
"displayLabel": "Notes",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 20,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "0ada9d71-fe47-494e-8118-932aeb0c3cde",
"name": "status",
"displayLabel": "Shipment Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "Draft,Planned,Pending,Ready to Ship,In-Transit,Exception,At Destination,Completed,InComplete",
"order": null,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "6ae1011b-b2b4-49b9-937c-3c436907f11a",
"name": "subStatus",
"displayLabel": "Shipment Sub-Status",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"value": "Draft,Planned,Pending,ReadyToShip,InTransit,AtDestination,Completed,Terminated,InCompleted",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": null,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "120a706e-96c2-4688-85f8-27cc57f1576e",
"name": "stage",
"displayLabel": "Stage",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 21,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "c9b494e9-a8c3-4e44-b9e3-f518e811660b",
"name": "modeOfTransport",
"displayLabel": "Mode of Transport",
"type": "ENUMERATION",
"size": "20",
"unit": "Default",
"defaultValue": "",
"group": "System",
"value": "Air,Parcel,Multimodal,Ocean/ Marine,Rail,Road,Road-FTL (Full truck load),Road-LTL (Less than truck load)",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"order": 22,
"instanceUserEditable": true,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "e107ede6-7eec-48d4-8158-92dae80940c9",
"name": "permalinkFull",
"displayLabel": "Permalink eURL Full Details",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 23,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "650c242a-a486-4a26-a63e-860a512b9e51",
"name": "permalinkLimited",
"displayLabel": "Permalink eURL Limited Details",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 24,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "b8c4169b-e153-47f0-8cc7-10a5cfd66392",
"name": "route",
"displayLabel": "Route",
"type": "String",
"size": "200",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"catalogType": "route",
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 25,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "13734234-3562-4e2a-abd8-e23c0701cc75",
"name": "assets",
"displayLabel": "Assets",
"type": "List<String>",
"size": "200",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": true,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 26,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "defa1f8a-1e59-43fe-a861-1c68c376e4f8",
"name": "trackingNumbers",
"displayLabel": "Tracking Numbers",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 27,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "f18ccbe8-08c7-4cbe-b218-0c3588d52671",
"name": "origin",
"displayLabel": "Origin Area / Address",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 28,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "407f4bd5-9189-4b1e-a621-5a4acfca2a73",
"name": "destination",
"displayLabel": "Destination Area / Address",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 29,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "003180ee-1977-4f8a-b363-31062a7d74b5",
"name": "lastCarrierUpdateAt",
"displayLabel": "Last Carrier Update At",
"type": "DATE",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 30,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "de3b6350-cde4-4850-b1cb-6d67a18fa084",
"name": "latestMilestone",
"displayLabel": "Latest Milestone",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 31,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "41d71f0a-72da-496c-9c76-103e52f42727",
"name": "carrierName",
"displayLabel": "Carrier Name",
"type": "String",
"size": "300",
"group": "System",
"required": false,
"defaultValue": "",
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": true,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": true,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 32,
"instanceUserEditable": true,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "8eaa6dad-d92f-44f6-b3d2-1b4537cd3e68",
"name": "carrierCode",
"displayLabel": "Carrier Code",
"type": "String",
"size": "20",
"unit": "Default",
"defaultValue": "",
"required": true,
"group": "System",
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 33,
"instanceUserEditable": false,
"instanceUserCreatable": true,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "24e7b250-daa4-4592-acbb-89d32b8384e3",
"name": "payloadOf",
"displayLabel": "PayloadOf",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 15,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "220b9b48-6be1-4fd9-a1aa-06a3d4205fe5",
"name": "previousShipmentId",
"displayLabel": "Previous ShipmentId",
"type": "String",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 15,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
},
{
"id": "549e8301-fc46-4562-8015-81094b4efe48",
"name": "containedTime",
"displayLabel": "Contained Time",
"type": "DATE",
"size": "20",
"unit": "Default",
"group": "System",
"defaultValue": "",
"required": false,
"unique": false,
"autoGenerated": false,
"format": "",
"searchable": false,
"displayable": true,
"isDisplayableOnSummary": true,
"isDisplayableOnDetails": true,
"isDisplayableOnCatalog": true,
"isDisplayableOnList": true,
"filterable": false,
"editable": false,
"tooltip": "",
"regex": null,
"value": "",
"order": 15,
"instanceUserEditable": false,
"instanceUserCreatable": false,
"apiFlag": false,
"apiUrl": "",
"apiResponseSelectKey": "",
"apiResponseSelectValue": ""
}
]
}
Catalog
The Catalog APIs below are used to query for the Entity Types that exist in your ParkourSC tenancy.
Get All Entity Types
Get All Entity Types
GET $baseURL/api/2/types
Call this API to retrieve a list of all the existing Entity Types in the Catalog. You will see the system-generated Entity Types along with any user-created Custom Asset Types.
Get Single Entity Type
Get Single Entity Type
GET $baseURL/api/2/types/{{entityTypeKey}}
Call this API to retrieve a single Entity Type by entering its name in the URI path.
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{{entityTypeKey}} |
String | The type of the Entity to retrieve. See Entity Types |
Response Format
Example Entity Type from GET query
{
"id": "C4zrA8jk3obbYcuF7",
"name": "Sensor",
"base": "Device",
"description": null,
"image": null,
"properties": [
{
"id" : "80056498-f3e6-4a07-a5de-c65e40679d10",
"name": "sensorId",
"displayLabel": "Sensor Id",
"type": "STRING",
"required": true,
"regex": null,
"defaultvalue": null,
"group": "System"
},
{
"id" : "bca4fa11-b807-4891-afff-5d5f0bb6ec07",
"name": "sensorType",
"displayLabel": "Sensor Type",
"type": "ENUMERATION",
"required": true,
"regex": null,
"defaultvalue": null,
"group": "System"
}
]
}
Every Entity Type returned by a GET query will follow the general format described here.
| Field | Type | Usage |
|---|---|---|
id |
String | Internally generated id for Entity Type |
name |
String | Name of Entity Type; Used as path parameter in GET calls |
base |
String | Base category of Entity Type |
description |
String | User friendly description of Entity Type |
image |
String | URL for image |
properties |
Array | Contains property objects for Entity Type |
The "properties" array may contain any number of JSON objects, each representing a single property of that Entity Type. If a property has "required": true, then that property must be supplied when creating an Instance of this Entity Type.
Use the GET APIs above to determine the required properties for any Entity Type you want to instantiate.
The example shows that Catalog Type Sensor requires properties sensorId and sensorType. When you create an Instance of Sensor, you will need to provide these properties. See Model for further details on Instance Creation
Digital Twin
The Digital Twin APIs below are used to create Instances of any Entity Type in the Catalog.
Get Instances
Get All Instances of Type
Get All Instances of Type
GET $baseURL/api/2/types/{{entityTypeKey}}/objects
Call this API to retrieve all Instances of a given Entity Type.
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{{entityTypeKey}} |
Path | The object type of the Entity. The API will return all instances of this Type. |
Get Instance by ID
Get Instance by ID
GET $baseURL/api/2/types/{{entityTypeKey}}/objects/{{InstanceId}}
Call this API to retrieve a specific Instance of an Entity Type by its UUID.
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{{entityTypeKey}} |
Path | The object type of the Entity for the Instance you are retrieving. |
{{InstanceId}} |
Path | The internally generated UUID of the Instance. Use the value of id that was returned after the Instance was created. |
Create Instance
Create Instance
POST $baseURL/api/2/types/{entityTypeKey}/objects
[
{
"name": "<set Instance name here>",
"description": "<user friendly description>",
"image": "<image url>",
"properties": [
{
"id": "<property name>"
"value": "<property value>"
}
]
}
]
Call this API to create an Instance of an existing Entity Type. The name of the Entity Type you are instantiating is specified in the URI path.
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{entityTypeKey} |
Path | One of the Entity Types |
Payload Format
| Field | Type | Usage |
|---|---|---|
name |
String | Name of Instance |
description |
String | User friendly description of Instance |
image |
String | URL for image |
properties |
Array | Contains property objects for Instance |
In the properties array you must provide values for any required properties for this Entity Type, along with values for optional properties as desired.
See Entity Types for the required properties of any given type.
Response id
Upon successful creation, the response to this API will contain the Instance you just created, along with a single id field. This id is an internally generated UUID for the Instance that is used in Get, Update, and Delete requests.
Update Instance
Update Instance
PUT $baseURL/api/2/types/{entityTypeKey}/objects
{
"id": "<Instance ID>",
"description": "<optional>",
"image": "<optional>",
"type": "<EntityType>",
"properties": [
{
"id": "<property name>"
"value": "<property value>"
}
]
}
Call this API to update the description, image, or properties of an Instance. Only the values that are being updated need to be submitted in the payload.
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{entityTypeKey} |
Path | One of the Entity Types |
Payload Format
| Field | Type | Usage |
|---|---|---|
id |
String | Instance id returned after creation |
type |
String | The Entity Type of the instance |
description |
String | User friendly description of Instance; optional |
image |
String | URL for image; optional |
properties |
Array | Contains property objects for Instance |
Delete Instance
Delete Instance
DELETE $baseURL/api/2/types/{{entityTypeKey}}/objects/{{InstanceId}}
Call this API to delete a specific Instance of an Entity Type by its UUID
Organizations
This section covers the CRUD APIs for Organization entities.
Once an Organization entity has been created, any Instance can be assigned to that Organization. Every Entity Type has an organization property that may be specified while creating or updating the Instance. The Organization's UUID should be passed as the value of this property.
Get Organizations
Get All Organizations ASYNC
Get All Organizations
GET $baseURL/api/2/organization/list
Response Format
[
{
"name": "Org Name 1",
"id": "0afebe81-b69d-4fd1-a55d-72ed83f8c561"
},
{
"name": "Org Name 2",
"id": "1b221bc8-42cd-4cf4-89af-910d4592d62a"
},
{
"name": "Org Name 3",
"id": "3f4c820e-4b13-404b-92b2-96a96396688d"
},
{
"name": "Org Name 4",
"id": "f69bf8ff-de69-4c35-ac17-a850ee9422e0"
}
]
Call this API to get a list of all organizations available to the user. Each organization object in the list contains a user-specified name and a UUID that was generated upon creation.
Get Organization by ID
Get Organization by ID
GET $baseURL/api/2/organization/{{OrganizationId}}
Response Format
{
"type": "organization",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "{{OrganizationId}}",
"baseType": "organization",
"properties": {
"createdAt": "1666070007751",
"createdBy": "{username}",
"modifiedAt": "1666070007751",
"clfMappingType": "organization",
"name": "Org Name 1",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"modifiedBy": "{username}",
"id": "{{OrganizationId}}",
"classType": "organization"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Call this API to get a single organization by its UUID. The response will contain all metadata for that organization
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{{OrganizationId}} |
Path | The system-generated UUID of the Organization. Use the value of id from the Organization metadata. |
Create Organization
Create Organization
POST $baseURL/api/2/organization
{
"name": "Org Name"
}
Call this API to create a new organization. Pass the organization name in the request payload
Payload Format
| Field | Type | Usage |
|---|---|---|
name |
String | Name of Organization |
Update Organization
Update Organization
PUT $baseURL/api/2/organization/{{OrganizationId}}
{
"name": "UPDATED Org Name"
}
Call this API to update the name of an existing organization
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{{OrganizationId}} |
Path | The system-generated UUID of the Organization. Use the value of id from the Organization metadata. |
Payload Format
| Field | Type | Usage |
|---|---|---|
name |
String | Name of Organization |
Delete Organization
Delete Organization
DELETE $baseURL/api/2/organization/{{OrganizationId}}
Call this API to delete an organization
Path and Query Parameters
| Parameter | Type | Usage |
|---|---|---|
{{OrganizationId}} |
Path | The system-generated UUID of the Organization. Use the value of id from the Organization metadata. |
Tagged Assets
Bind Asset and Sensor
Bind Asset and Sensor
POST $baseURL/api/2/taggedassets
[
{
"assetId": "<externalId>",
"sensorId": "",
"bindflow": <true/false>,
"componentLabel": ""
}
]
POST $baseURL/api/2/taggedassets?assetIdType=id
[
{
"assetId": "<id>",
"sensorId": "",
"bindflow": <true/false>,
"componentLabel": ""
}
]
Call this API to bind an Asset Instance with a Sensor Instance.
Query Parameters
| Field | Type | Usage |
|---|---|---|
assetIdType |
Query | Optional. Set to "id" to use asset UUID in payload |
Payload Format
| Field | Type | Usage |
|---|---|---|
assetId |
String | Default: externalId of the asset; if assetIdType query parameter is set, use id of asset |
sensorId |
String | sensorId of Sensor Instance (set during Instance Creation) |
bindflow |
Boolean | Optional. Set true to enable unbinding; false to disable unbinding |
componentLabel |
String | Optional. User-specified label for this sensor-asset pair |
Unbind Asset and Sensor
Unbind Asset and Sensor
DELETE $baseURL/api/2/taggedassets
[
{
"assetId": "<externalId>",
"sensorId": ""
}
]
DELETE $baseURL/api/2/taggedassets?assetIdType=id
[
{
"assetId": "<id>",
"sensorId": ""
}
]
Call this API to unbind an Asset Instance from a Sensor Instance.
Query Parameters
| Field | Type | Usage |
|---|---|---|
assetIdType |
Query | Optional. Set to "id" to use asset UUID in payload |
Payload Format
| Field | Type | Usage |
|---|---|---|
assetId |
String | Default: externalId of the asset; if assetIdType query parameter is set, use id of asset |
sensorId |
String | sensorId of Sensor Instance (set during Instance Creation) |
Enable/Disable Unbinding
Enable/Disable Unbinding
PATCH $baseURL/api/2/asset/{id}?bindflow={true/false}
Call this API to set the bindflow flag and enable or disable unbinding for a given tagged asset.
Path and Query Parameters
| Field | Type | Usage |
|---|---|---|
id |
Path | UUID of the asset |
bindflow |
Query | Set true to enable unbinding; false to disable unbinding |
Assets Operation
Bind / Unbind Devices to Asset
Bind / Unbind Devices to Assets
PUT $baseURL/api/2/asset/{externalid}/device?entityTypeKey={entityTypeKey}
{
"bindDevice": [
{
"id": "<device_id>",
"entityTypeKey": "<device_entityTypeKey>",
"componentName": "<value>"
}
],
"unbindDevice": [
{
"id": "<device_id>",
"entityTypeKey": "<device_entityTypeKey>"
}
],
"replaceDevice": [
{
"id": "<device_id>",
"entityTypeKey": "<device_entityTypeKey>",
"replacementId": "<device_id>",
"replacementEntityTypeKey": "<device_entityTypeKey>"
}
],
"organization": "<organization_UUID>",
"organizationName": "<organization_name>",
"overrideOrganization": "<true or false>",
"overrideDisableUnbind": "<true or false>", // This flag will cone in RT36.1
"disableUnbind": "<true or false>"
}
- This API binds or Unbind one or more devices to assets.
- There are two types of devices that can be bound to an asset
- Sensors
- Trackers
- If one or more devices cannot be bound to an asset, then a 207 Partial Response or a 400 Invalid Data error will be returned along with the reason.
- If both organization and organizationName are provided then organization takes precedence and organizatioName will be ignored
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
entityTypeKey |
Request | true | Object type of asset |
isExternalId |
Request | true | boolean true or false |
Request Class Model for Bind Devices to Assets
| Attribute | Required | Format | Description |
|---|---|---|---|
| bindDevice | false | Object | Array of sensors/tracker to be bound to asset. Each sensor/tracker is identified by entityTypeKey and externalId for the entity |
| unbindDevice | false | Object | Array of sensors/tracker to be Unbound to asset. Each sensor/tracker is identified by entityTypeKey and externalId for the entity |
| replaceDevice | false | Object | Replace with unbind existing and create new binding . id-> new sensor/ tracker id to be bind, replacementId -> old sensor / tracker id to be replace with id |
| disableUnbind | false | boolean | true: Unbind operation can not be done , false: Unbind operation can be done . This flag will work only with bindDevice and replaceDevice |
| overrideDisableUnbind | false | boolean | true the unbind operation will be performed even if the asset has disable unbind flag set to true (thus overriding this setting). By default, this overrideDisableUnbind flag is assumed to be false |
Response Message for Bind Devices to Assets on Shipments
{
"bindDevice": {
"{{sensor or Tracker id}}": {
"statusMessage": "SUCCESS",
"statusCode": "200"
},
"{{sensor or Tracker id}}": {
"statusMessage": "SUCCESS",
"statusCode": "200"
}
},
"unbindDevice": {
"{{sensor or Tracker id}}": {
"statusMessage": "SUCCESS",
"statusCode": "200"
},
"{{sensor or Tracker id}}": {
"statusMessage": "SUCCESS",
"statusCode": "200"
}
}
}
Response Messages
Following are the possible Response Messages for Bind Devices to Assets on Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that one or more devices have been successfully bound to the asset. |
207 |
Partial Response | Response returns a message indicating that a partial number of devices have been successfully bound. |
400 |
Invalid Data | Response returns an error message along with the reason for on why any devices could not be bound to the asset. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Update organization of Asset
Update Organization of Asset Request
PUT $baseURL/api/2/asset/{externalid}/organization?entityTypeKey={{entityTypeKey}}
{
"organizationName": {{organization Name}},
"organization": {{organization UUID}},
"overrideOrganization": {{true or false}}
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
entityTypeKey |
Request | true | Object type of asset |
isExternalId |
Request | true | boolean true or false |
Request Class Model organization update on Assets
| Attribute | Required | Format | Description |
|---|---|---|---|
| organizationName | true | String | OrganizationName |
| overrideOrganization | false | boolean | This will be true if not provided |
Response Message for update organization of asset
{
"statusCode": "200",
"statusMessage":"SUCCESS"
}
Response Messages
Following are the possible Response Messages for Update organization of asset:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | |
400 |
Invalid Data | Response returns an error message along with the reason |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Entity Search
This section covers the Entity Search API, which you can use to query for entities using text search and filters for specific fields.
Pagination
The Entity Search API returns a paginated list of hits in the response. Depending on the scrollSize you specify in the request payload, the total number of hits may be greater than the number of results returned in the response.
To get the next page of hits for a given query, call the API again (with the same payload), this time populating the field scrollId with the value of _scroll_id from the previous response. Repeat as necessary until the entire paginated list has been traversed.
Every time the Search API is called, the response will contain the scroll ID needed to fetch the next page of results.
Basic Text Search
Example Search Query with text search only
POST $baseURL/api/2/search
{
"scrollId": "",
"scrollSize": <int>,
"queryOperator": "must",
"queryType": "match",
"globalQueryText": "<search text>",
"searchQueries": [
]
}
At a base level, you can search for all entities matching a free-form text query using the globalQueryText field.
Payload Format
| Field | Type | Description |
|---|---|---|
scrollId |
string | Leave empty on first call. Used to get next page of search hits. See Pagination for details |
scrollSize |
integer | The number of results to return per query, i.e., page size. |
queryOperator |
string | "must", "should", "must-not" |
queryType |
string | "match" |
globalQueryText |
string | Free form text search string. Full or partial text-matching |
searchQueries |
array | Specify further filters here to fine-tune your query. For basic text search only, leave as an empty array. |
Search Filters
You can filter search results further by adding filter blocks in the searchQueries field of the payload. Search filters can be used with or without text search. Simply leave globalQueryText blank to search only with filters.
In each filter block you specify a field name/value pair and a query type. Examples of the query types are shown below
Search Filter Format
{
"fieldName": "<field name>",
"queryText": "<field value>",
"queryOperator": "<must, should, must-not>",
"queryType": "<match, range>",
"childFilters": [
]
}
Search Filter Format
| Field | Type | Description |
|---|---|---|
fieldName |
string | The name of the field you are filtering for |
queryText |
string | The value of the field you are filtering for |
queryOperator |
string | "must", "should", "must-not" |
queryType |
string | "match", "range" |
childFilters |
array | Specify additional subfilters for this filter block |
Child Filter Format
{
"fieldName": "status",
"queryText": "MONITORED",
"queryOperator": "must",
"queryType": "match",
}
A filter block can have additional child filters that allow you to build more complex search requests. Child filters follow the same format as regular search filters, but without their own childFilters array.
Match
Example Search Query with Match Filters
POST $baseURL/api/2/search
{
"scrollId": "",
"scrollSize": <int>,
"queryOperator": "must",
"queryType": "match",
"globalQueryText": "<search text>",
"searchQueries": [
{
"fieldName": "type",
"queryText": "Asset",
"queryOperator": "must",
"queryType": "match",
"childFilters": [
{
"fieldName": "monitoredStatus",
"queryText": "MONITORED",
"queryOperator": "must",
"queryType": "match",
}
]
}
]
}
The match query type can be used to filter for entities with the specified value for a given field.
Match Query Format
| Field | Type | Description |
|---|---|---|
fieldName |
string | The name of the field you are filtering for |
queryText |
string | The value of the field you are filtering for |
queryOperator |
string | "must", "should", "must-not" |
queryType |
string | "match" |
In the example to the right, the response will contain all entities of type Asset ("type": "Asset") that have been bound to a Sensor ("monitoredStatus": "MONITORED").
Range
Example Search Query using "range"
POST $baseURL/api/2/search
{
"scrollId": "",
"scrollSize": 50,
"queryOperator": "must",
"queryType": "match",
"globalQueryText": "",
"searchQueries": [
{
"fieldName": "type",
"queryText": "Asset",
"queryOperator": "must",
"queryType": "match",
"childFilters": [
{
"fieldName": "modifiedAt",
"queryText": "1663178539000:1663607679000",
"queryOperator": "must",
"queryType": "range"
}
]
}
]
}
The range query type can be used to filter search results by a specified range of values for a given field.
You can use this query type to fetch entities that were created or modified within a specified time range.
Range Query Format
| Field | Type | Description |
|---|---|---|
fieldName |
string | A field that has a value in Unix timestamp format (epoch time in milliseconds) |
queryText |
string | "startTimestamp:endTimestamp"; Two colon-separated Unix timestamp values indicating the start and end of time range to search. |
queryOperator |
string | "must", "should", "must-not" |
queryType |
string | "range" |
In the example to the right, the response will contain all entities of "type": "Asset" that were last modified within the timestamp range "1663178539000:1663607679000"
Response Format
Response Format
{
"_scroll_id": "<use this value to fetch the next page of hits>",
"hits": [
{},
{},
{},
...
],
"totalHits": <int>
}
The Entity Search API will return search hits in the following format.
| Field | Type | Description |
|---|---|---|
_scroll_id |
string | Elasticsearch scroll id string. Value is used to get next page of hits. See Pagination for details |
hits |
array | Contains entities matching the query. Maximum number of entities returned is equal to scrollSize |
totalHits |
integer | The total number of entities that match the query |
Routes
Version 0.1 - This is a pre-release version of documentation for Route APIs. API documentation is subject to change upon release of Route APIs
This section covers the usage of the following methods for ParkourSC's Shipment API documentation:
This section covers the CRUD APIs for Route entities.
Create Routes
Create Routes
POST $baseURL/api/2/route?entityTypeKey={{catalog type}}
{
"name" : {{name of route}},
"externalId" : {{external Id}},
"travelTime": "",
"travelDisatance": "",
"travelMode": "" //Road, Air etc...
"source" : {
"externalId" : {{external id of area}},
"entityTypeKey" : {{catalog type}},
"travelTime": "0:10:55", //day:hh:mm format
"travelDistance": "2km",
"travelMode": "Road", //Road, Air, Train, Custom
"layoverTime": "0:10:55" //day:hh:mm format
},
"destination" : {
"externalId" : {{external id of area}},
"entityTypeKey" : {{catalog type}}
}
"wayPoints": [
{
"order" : 0,
"externalId" : {{area external id}},
"entityTypeKey" : {{catalog type}},
"travelTime": "",
"travelDisatance": "",
"travelMode": "" //Road, Air, Train, Custom etc...
}
]
}
Call this API to create a new route.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
entityTypeKey |
Request | true | Object type for route |
Payload Format
| Field | Type | Required | Usage |
|---|---|---|---|
name |
String | true | Name of Route |
externalId |
String | true | External Id of route to be created |
source |
String | true | Source area details |
destination |
String | true | Destination area details |
wayPoints |
String | false | Intermediate area details |
travelMode |
String | true | Values can be Road, Air, Train, Custom |
travelDisatance |
String | true | Distance in km |
travelTime |
String | true | day:hh:mm format |
Response Message for Create Route
{
"type":"route",
"tenantId":"1de47200-441f-4de2-9555-4828ae340829",
"id":"6a814107-1d7e-46c7-b622-7bb4d267a189",
"baseType":"route",
"properties":{
"modifiedAt":1679302496095,
"destination":"DestinationArea-30320011646",
"baseClass":"Location",
"source":"SourceAre-30320011646",
"parentEntityType":"route",
"destinationId":"ef21d98e-07dc-44f4-b54d-857986476e56",
"type":"route",
"createdAt":1679302496095,
"originId":"fa1fc580-a139-4269-9f05-afc0687736c8",
"modifiedBy":"automationuser",
"id":"6a814107-1d7e-46c7-b622-7bb4d267a189",
"entityType":"Route",
"externalId":"SourceAre-30320011646-To-DestinationArea-30320011646",
"travelDisatance":"",
"deleted":false,
"entityTypeKey":"route",
"createdBy":"automationuser",
"name":"Route-30320011646-1",
"tenantId":"1de47200-441f-4de2-9555-4828ae340829",
"locationDetails":"[{\"areaId\":\"fa1fc580-a139-4269-9f05-afc0687736c8\",\"areaName\":\"SourceAre-30320011646\",\"areaType\":\"WorkArea\",\"routeGeojson\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.77853,18.520997]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"layover\":\"::\",\"istimeset\":true,\"areaItem\":{\"identifier\":\"fa1fc580-a139-4269-9f05-afc0687736c8\",\"type\":\"WorkArea\",\"name\":\"SourceAre-30320011646\",\"order\":0,\"locus\":{\"lat\":18.520997,\"lng\":73.77853,\"height\":0.0},\"deleted\":false,\"tenantId\":\"1de47200-441f-4de2-9555-4828ae340829\",\"coordinates\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.77853,18.520997]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"createdBy\":\"automationuser\",\"status\":\"ACTIVE\",\"id\":\"fa1fc580-a139-4269-9f05-afc0687736c8\",\"isHidden\":false,\"externalId\":\"SourceAre-30320011646\",\"classType\":\"Feature\",\"fullAddress\":\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"baseClass\":\"Location\",\"baseType\":\"Location\"},\"coordinates\":{\"lng\":\"73.77853\",\"lat\":\" 18.520997\"},\"address\":\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"areaFenceType\":\"Point\",\"travel_mode\":\"Road\",\"loc_seq_order_no\":1},{\"areaId\":\"eb011ba0-fbda-4da2-89e6-b238cac34273\",\"areaName\":\"WayPointArea-30320011646\",\"areaType\":\"WorkArea\",\"routeGeojson\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.779845,18.523053]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"layover\":\"::\",\"istimeset\":true,\"areaItem\":{\"identifier\":\"eb011ba0-fbda-4da2-89e6-b238cac34273\",\"type\":\"WorkArea\",\"name\":\"WayPointArea-30320011646\",\"order\":0,\"locus\":{\"lat\":18.523053,\"lng\":73.779845,\"height\":0.0},\"deleted\":false,\"tenantId\":\"1de47200-441f-4de2-9555-4828ae340829\",\"coordinates\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.779845,18.523053]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"createdBy\":\"automationuser\",\"status\":\"ACTIVE\",\"id\":\"eb011ba0-fbda-4da2-89e6-b238cac34273\",\"isHidden\":false,\"externalId\":\"WayPointArea-30320011646\",\"classType\":\"Feature\",\"fullAddress\":\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"baseClass\":\"Location\",\"baseType\":\"Location\"},\"coordinates\":{\"lng\":\"73.779845\",\"lat\":\" 18.523053\"},\"address\":\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"areaFenceType\":\"Point\",\"travel_time\":\"0:10:55\",\"travel_mode\":\"Road\",\"order\":0,\"travel_distance\":\"2km\",\"layoverTime\":\"2km\",\"loc_seq_order_no\":2,\"travelDuration\":\"PT10H55M\"},{\"areaId\":\"ef21d98e-07dc-44f4-b54d-857986476e56\",\"areaName\":\"DestinationArea-30320011646\",\"areaType\":\"WorkArea\",\"routeGeojson\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.8079743,18.5474305]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\\\"}\",\"layover\":\"::\",\"istimeset\":true,\"areaItem\":{\"identifier\":\"ef21d98e-07dc-44f4-b54d-857986476e56\",\"type\":\"WorkArea\",\"name\":\"DestinationArea-30320011646\",\"order\":0,\"locus\":{\"lat\":18.5474305,\"lng\":73.8079743,\"height\":0.0},\"deleted\":false,\"tenantId\":\"1de47200-441f-4de2-9555-4828ae340829\",\"coordinates\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.8079743,18.5474305]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\\\"}\",\"createdBy\":\"automationuser\",\"status\":\"ACTIVE\",\"id\":\"ef21d98e-07dc-44f4-b54d-857986476e56\",\"isHidden\":false,\"externalId\":\"DestinationArea-30320011646\",\"classType\":\"Feature\",\"fullAddress\":\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\",\"baseClass\":\"Location\",\"baseType\":\"Location\"},\"coordinates\":{\"lng\":\"73.8079743\",\"lat\":\" 18.5474305\"},\"address\":\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\",\"areaFenceType\":\"Point\",\"travel_time\":\"::\",\"loc_seq_order_no\":3,\"travel_mode\":\"Road\",\"travelDuration\":\"PT0S\"}]",
"transportMode":"Road",
"entityTypeId":"bb19e608-5153-479a-ac6d-8db86334af92",
"classType":"route",
"travelMode":"Road"
},
"fromParty":"",
"toParty":"",
"locationId":"null",
"organization":""
}
Response Messages
Following are the possible Response Messages for Bind Devices to Assets on Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Route object . |
400 |
Invalid Data | Response returns an error message along with the reason for on why route creation failed. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Update Routes
Update Routes
PUT $baseURL/api/2/route/{{externalId}}?entityTypeKey={{catalog type}}
{
"name" : {{name of route}},
"travelTime": "",
"travelDisatance": "",
"travelMode": "" //Road, Air etc...
"source" : {
"externalId" : {{external id of area}},
"entityTypeKey" : {{catalog type}},
"travelTime": "0:10:55", //day:hh:mm format
"travelDistance": "2km",
"travelMode": "Road", //Road, Air, Train, Custom
"layoverTime": "0:10:55" //day:hh:mm format
},
"destination" : {
"externalId" : {{external id of area}},
"entityTypeKey" : {{catalog type}}
}
"wayPoints": [
{
"order" : 0,
"externalId" : {{area external id}},
"entityTypeKey" : {{catalog type}},
"travelTime": "", //day:hh:mm format
"travelDisatance": "",
"travelMode": "" //Road, Air, Train, Custom
}
]
}
Call this API to update the name of an existing organization
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for route |
entityTypeKey |
Request | true | Object type for route |
Payload Format
| Field | Type | Required | Usage |
|---|---|---|---|
name |
String | true | Name of Route |
externalId |
String | true | External Id of route to be created |
source |
String | true | Source area details |
destination |
String | true | Destination area details |
wayPoints |
String | false | Intermediate area details |
travelMode |
String | true | Values can be Road, Air, Train, Custom |
travelDisatance |
String | true | Distance in km |
travelTime |
String | true | day:hh:mm format |
Response Message for Update Route
{
"type":"route",
"tenantId":"1de47200-441f-4de2-9555-4828ae340829",
"id":"6a814107-1d7e-46c7-b622-7bb4d267a189",
"baseType":"route",
"properties":{
"modifiedAt":1679302496095,
"destination":"DestinationArea-30320011646",
"baseClass":"Location",
"source":"SourceAre-30320011646",
"parentEntityType":"route",
"destinationId":"ef21d98e-07dc-44f4-b54d-857986476e56",
"type":"route",
"createdAt":1679302496095,
"originId":"fa1fc580-a139-4269-9f05-afc0687736c8",
"modifiedBy":"automationuser",
"id":"6a814107-1d7e-46c7-b622-7bb4d267a189",
"entityType":"Route",
"externalId":"SourceAre-30320011646-To-DestinationArea-30320011646",
"travelDisatance":"",
"deleted":false,
"entityTypeKey":"route",
"createdBy":"automationuser",
"name":"Route-30320011646-1",
"tenantId":"1de47200-441f-4de2-9555-4828ae340829",
"locationDetails":"[{\"areaId\":\"fa1fc580-a139-4269-9f05-afc0687736c8\",\"areaName\":\"SourceAre-30320011646\",\"areaType\":\"WorkArea\",\"routeGeojson\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.77853,18.520997]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"layover\":\"::\",\"istimeset\":true,\"areaItem\":{\"identifier\":\"fa1fc580-a139-4269-9f05-afc0687736c8\",\"type\":\"WorkArea\",\"name\":\"SourceAre-30320011646\",\"order\":0,\"locus\":{\"lat\":18.520997,\"lng\":73.77853,\"height\":0.0},\"deleted\":false,\"tenantId\":\"1de47200-441f-4de2-9555-4828ae340829\",\"coordinates\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.77853,18.520997]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"createdBy\":\"automationuser\",\"status\":\"ACTIVE\",\"id\":\"fa1fc580-a139-4269-9f05-afc0687736c8\",\"isHidden\":false,\"externalId\":\"SourceAre-30320011646\",\"classType\":\"Feature\",\"fullAddress\":\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"baseClass\":\"Location\",\"baseType\":\"Location\"},\"coordinates\":{\"lng\":\"73.77853\",\"lat\":\" 18.520997\"},\"address\":\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"areaFenceType\":\"Point\",\"travel_mode\":\"Road\",\"loc_seq_order_no\":1},{\"areaId\":\"eb011ba0-fbda-4da2-89e6-b238cac34273\",\"areaName\":\"WayPointArea-30320011646\",\"areaType\":\"WorkArea\",\"routeGeojson\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.779845,18.523053]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"layover\":\"::\",\"istimeset\":true,\"areaItem\":{\"identifier\":\"eb011ba0-fbda-4da2-89e6-b238cac34273\",\"type\":\"WorkArea\",\"name\":\"WayPointArea-30320011646\",\"order\":0,\"locus\":{\"lat\":18.523053,\"lng\":73.779845,\"height\":0.0},\"deleted\":false,\"tenantId\":\"1de47200-441f-4de2-9555-4828ae340829\",\"coordinates\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.779845,18.523053]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\\\"}\",\"createdBy\":\"automationuser\",\"status\":\"ACTIVE\",\"id\":\"eb011ba0-fbda-4da2-89e6-b238cac34273\",\"isHidden\":false,\"externalId\":\"WayPointArea-30320011646\",\"classType\":\"Feature\",\"fullAddress\":\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"baseClass\":\"Location\",\"baseType\":\"Location\"},\"coordinates\":{\"lng\":\"73.779845\",\"lat\":\" 18.523053\"},\"address\":\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\",\"areaFenceType\":\"Point\",\"travel_time\":\"0:10:55\",\"travel_mode\":\"Road\",\"order\":0,\"travel_distance\":\"2km\",\"layoverTime\":\"2km\",\"loc_seq_order_no\":2,\"travelDuration\":\"PT10H55M\"},{\"areaId\":\"ef21d98e-07dc-44f4-b54d-857986476e56\",\"areaName\":\"DestinationArea-30320011646\",\"areaType\":\"WorkArea\",\"routeGeojson\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.8079743,18.5474305]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\\\"}\",\"layover\":\"::\",\"istimeset\":true,\"areaItem\":{\"identifier\":\"ef21d98e-07dc-44f4-b54d-857986476e56\",\"type\":\"WorkArea\",\"name\":\"DestinationArea-30320011646\",\"order\":0,\"locus\":{\"lat\":18.5474305,\"lng\":73.8079743,\"height\":0.0},\"deleted\":false,\"tenantId\":\"1de47200-441f-4de2-9555-4828ae340829\",\"coordinates\":\"{\\\"type\\\":\\\"Feature\\\",\\\"properties\\\":{\\\"type\\\":\\\"circle\\\",\\\"radius\\\":\\\"500\\\"},\\\"geometry\\\":{\\\"type\\\":\\\"Point\\\",\\\"coordinates\\\":[73.8079743,18.5474305]},\\\"zoomLevel\\\":15,\\\"address\\\":\\\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\\\"}\",\"createdBy\":\"automationuser\",\"status\":\"ACTIVE\",\"id\":\"ef21d98e-07dc-44f4-b54d-857986476e56\",\"isHidden\":false,\"externalId\":\"DestinationArea-30320011646\",\"classType\":\"Feature\",\"fullAddress\":\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\",\"baseClass\":\"Location\",\"baseType\":\"Location\"},\"coordinates\":{\"lng\":\"73.8079743\",\"lat\":\" 18.5474305\"},\"address\":\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\",\"areaFenceType\":\"Point\",\"travel_time\":\"::\",\"loc_seq_order_no\":3,\"travel_mode\":\"Road\",\"travelDuration\":\"PT0S\"}]",
"transportMode":"Road",
"entityTypeId":"bb19e608-5153-479a-ac6d-8db86334af92",
"classType":"route",
"travelMode":"Road"
},
"fromParty":"",
"toParty":"",
"locationId":"null",
"organization":""
}
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Updated Route object . |
400 |
Invalid Data | Response returns an error message along with the reason for on why route updation failed. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Delete Routes
Delete Routes
DELETE $baseURL/api/2/route/{{externalId}}?entityTypeKey={{catalog type}}
Call this API to delete an route
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for route |
entityTypeKey |
Request | true | Object type for route |
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | |
400 |
Invalid Data | |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Get Routes
Get Routes
GET $baseURL/api/2/route/{{externalId}}?entityTypeKey={{catalog type}}
Call this API to get an route details by external id
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for route |
entityTypeKey |
Request | true | Object type for route |
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | |
400 |
Invalid Data | |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Response Message for Update Route
{
"type": "route",
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"id": "573c34d8-3ea4-4e0e-8583-ca16ab476d5c",
"baseType": "route",
"properties": {
"catalogType": "Route",
"modifiedAt": 1679376776559,
"destination": "DestinationArea-30320062022",
"baseClass": "Location",
"source": "SourceAre-30320062022",
"parentEntityType": "route",
"type": "Route",
"destinationId": "475b5450-692a-4f2c-91f7-b11894b5716a",
"objectType": "route",
"createdAt": 1679317250457,
"originId": "f8efae46-6dee-4d5c-af3c-b919a3765f41",
"modifiedBy": "automationuser",
"id": "573c34d8-3ea4-4e0e-8583-ca16ab476d5c",
"organizationName": "ranjandhl",
"entityType": "Route",
"externalId": "Route-30320062022",
"travelDisatance": "10km",
"deleted": "false",
"entityTypeKey": "route",
"createdBy": "automationuser",
"organization": "e4b3e2a4-3243-4888-8469-2d7c7deea487",
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"name": "Route-3032006202",
"locationDetails": [
{
"layover": "::",
"travel_mode": "Road",
"loc_seq_order_no": 1,
"travel_time": "0:0:1",
"istimeset": true,
"areaName": "SourceAre-30320062022",
"routeError": false,
"override": false,
"travel_distance": "0.3 km",
"areaId": "f8efae46-6dee-4d5c-af3c-b919a3765f41",
"routeGeojson": "{\"type\":\"Feature\",\"properties\":{\"type\":\"circle\",\"radius\":\"500\"},\"geometry\":{\"type\":\"Point\",\"coordinates\":[73.77853,18.520997]},\"zoomLevel\":15,\"address\":\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\"}",
"areaType": "WorkArea",
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"areaItem": {
"type": "WorkArea",
"identifier": "f8efae46-6dee-4d5c-af3c-b919a3765f41",
"name": "SourceAre-30320062022",
"order": 1,
"locus": {
"lat": 18.520997,
"lng": 73.77853,
"height": 0
},
"deleted": false,
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"coordinates": "{\"type\":\"Feature\",\"properties\":{\"type\":\"circle\",\"radius\":\"500\"},\"geometry\":{\"type\":\"Point\",\"coordinates\":[73.77853,18.520997]},\"zoomLevel\":15,\"address\":\"Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\"}",
"createdBy": "automationuser",
"status": "ACTIVE",
"id": "f8efae46-6dee-4d5c-af3c-b919a3765f41",
"isHidden": false,
"externalId": "SourceAre-30320062022",
"classType": "Feature",
"fullAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India",
"baseType": "Location",
"baseClass": "Location"
},
"coordinates": {
"lat": 18.520997,
"lng": 73.77853
},
"travelDuration": {
"seconds": 69,
"nano": 0,
"units": [
"SECONDS",
"NANOS"
],
"negative": false,
"zero": false
},
"address": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pakharbaug Society, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India",
"areaFenceType": "circle"
},
{
"layover": "::",
"travel_mode": "Road",
"loc_seq_order_no": 2,
"travel_time": "0:0:12",
"istimeset": true,
"areaName": "WayPointArea-30320062022",
"routeError": false,
"override": false,
"travel_distance": "5.1 km",
"areaId": "2323b807-e466-4597-b0f0-13abd12ae679",
"routeGeojson": "{\"type\":\"Feature\",\"properties\":{\"type\":\"circle\",\"radius\":\"500\"},\"geometry\":{\"type\":\"Point\",\"coordinates\":[73.779845,18.523053]},\"zoomLevel\":15,\"address\":\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\"}",
"areaType": "WorkArea",
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"areaItem": {
"type": "WorkArea",
"identifier": "2323b807-e466-4597-b0f0-13abd12ae679",
"name": "WayPointArea-30320062022",
"order": 2,
"locus": {
"lat": 18.523053,
"lng": 73.779845,
"height": 0
},
"deleted": false,
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"coordinates": "{\"type\":\"Feature\",\"properties\":{\"type\":\"circle\",\"radius\":\"500\"},\"geometry\":{\"type\":\"Point\",\"coordinates\":[73.779845,18.523053]},\"zoomLevel\":15,\"address\":\"Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India\"}",
"createdBy": "automationuser",
"status": "ACTIVE",
"id": "2323b807-e466-4597-b0f0-13abd12ae679",
"isHidden": false,
"externalId": "WayPointArea-30320062022",
"classType": "Feature",
"fullAddress": "Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India",
"baseType": "Location",
"baseClass": "Location"
},
"coordinates": {
"lat": 18.523053,
"lng": 73.779845
},
"travelDuration": {
"seconds": 734,
"nano": 0,
"units": [
"SECONDS",
"NANOS"
],
"negative": false,
"zero": false
},
"address": "Part of Ground and Mezzanine Floor, Showroom No. 2 AG Tech Park, NDA Pashan Rd, Ram Nagar, Bavdhan, Pune, Maharashtra 411021, India",
"areaFenceType": "circle"
},
{
"layover": "::",
"travel_mode": "Road",
"loc_seq_order_no": 3,
"travel_time": "::",
"istimeset": true,
"areaName": "DestinationArea-30320062022",
"routeError": false,
"areaId": "475b5450-692a-4f2c-91f7-b11894b5716a",
"routeGeojson": "{\"type\":\"Feature\",\"properties\":{\"type\":\"circle\",\"radius\":\"500\"},\"geometry\":{\"type\":\"Point\",\"coordinates\":[73.8079743,18.5474305]},\"zoomLevel\":15,\"address\":\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\"}",
"areaType": "WorkArea",
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"areaItem": {
"type": "WorkArea",
"identifier": "475b5450-692a-4f2c-91f7-b11894b5716a",
"name": "DestinationArea-30320062022",
"order": 3,
"locus": {
"lat": 18.5474305,
"lng": 73.8079743,
"height": 0
},
"deleted": false,
"tenantId": "1de47200-441f-4de2-9555-4828ae340829",
"coordinates": "{\"type\":\"Feature\",\"properties\":{\"type\":\"circle\",\"radius\":\"500\"},\"geometry\":{\"type\":\"Point\",\"coordinates\":[73.8079743,18.5474305]},\"zoomLevel\":15,\"address\":\"Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India\"}",
"createdBy": "automationuser",
"status": "ACTIVE",
"id": "475b5450-692a-4f2c-91f7-b11894b5716a",
"isHidden": false,
"externalId": "DestinationArea-30320062022",
"classType": "Feature",
"fullAddress": "Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India",
"baseType": "Location",
"baseClass": "Location"
},
"coordinates": {
"lat": 18.5474305,
"lng": 73.8079743
},
"travelDuration": {
"nano": 0,
"units": [
"SECONDS",
"NANOS"
],
"negative": false,
"zero": false
},
"address": "Main Academic, INDIAN INSTITUTE OF SCIENCE EDUCATION AND RESEARCH, Dr Homi Bhabha Rd, Pashan, Pune, Maharashtra 411008, India",
"areaFenceType": "circle"
}
],
"transportMode": "Road",
"entityTypeId": "bb19e608-5153-479a-ac6d-8db86334af92",
"classType": "Route",
"travelMode": "Road"
},
"fromParty": "",
"toParty": "",
"locationId": "null",
"organization": "e4b3e2a4-3243-4888-8469-2d7c7deea487"
}
Shipments
Version 0.1 - This is a pre-release version of documentation for Shipment APIs. API documentation is subject to change upon release of Shipment APIs
This section covers the usage of the following methods for ParkourSC's Shipment API documentation:
- Create Shipments
- Update Shipments
- Patch Shipments
- Delete Shipments
- Get Shipment Details
- Get List of Shipments
Create Shipments
The following type of shipments are supported can be created via the Shipments API:
- Standard Shipments
- Parcel Shipments
- Composite Shipments
- DTP Shipments
Note that the PUT method is used to create or update shipments.
Create Standard Shipments
This section describes how standard shipments are created in ParkourSC via API:
Create Standard Shipments Request
PUT $baseURL/api/2/shipment/standard/{{externalId}}?entityTypeKey=standardshipment
{
"name": "Shipment-123",
"directToResidence": true or false, // Default is false
"assets": [
{
"externalId": {{asset external id}},
"entityTypeKey": {{asset type}}
}
],
"direction": "Outbound",
"plannedDeparture": 1674639169248,
"plannedArrival": 1674639529248,
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"organizationName": {{organization name}},
"sensorProfile": "{{sensor profile name}}",
"modeOfTransport": "Air",
"notes": "This is first shipment or two",
"orderNum": "ORD1234",
"shipperName": "Shipment Corp",
"custName": "Pfizer, Inc.",
"custCode": "Cust001",
"ruleSetName": {{rule set name}},
"recipientName": "Mr. John Doe",
"mawb": "AWB000123",
"postingDate": 1674639169248,
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for standard shipment to be added or updated |
entityTypeKey |
Request | true | Object type for shipment. Default value: standardshipment |
isDraft |
Request | false | If user wants to create shipmen as Draft state: standardshipment |
Request Class Model for Create Standard Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| assets | true | string | Array of all assets that are part of the shipment
|
| direction | true | string | Valid values are:
|
| plannedDeparture | true | numeric | Planned departure datetime. Must be in milliseconds format. |
| plannedArrival | true | numeric | Planned arrival datetime
|
| route | true | string | Route associated with shipment
|
| organizationName | false | string | Organization name (unique external ID) to assign shipment to a specific organization (sub-tenant)
|
| sensorProfile | false | string | Sensor profiles can be associated with the shipment
|
| modeOfTransport | false | string | Valid values for Mode of Transport are:
|
| notes | false | string | Notes for the shipment |
| orderNum | false | string | Order number for the shipment. This is usually a Sales Order number |
| shipperName | false | string | Name of shipper |
| custName | false | string | Customer name |
| custCode | false | string | Customer code |
| ruleSetName | false | string | Rule set name (unique external ID) to be associated with shipment Existing rulesets can be found using the search API
|
| recipientName | false | string | Name of Recipient for the shipment |
| mawb | false | string | Master Airway Bill Number (MAWB) |
| postingDate | false | numeric | Date and time the shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Create Standard Shipments
{
"type": "standardshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"baseType": "standardshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"notes": "",
"modifiedAt": "1674638840512",
"ruleSet": "",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "standardshipment",
"originAreaName": "Area02-2501",
"routeName": "Multi WP Route by Nih 01 ",
"destHidden": false,
"createdAt": "1674638840512",
"assets": [
"975a87ae-ae84-452a-815d-5ad3a199299b"
],
"carrierName": "",
"recipientName": "",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"teststandard1209": "",
"entityType": "Standard Shipment",
"plannedDeparture": "1674638745054",
"shipperName": "",
"tags": "[]",
"route": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"carrierCode": "",
"name": "SShip_Nih_01-2501",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"origin": "Area02-2501",
"destination": "Area06-2501",
"orderNum": "",
"plannedArrival": "1674760245000",
"parentEntityType": "standardshipment",
"destinationAreaId": "bfd4b673-488a-4938-8385-028fe4acfcf8",
"custOrdRef": "",
"shipmentType": "Standard",
"originHidden": false,
"routeId": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892,
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "975a87ae-ae84-452a-815d-5ad3a199299b",
"baseType": "asset",
"properties": {
"modifiedAt": "1674638736571",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"createdAt": "1674638736571",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/assets.svg",
"modifiedBy": "nihar_trm",
"id": "975a87ae-ae84-452a-815d-5ad3a199299b",
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"externalId": "SSXDC323",
"catalogName": "Asset",
"deleted": "false",
"entityTypeKey": "asset",
"taggedAssetId": "f313e4d5-fb6e-4670-8576-1f7edc66ec13",
"createdBy": "nihar_trm",
"organization": "",
"name": "Asset01-2501",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"category": "asset",
"qrBarCode": "",
"status": "ACTIVE"
},
"locationId": "null",
"toParty": "",
"fromParty": "",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"externalId": "SShip_Nih_01-2501",
"shipmentRouteSegments": "[{\"carrierType\":\"FLIGHT\",\"carrierDeptTime\":0,\"properties\":{\"timeZone\":\"Asia/Kolkata\",\"segmentIndex\":\"0\"},\"segSrcCode\":\"VAPO\",\"segDestCode\":\"VANP\",\"segSrcAreaId\":\"ef7bea98-f568-4837-bc58-81068018d4f3\",\"segDestAreaId\":\"728b9b24-b390-4e4a-9726-78c034ad94d2\"}]",
"custName": "",
"mawb": "",
"custCode": "",
"destinationAreaName": "Area06-2501",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "standardshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "d738cf3a-f1f7-47c6-af27-0d465378d7b6",
"originAreaId": "ef7bea98-f568-4837-bc58-81068018d4f3",
"postingDate":"1674639169248"
},
"locationId": "null",
"toParty": "",
"fromParty": "",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Create Standard Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
201 |
Shipment Created Successfully | Response returns the created standard shipment object created. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Create Parcel Shipments
This section describes how parcel shipments are created in ParkourSC via API:
Create Parcel Shipments Request
PUT $baseURL/api/2/shipment/parcel/{{externalId}}?entityTypeKey=parcelshipment
{
"name": "Parcel Shipment-123",
"directToResidence": true or false,
"assets": [
{
"externalId": {{asset external id}},
"entityTypeKey": {{asset type}},
"sensor": {
"sensorId": {{sensor id}},
"entityTypeKey": {{sensor type}}
},
"trackingNumber": "77898",
"extendedProperties": { //RT37.3 To set extra attribute for creating new dynamic assets
"anotherAttrib": "another value"
}
}
],
"direction": "Outbound",
"plannedDeparture": 1674639169248,
"plannedArrival": 1674639529248,
"carrierCode": "ups",
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"ruleSetName": {{rule set name}},
"fromAddress": "235 East 42nd Street, New York, NY 10017, USA",
"toAddress": "609 South Grand Avenue, Los Angeles, CA 90017, USA",
"originArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"destinationArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"organizationName": {{organization Name}},
"sensorProfile": {{sensorProfile}},
"modeOfTransport": "Air",
"notes": "This is first shipment of two.",
"orderNum": "ORD1234",
"shipperName": "UPS",
"custName": "Pfizer, Inc.",
"custCode": "Cust001",
"recipientName": "Mr. John Doe",
"postingDate": 1674639169248,
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for parcel shipment to be added or updated |
entityTypeKey |
Request | true | Object type for shipment. Default value: parcelshipment |
isDraft |
Request | false | If user wants to create shipmen as Draft state: parcelshipment |
Request Class Model for Create Parcel Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| assets | true | string | Array of all assets that are part of the shipment
|
| direction | true | string | Valid values are:
|
| plannedDeparture | true | numeric | Planned departure datetime. Must be in milliseconds format. |
| plannedArrival | true | numeric | Planned arrival datetime
|
| carrierCode | true | string | Carrier code associated with shipment Additional details for carrier can be obtained using search API
|
| route | conditionally | string | Route associated with shipment
|
| fromAddress | conditionally | string | "From address" associated with shipment
|
| toAddress | conditionally | string | "To address" associated with shipment
|
| originArea | conditionally | string | Origin Area associated with shipment
|
| destinationArea | conditionally | string | Destination Area associated with shipment
|
| organizationName | false | string | Organization name (unique external ID) to assign shipment to a specific organization (sub-tenant)
|
| sensorProfile | false | string | Sensor profiles can be associated with the shipment
|
| modeOfTransport | false | string | Valid values for Mode of Transport are:
|
| notes | false | string | Notes for the shipment |
| orderNum | false | string | Order number for the shipment. This is usually a Sales Order number |
| shipperName | false | string | Name of shipper |
| custName | false | string | Customer name |
| custCode | false | string | Customer code |
| ruleSetName | false | string | Rule set name (unique external ID) to be associated with shipment Existing rulesets can be found using the search API
|
| recipientName | false | string | Name of Recipient for the shipment |
| postingDate | false | numeric | Date and time the shipment data was extracted from the external system. Must be in milliseconds format. |
Conditionally Required Attributes
For parcel shipments, ParkourSC application provides the option of selecting the origin point and the destination point of a parcel shipment in three ways:
- Selecting a pre-defined route
- Selecting pre-defined origin and destination areas
- Providing From and To addresses
Note that areas and addresses can be mixed and matched. Thus, the following elements are conditionally required:
- Route is required if no areas or addresses are provided
- Origin Area is required if route is not provided
- Origin Address is required if route and Origin Area are not provided
- Destination Area is required if route is not provided
- Destination Address is required if route and Destination Area are not provided
Response Message Example for Create Parcel Shipments
{
"type": "parcelshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"baseType": "parcelshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"2NovSatishAttribute1": "satishDefault1",
"notes": "",
"modifiedAt": "1675773933486",
"ruleSet": "bedf7882-b0cb-4113-bd8d-ee5c86c51a19",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "parcelshipment",
"originAreaName": "BArea101",
"routeName": "Route02-0702",
"destHidden": false,
"createdAt": "1675773933486",
"assets": [
"b6a22bc0-493b-41c4-bfdb-ae37d50be1e5"
],
"carrierName": "FedEx",
"pSattr0207": "",
"recipientName": "",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"entityType": "Parcel Shipment",
"plannedDeparture": "1675708200000",
"trackingNumbers": "14253698",
"shipperName": "",
"tags": "[]",
"route": "5c0a1839-f608-4390-b4c9-1a355545700e",
"27OctSatishAttribute1": "",
"carrierCode": "fedex",
"name": "Starndard Shipment-123",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"21OctSatishAttribute1": "default",
"origin": "BArea101",
"destination": "Area01-0702",
"orderNum": "",
"plannedArrival": "1675794600000",
"parentEntityType": "parcelshipment",
"destinationAreaId": "857d6b7d-519c-4f91-9338-c41314e7d0b6",
"custOrdRef": "",
"shipmentType": "Parcel",
"originHidden": false,
"routeId": "5c0a1839-f608-4390-b4c9-1a355545700e",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"baseType": "asset",
"properties": {
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"modifiedAt": "1675769453591",
"externalId": "BASID03",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"catalogName": "Asset",
"createdAt": "1675769435425",
"21NovSatishAttribute1": "default1",
"deleted": "false",
"entityTypeKey": "asset",
"createdBy": "nihar_trm",
"taggedAssetId": "0cd43273-794d-46ad-a888-4aec0b8c46b3",
"imageURL": "https://s3.amazonaws.com/clf-webapp-storage/1e779185-72b4-4287-afea-2d931017e02d/asset/b6a22bc0-493b-41c4-bfdb-ae37d50be1e5.png",
"name": "BAsset098",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"modifiedBy": "nihar_trm",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"category": "asset",
"qrBarCode": "BASQRC43",
"status": "ACTIVE"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"externalId": "PS01_Nih_0702",
"custName": "",
"custCode": "",
"destinationAreaName": "Area01-0702",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "parcelshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "c9eb3a83-9e2d-420f-a69b-5dd0af72f67a",
"rulesetName": "Nih_RS_for_Asset",
"originAreaId": "9e663359-f5fe-4c9f-a12d-b87a71ccecf1",
"postingDate":"1674639169248",
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Create Parcel Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
201 |
Shipment Created Successfully | Response returns the created parcel shipment object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Create Composite Shipment
This section describes how composite shipments are created in ParkourSC via API:
Create Composite Shipments Request
PUT $baseURL/api/2/shipment/composite/{{externalId}}?entityTypeKey=compositeshipment
{
"name": "Composite Shipment-123",
"subShipments": [ // mandatory
{
"externalId": {{external Id}},
"entityTypeKey": {{shipment type}}
},
{
"externalId": {{external Id}},
"entityTypeKey": {{shipment type}}
}
]
"organizationName": {{organization name}}
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
entityTypeKey |
Request | true | Object type for shipment. Default value: compositeshipment |
externalId |
Path | true | External Id of composite shipment |
Request Class Model for Create Composite Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| subShipments | true | string | Array of all shipments that are part of the composite shipment
|
| organizationName | false | string | Organization name (unique external ID) to assign shipment to a specific organization (sub-tenant)
|
Response Message Example for Create Composite Shipments
{
"type": "compositeshipment",
"tenantId": "9bff5165-63cd-4b3e-9959-b5cb3fde6991",
"id": "b24dc37f-a1f5-4ecc-9eff-4700e513ddf3",
"baseType": "compositeshipment",
"properties": {
"subShipmentIds": "[\"8a3cdeba-8306-4d39-a671-8733ab8c17fc\",\"d4211b7e-567e-4eed-8330-4f54292b8230\"]",
"modifiedAt": 1676350609818,
"entityType": "Composite Shipment",
"origin": "Fergusson Pune",
"destination": "VREC Indur",
"externalId": "skFetb14-Composite03",
"baseClass": "shipment",
"parentEntityType": "compositeshipment",
"type": "compositeshipment",
"createdAt": 1676350609818,
"deleted": "",
"entityTypeKey": "compositeshipment",
"createdBy": "arun2022",
"organization": "",
"name": "skFetb14-Composite03",
"tenantId": "9bff5165-63cd-4b3e-9959-b5cb3fde6991",
"modifiedBy": "arun2022",
"entityTypeId": "b786b955-9c57-4ee5-8fd6-09919baccb18",
"id": "b24dc37f-a1f5-4ecc-9eff-4700e513ddf3"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Create Composite Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
201 |
Shipment Created Successfully | Response returns the composite shipment object updated. Note that internal IDs are returned for all entities, including sub-shipments associated with the composite shipment. |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Create DTP Shipment
This section describes how DTP shipments are created in ParkourSC via API:
Create DTP Shipments Request
PUT $baseURL/api/2/shipment/dtp/{{externalId}}?entityTypeKey=dtpshipment
{
"name": "DTPship-04032024125016",
"directToResidence": true,
"assets": [
{
"externalId": "04032024125016",
"entityTypeKey": "asset",
"trackingNumber": "6382173256541",
"name": "AssetName-04032024125016",
"extendedProperties": { //RT37.3 To set extra attribute for creating new dynamic assets
"anotherAttrib": "another value"
}
}
],
"direction": "Outbound",
"originArea": {
"name": "AutoSourceArea",
"entityTypeKey": "area"
},
"destinationArea": {
"name": "AutoDestinationArea",
"entityTypeKey": "area"
},
"plannedDeparture": 1709277616032,
"plannedArrival": 1709450416032,
"organizationName": "",
"carrierCode": "fedex",
"sensorProfile": "",
"ruleSetName": "TempExcursionTest",
"modeOfTransport": "Air",
"notes": "This is a Parcel shipment",
"orderNum": "04032024125016",
"shipperName": "",
"custName": "Automation User",
"custCode": "",
"recipientName": "Mr. John Doe"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for parcel shipment to be added or updated |
entityTypeKey |
Request | true | Object type for shipment. Default value: dtpshipment |
isDraft |
Request | false | If user wants to create shipmen as Draft state: dtpshipment |
Request Class Model for Create DTP Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| assets | true | string | Array of all assets that are part of the shipment
|
| direction | true | string | Valid values are:
|
| plannedDeparture | true | numeric | Planned departure datetime. Must be in milliseconds format. |
| plannedArrival | true | numeric | Planned arrival datetime
|
| carrierCode | true | string | Carrier code associated with shipment Additional details for carrier can be obtained using search API
|
| route | conditionally | string | Route associated with shipment
|
| fromAddress | conditionally | string | "From address" associated with shipment
|
| toAddress | conditionally | string | "To address" associated with shipment
|
| originArea | conditionally | string | Origin Area associated with shipment
|
| destinationArea | conditionally | string | Destination Area associated with shipment
|
| organizationName | false | string | Organization name (unique external ID) to assign shipment to a specific organization (sub-tenant)
|
| sensorProfile | false | string | Sensor profiles can be associated with the shipment
|
| modeOfTransport | false | string | Valid values for Mode of Transport are:
|
| notes | false | string | Notes for the shipment |
| orderNum | false | string | Order number for the shipment. This is usually a Sales Order number |
| shipperName | false | string | Name of shipper |
| custName | false | string | Customer name |
| custCode | false | string | Customer code |
| ruleSetName | false | string | Rule set name (unique external ID) to be associated with shipment Existing rulesets can be found using the search API
|
| recipientName | false | string | Name of Recipient for the shipment |
| postingDate | false | numeric | Date and time the shipment data was extracted from the external system. Must be in milliseconds format. |
Conditionally Required Attributes
For DTP shipments, ParkourSC application provides the option of selecting the origin point and the destination point of a parcel shipment in three ways:
- Selecting a pre-defined route
- Selecting pre-defined origin and destination areas
- Providing From and To addresses
Note that areas and addresses can be mixed and matched. Thus, the following elements are conditionally required:
- Route is required if no areas or addresses are provided
- Origin Area is required if route is not provided
- Origin Address is required if route and Origin Area are not provided
- Destination Area is required if route is not provided
- Destination Address is required if route and Destination Area are not provided
Response Message Example for Create DTP Shipments
{
"type": "dtpshipment",
"tenantId": "bd75e6eb-dc89-498e-8ef8-65da6530693f",
"id": "65047b37-2704-4108-b715-8688a777d685",
"baseType": "dtpshipment",
"properties": {
"permalinkFull": "https://test2-share.parkoursc.com/#/uJZUeE59iJsDc6xJD-65r6hWawgG5LXS0CuSYeuwALC03RzGYZC5wW1AuwsGqXCfyVFQCazjDaT4vfSovGutIyYURD7-PoiF9hibQacpy1tQsMQjmF8FJ2lAqdqDuhkSc8I_3F4W6yiajub242JAykTMdLeCuaoK9cwigsxtolM",
"notes": "This is a Parcel shipment",
"modifiedAt": 1709536826425,
"isDraft": false,
"ruleSet": "ed58fe45-b1d4-4a3d-a53d-09abf6857292",
"modeOfTransport": "Air",
"baseClass": "shipment",
"source": "AutoSourceArea",
"type": "dtpshipment",
"toAddress": "",
"originAreaName": "AutoSourceArea",
"routeName": "82 Dalford Ct, Telford TF3 2BP, UK-To-Station St, Birmingham, UK",
"dynamicRouteLabel": "82 Dalford Ct, Telford TF3 2BP, UK-To-Station St, Birmingham, UK",
"createdAt": 1709536826425,
"destHidden": false,
"routeExternalId": "AutoSourceArea_AutoDestinationArea",
"assets": "[\"4fcdf065-1056-45ee-8e1b-ea1891fecfae\"]",
"carrierName": "FedEx",
"booleantest": "false",
"lastCarrierUpdateAt": "",
"recipientName": "Mr. John Doe",
"id": "65047b37-2704-4108-b715-8688a777d685",
"destinationAreaType": "area",
"latestMilestone": "",
"organizationName": "",
"entityType": "DTP Shipment",
"parentEntityTypeKey": "dtpshipment",
"destinationAreadetails": "{\"id\":\"2c8525a9-fb97-46e2-8c70-f8c4af09b831\",\"externalId\":\"AutoDestinationArea\",\"catalogType\":\"area\",\"entityTypeKey\":\"area\",\"name\":\"AutoDestinationArea\"}",
"plannedDeparture": 1709277616032,
"trackingNumbers": "[\"6382173256541\"]",
"shipperName": "",
"subStatus": "",
"tags": "[]",
"notesModifiedAt": 1709536826000,
"route": "0694012f-6bdb-4178-a132-5d97ab7ab8de",
"carrierCode": "fedex",
"name": "DTPship-04032024125016",
"permalinkLimited": "https://test2-share.parkoursc.com/#/uJZUeE59iJsDc6xJD-65r6hWawgG5LXS0CuSYeuwALC03RzGYZC5wW1AuwsGqXCfSlJ13PK5_3-d_M8RtyTKwnjla_4X3ZkQqcWsq6gDJcxq_m4T0oBJ5MgP6MfuREYml8nV9hxztjlRF0ZnbqxtTALI5gT5PcUOsD3P2AGQois",
"status": "",
"eurl": "",
"origin": "AutoSourceArea",
"destination": "AutoDestinationArea",
"plannedArrival": 1709450416032,
"orderNum": "04032024125016",
"parentEntityType": "DTP Shipment",
"destinationAreaId": "2c8525a9-fb97-46e2-8c70-f8c4af09b831",
"custOrdRef": "",
"baseType": "DTP Shipment",
"shipmentType": "dtp",
"originHidden": false,
"shipmentETA": "",
"destinationArea": "{\"entityTypeKey\":\"area\",\"name\":\"AutoDestinationArea\"}",
"routeId": "0694012f-6bdb-4178-a132-5d97ab7ab8de",
"tenantName": "rt38tenant",
"ruleSetName": "TempExcursionTest",
"originAreadetails": "{\"id\":\"8bf2f32a-c5f3-4d33-b8d5-c1701fc3eaf8\",\"externalId\":\"AutoSourceArea\",\"catalogType\":\"area\",\"entityTypeKey\":\"area\",\"name\":\"AutoSourceArea\"}",
"fromAddress": "",
"modifiedBy": "rt38auto",
"assetDtos": "[{\"externalId\":\"04032024125016\",\"name\":\"AssetName-04032024125016\",\"catalogType\":\"asset\",\"entityTypeKey\":\"asset\",\"trackingNumber\":\"6382173256541\"}]",
"originAreaType": "area",
"directToResidence": true,
"routeType": "route",
"assetNodes": [
{
"type": "asset",
"tenantId": "bd75e6eb-dc89-498e-8ef8-65da6530693f",
"id": "4fcdf065-1056-45ee-8e1b-ea1891fecfae",
"baseType": "asset",
"properties": {
"modifiedAt": 1709536826322,
"chSensitive": "",
"baseClass": "asset",
"parentEntityType": "Asset",
"type": "Asset",
"chtestExt": "chtestExt_Value",
"baseType": "Asset",
"createdAt": 1709536826322,
"locationId": "",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/assets.svg",
"chDTP": "",
"modifiedBy": "rt38auto",
"id": "4fcdf065-1056-45ee-8e1b-ea1891fecfae",
"baseTypeKey": "asset",
"monitoredStatus": "UNMONITORED",
"chDefault": "",
"eURL": "",
"entityType": "Asset",
"parentEntityTypeKey": "asset",
"test1123": "",
"externalId": "04032024125016",
"catalogName": "Asset",
"deleted": false,
"entityTypeKey": "asset",
"taggedAssetId": "cdd1c766-3a77-4ac3-90c3-7bc840cbb8ea",
"createdBy": "rt38auto",
"organization": "",
"name": "AssetName-04032024125016",
"tenantId": "bd75e6eb-dc89-498e-8ef8-65da6530693f",
"entityTypeId": "ddce7df4-92f7-49fc-be2b-1ce2b44c8cfc",
"typeId": "ddce7df4-92f7-49fc-be2b-1ce2b44c8cfc",
"category": "asset",
"qrBarCode": "",
"status": "ACTIVE"
},
"toParty": "",
"fromParty": "",
"locationId": "",
"organization": ""
}
],
"direction": "Outbound",
"baseTypeKey": "dtpshipment",
"sensorProfile": "",
"externalId": "04032024125016",
"chExtDefault": "",
"custName": "Automation User",
"custCode": "",
"destinationAreaName": "AutoDestinationArea",
"notesModifiedBy": "rt38auto",
"removedAssets": [],
"chExtDTP": "",
"chExtSensitive": "",
"deleted": false,
"entityTypeKey": "dtpshipment",
"stage": "",
"routeHidden": true,
"createdBy": "rt38auto",
"organization": "",
"tenantId": "bd75e6eb-dc89-498e-8ef8-65da6530693f",
"entityTypeId": "89b2c07f-22fd-4e6e-9414-3d6e02b46d5c",
"originArea": "{\"entityTypeKey\":\"area\",\"name\":\"AutoSourceArea\"}",
"originAreaId": "8bf2f32a-c5f3-4d33-b8d5-c1701fc3eaf8"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Create DTP Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
201 |
Shipment Created Successfully | Response returns the dtp shipment object updated. Note that internal IDs are returned for all entities, including sub-shipments associated with the DTP shipment. |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Update Shipments
The following type of shipments are supported can be created via the Shipments API:
- Standard Shipments
- Parcel Shipments
- Composite Shipments
- DTP Shipments
Update Standard Shipment
This section describes how standard shipments are updated in ParkourSC:
Update Standard Shipments Request
PUT $baseURL/api/2/shipment/standard/{{externalId}}?entityTypeKey=standardshipment
{
"name": "Shipment-123",
"directToResidence": true or false, // Default is false
"assets": [
{
"externalId": {{asset external id}},
"entityTypeKey": {{asset type}}
}
],
"direction": "Outbound",
"plannedDeparture": 1674639169248,
"plannedArrival": 1674639529248,
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"organizationName": {{organization name}},
"sensorProfile": "RahulTest",
"modeOfTransport": "Air",
"notes": "This is first shipment",
"orderNum": "ORD1234",
"shipperName": "Shipment Corp",
"custName": "Mr. Alexey",
"custCode": "Cust001",
"ruleSetName": {{rule name}},
"recipientName": "Mr. Sereda",
"mawb": "AWB000123",
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
externalId |
Path | true | External ID for standard shipment to be updated |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Update Standard Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| assets | true | string | Replaces all assets that are part of the shipment with all provided in this arraycarrierAssetType and externalId for the entity
|
| direction | true | string | Updates direction with one of the following values:
|
| plannedDeparture | true | numeric | Updates plannedDeparture with value provided. Must be in milliseconds format |
| plannedArrival | true | numeric | Updates plannedArrival with value provided
|
| route | true | string | Updates route associated with shipment with value provided
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
| sensorProfile | false | string | Updates sensorProfile associated with the shipment with value provided
|
| modeOfTransport | false | string | Updates Mode of Transport with one of the valid values:
|
| notes | false | string | Replaces notes for the shipment with value provided |
| orderNum | false | string | Updates order number for the shipment with value provided |
| shipperName | false | string | Updates name of shipper with value provided |
| custName | false | string | Updates Customer name with value provided |
| custCode | false | string | Updates Customer code with value provided |
| ruleSetName | false | string | Replaces rule set associated with shipment with value provided Existing rule sets can be found using the search API
|
| recipientName | false | string | Updates **Name of Recipient with value provided for the shipment |
| mawb | false | string | Updates Master Airway Bill Number (MAWB) with value provided for the shipment |
| postingDate | false | string | Date and time the updated shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Update Standard Shipments
{
"type": "standardshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"baseType": "standardshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"notes": "",
"modifiedAt": "1674638840512",
"ruleSet": "",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "standardshipment",
"originAreaName": "Area02-2501",
"routeName": "Multi WP Route by Nih 01 ",
"destHidden": false,
"createdAt": "1674638840512",
"assets": [
"975a87ae-ae84-452a-815d-5ad3a199299b"
],
"carrierName": "",
"recipientName": "",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"teststandard1209": "",
"entityType": "Standard Shipment",
"plannedDeparture": "1674638745054",
"shipperName": "",
"tags": "[]",
"route": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"carrierCode": "",
"name": "SShip_Nih_01-2501",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"origin": "Area02-2501",
"destination": "Area06-2501",
"orderNum": "",
"plannedArrival": "1674760245000",
"teststadard0125": "",
"parentEntityType": "standardshipment",
"destinationAreaId": "bfd4b673-488a-4938-8385-028fe4acfcf8",
"custOrdRef": "",
"shipmentType": "Standard",
"originHidden": false,
"routeId": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "975a87ae-ae84-452a-815d-5ad3a199299b",
"baseType": "asset",
"properties": {
"modifiedAt": "1674638736571",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"createdAt": "1674638736571",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/assets.svg",
"modifiedBy": "nihar_trm",
"id": "975a87ae-ae84-452a-815d-5ad3a199299b",
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"externalId": "SSXDC323",
"catalogName": "Asset",
"21NovSatishAttribute1": "default1",
"deleted": "false",
"entityTypeKey": "asset",
"taggedAssetId": "f313e4d5-fb6e-4670-8576-1f7edc66ec13",
"createdBy": "nihar_trm",
"organization": "",
"name": "Asset01-2501",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"category": "asset",
"qrBarCode": "",
"status": "ACTIVE"
},
"locationId": "null",
"toParty": "",
"fromParty": "",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"sTShipTestExAtt01": "",
"21OctSatishEnum": "",
"externalId": "SShip_Nih_01-2501",
"shipmentRouteSegments": "[{\"carrierType\":\"FLIGHT\",\"carrierDeptTime\":0,\"properties\":{\"timeZone\":\"Asia/Kolkata\",\"segmentIndex\":\"0\"},\"segSrcCode\":\"VAPO\",\"segDestCode\":\"VANP\",\"segSrcAreaId\":\"ef7bea98-f568-4837-bc58-81068018d4f3\",\"segDestAreaId\":\"728b9b24-b390-4e4a-9726-78c034ad94d2\"}]",
"custName": "",
"mawb": "",
"custCode": "",
"destinationAreaName": "Area06-2501",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "standardshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "d738cf3a-f1f7-47c6-af27-0d465378d7b6",
"originAreaId": "ef7bea98-f568-4837-bc58-81068018d4f3",
"postingDate":"1674639169248"
},
"locationId": "null",
"toParty": "",
"fromParty": "",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Update Standard Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated standard shipment object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Update Parcel Shipments
This section describes how parcel shipments are updated in ParkourSC via API:
Update Parcel Shipments Request
PUT $baseURL/api/2/shipment/parcel/{{externalId}}?entityTypeKey=parcelshipment
{
"name": "Parcel Shipment-123",
"directToResidence": true or false,
"assets": [
{
"externalId": {{asset external id}},
"entityTypeKey": {{asset type}},
"sensor": {
"sensorId": {{sensor id}},
"entityTypeKey": {{sensor type}}
},
"trackingNumber": "77898"
}
],
"direction": "Outbound",
"plannedDeparture": 1674639169248,
"plannedArrival": 1674639529248,
"carrierCode": "dhl",
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"ruleSetName": {{rule set name}},
"fromAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021",
"toAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021",
"originArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"destinationArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"organizationName": {{organization Name}},
"sensorProfile": {{sensorProfile}},
"modeOfTransport": "Air",
"notes": "This is first shipment",
"orderNum": "ORD1234",
"shipperName": "Shipment Corp",
"custName": "Mr. Alexey",
"custCode": "Cust001",
"recipientName": "Mr. Sereda"
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for parcel shipment to be updated |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Update Parcel Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| assets | true | string | Replaces all assets that are part of the shipment with all provided in this arraycarrierAssetType and externalId for the entity
|
| direction | true | string | Updates direction with one of the following values:
|
| plannedDeparture | true | numeric | Updates plannedDeparture with value provided. Must be in milliseconds format |
| plannedArrival | true | numeric | Updates plannedArrival with value provided
|
| carrierCode | true | string | Updates carrierCode associated with shipment with value provided Additional details for carrier can be obtained using search API
|
| route | true | string | Updates route associated with shipment with value provided
|
| fromAddress | conditionally | string | Updates "fromAddress" associated with shipment with value provided
|
| toAddress | conditionally | string | Updates "toAddress" associated with shipment with value provided
|
| originArea | conditionally | string | Updates originArea associated with shipment with value provided
|
| destinationArea | conditionally | string | Updates destinationArea associated with shipment with value provided
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
| sensorProfile | false | string | Updates sensorProfile associated with the shipment with value provided
|
| modeOfTransport | false | string | Updates modeOfTransport with one of the valid values:
|
| notes | false | string | Replaces notes for the shipment with value provided |
| orderNum | false | string | Updates orderNum for the shipment with value provided |
| shipperName | false | string | Updates shipperName with value provided |
| custName | false | string | Updates custName with value provided |
| custCode | false | string | Updates custCode with value provided |
| ruleSetName | false | string | Replaces ruleSetName associated with shipment with value provided Existing rule sets can be found using the search API
|
| recipientName | false | string | Updates recipientName with value provided for the shipment |
| postingDate | false | string | Date and time the updated shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Update Parcel Shipments
{
"type": "parcelshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"baseType": "parcelshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"2NovSatishAttribute1": "satishDefault1",
"notes": "",
"modifiedAt": "1675773933486",
"ruleSet": "bedf7882-b0cb-4113-bd8d-ee5c86c51a19",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "parcelshipment",
"originAreaName": "BArea101",
"routeName": "Route02-0702",
"destHidden": false,
"createdAt": "1675773933486",
"assets": [
"b6a22bc0-493b-41c4-bfdb-ae37d50be1e5"
],
"carrierName": "FedEx",
"pSattr0207": "",
"recipientName": "",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"entityType": "Parcel Shipment",
"plannedDeparture": "1675708200000",
"trackingNumbers": "14253698",
"shipperName": "",
"tags": "[]",
"route": "5c0a1839-f608-4390-b4c9-1a355545700e",
"27OctSatishAttribute1": "",
"carrierCode": "fedex",
"name": "Starndard Shipment-123",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"21OctSatishAttribute1": "default",
"origin": "BArea101",
"destination": "Area01-0702",
"orderNum": "",
"plannedArrival": "1675794600000",
"parentEntityType": "parcelshipment",
"destinationAreaId": "857d6b7d-519c-4f91-9338-c41314e7d0b6",
"custOrdRef": "",
"shipmentType": "Parcel",
"originHidden": false,
"routeId": "5c0a1839-f608-4390-b4c9-1a355545700e",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"baseType": "asset",
"properties": {
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"modifiedAt": "1675769453591",
"externalId": "BASID03",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"catalogName": "Asset",
"createdAt": "1675769435425",
"21NovSatishAttribute1": "default1",
"deleted": "false",
"entityTypeKey": "asset",
"createdBy": "nihar_trm",
"taggedAssetId": "0cd43273-794d-46ad-a888-4aec0b8c46b3",
"imageURL": "https://s3.amazonaws.com/clf-webapp-storage/1e779185-72b4-4287-afea-2d931017e02d/asset/b6a22bc0-493b-41c4-bfdb-ae37d50be1e5.png",
"name": "BAsset098",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"modifiedBy": "nihar_trm",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"category": "asset",
"qrBarCode": "BASQRC43",
"status": "ACTIVE"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"externalId": "PS01_Nih_0702",
"custName": "",
"custCode": "",
"destinationAreaName": "Area01-0702",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "parcelshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "c9eb3a83-9e2d-420f-a69b-5dd0af72f67a",
"rulesetName": "Nih_RS_for_Asset",
"originAreaId": "9e663359-f5fe-4c9f-a12d-b87a71ccecf1",
"postingDate":"1674639169248"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Update Parcel Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated parcel shipment object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Update Composite Shipment
This section describes how composite shipments are updated in ParkourSC via API:
Update Composite Shipments Request
PUT $baseURL/api/2/shipment/composite/{{externalId}}?entityTypeKey=compositeshipment
{
"name": "Composite Shipment-123",
"subShipments": [ // mandatory
{
"externalId": {{external Id }},
"entityTypeKey": {{shipment type}}
},
{
"externalId": {{external Id }},
"entityTypeKey": {{shipment type}}
}
]
"organizationName": {{organization name}}
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
entityTypeKey |
Request | true | Object type for shipment |
externalId |
Path | true | External Id of composite shipment |
Request Class Model for Update Composite Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| subShipments | true | string | Updates all subShipments with the values provided in the array of subshipments
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
Response Message Example for Update Composite Shipments (WIP - Needs Update!!)
{
"name": "Starndard Shipment-123",
"externalId": {{external Id}},
"subShipments": [ // mandatory
{
"externalId": {{external Id }},
"entityTypeKey": {{shipment type}}
}
]
"organizationName": {{organization name}}
}
Response Messages
Following are the possible Response Messages for Update Composite Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated composite shipment object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Update DTP Shipment
This section describes how DTP shipments are updated in ParkourSC via API:
Update DTP Shipments Request
PUT $baseURL/api/2/shipment/dtp/{{externalId}}?entityTypeKey=dtpshipment
{
"name": "DTPship-05032024121146-Updated",
"directToResidence": true,
"assets": [
{
"externalId": "050320241211462",
"entityTypeKey": "asset",
"trackingNumber": "6382173256541",
"name": "AssetName-050320241211462"
}
],
"direction": "Outbound",
"fromAddress": "235 East 42nd Street, New York, NY 10017, USA",
"toAddress": "609 South Grand Avenue, Los Angeles, CA 90017, USA",
"plannedDeparture": 1709361706876,
"plannedArrival": 1709534506876,
"organizationName": "",
"carrierCode": "fedex",
"sensorProfile": "",
"ruleSetName": "TempExcursionTest",
"modeOfTransport": "Air",
"notes": "This is a Parcel shipment",
"orderNum": "05032024121146",
"shipperName": "",
"custName": "Automation User",
"custCode": "",
"recipientName": "Mr. John Doe"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for parcel shipment to be updated |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Update DTP Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| assets | true | string | Replaces all assets that are part of the shipment with all provided in this arraycarrierAssetType and externalId for the entity
|
| direction | true | string | Updates direction with one of the following values:
|
| plannedDeparture | true | numeric | Updates plannedDeparture with value provided. Must be in milliseconds format |
| plannedArrival | true | numeric | Updates plannedArrival with value provided
|
| carrierCode | true | string | Updates carrierCode associated with shipment with value provided Additional details for carrier can be obtained using search API
|
| route | true | string | Updates route associated with shipment with value provided
|
| fromAddress | conditionally | string | Updates "fromAddress" associated with shipment with value provided
|
| toAddress | conditionally | string | Updates "toAddress" associated with shipment with value provided
|
| originArea | conditionally | string | Updates originArea associated with shipment with value provided
|
| destinationArea | conditionally | string | Updates destinationArea associated with shipment with value provided
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
| sensorProfile | false | string | Updates sensorProfile associated with the shipment with value provided
|
| modeOfTransport | false | string | Updates modeOfTransport with one of the valid values:
|
| notes | false | string | Replaces notes for the shipment with value provided |
| orderNum | false | string | Updates orderNum for the shipment with value provided |
| shipperName | false | string | Updates shipperName with value provided |
| custName | false | string | Updates custName with value provided |
| custCode | false | string | Updates custCode with value provided |
| ruleSetName | false | string | Replaces ruleSetName associated with shipment with value provided Existing rule sets can be found using the search API
|
| recipientName | false | string | Updates recipientName with value provided for the shipment |
| postingDate | false | string | Date and time the updated shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Update DTP Shipments (WIP - Needs Update!!)
{
"type": "dtpshipment",
"tenantId": "bd75e6eb-dc89-498e-8ef8-65da6530693f",
"id": "be0b2f03-231d-4d79-b3a9-da03e1001112",
"baseType": "dtpshipment",
"properties": {
"permalinkFull": "https://test2-share.parkoursc.com/#/eMr2m88QD4L54LAsmcvTx_AC3RAqA2dPCHWZYC51-nlPd9U_hbi1HAtOvhKZ-3HgyVFQCazjDaT4vfSovGutIyYURD7-PoiF9hibQacpy1tQsMQjmF8FJ2lAqdqDuhkSc8I_3F4W6yiajub242JAykTMdLeCuaoK9cwigsxtolM",
"notes": "This is a Parcel shipment",
"modifiedAt": 1709621005441,
"ruleSet": "ed58fe45-b1d4-4a3d-a53d-09abf6857292",
"isDraft": false,
"modeOfTransport": "Air",
"baseClass": "shipment",
"source": "235 East 42nd Street, New York, NY 10017, USA",
"type": "dtpshipment",
"originAreaName": "235 East 42nd Street, New York, NY 10017, USA",
"toAddress": "609 South Grand Avenue, Los Angeles, CA 90017, USA",
"routeName": "235 East 42nd Street, New York, NY 10017, USA-To-609 South Grand Avenue, Los Angeles, CA 90017, USA",
"dynamicRouteLabel": "235 East 42nd Street, New York, NY 10017, USA-To-609 South Grand Avenue, Los Angeles, CA 90017, USA",
"destHidden": true,
"createdAt": 1709620925021,
"assets": "[\"15cca5dc-4b44-466f-b336-14a1c018546f\"]",
"routeExternalId": "235 East 42nd Street, New York, NY 10017, USA_609 South Grand Avenue, Los Angeles, CA 90017, USA",
"carrierName": "FedEx",
"booleantest": "false",
"lastCarrierUpdateAt": "",
"recipientName": "Mr. John Doe",
"id": "be0b2f03-231d-4d79-b3a9-da03e1001112",
"destinationAreaType": "area",
"latestMilestone": "",
"organizationName": "",
"entityType": "DTP Shipment",
"parentEntityTypeKey": "dtpshipment",
"trackingNumbers": "[\"6382173256541\"]",
"plannedDeparture": 1709361706876,
"destinationAreadetails": "{\"id\":\"9365d566-9058-462e-9532-28231adae7cd\",\"externalId\":\"609 South Grand Avenue, Los Angeles, CA 90017, USA\",\"catalogType\":\"area\",\"entityTypeKey\":\"area\",\"name\":\"609 South Grand Avenue, Los Angeles, CA 90017, USA\"}",
"shipperName": "",
"subStatus": "",
"tags": "[]",
"notesModifiedAt": 1709620924000,
"route": "96b01e81-1ade-44af-bdc4-bc2eef38f665",
"carrierCode": "fedex",
"permalinkLimited": "https://test2-share.parkoursc.com/#/eMr2m88QD4L54LAsmcvTx_AC3RAqA2dPCHWZYC51-nlPd9U_hbi1HAtOvhKZ-3HgSlJ13PK5_3-d_M8RtyTKwnjla_4X3ZkQqcWsq6gDJcxq_m4T0oBJ5MgP6MfuREYml8nV9hxztjlRF0ZnbqxtTALI5gT5PcUOsD3P2AGQois",
"name": "DTPship-05032024121146-Updated",
"status": "",
"origin": "235 East 42nd Street, New York, NY 10017, USA",
"destination": "609 South Grand Avenue, Los Angeles, CA 90017, USA",
"orderNum": "05032024121146",
"plannedArrival": 1709534506876,
"parentEntityType": "DTP Shipment",
"destinationAreaId": "9365d566-9058-462e-9532-28231adae7cd",
"custOrdRef": "",
"shipmentType": "dtp",
"baseType": "DTP Shipment",
"originHidden": true,
"routeId": "96b01e81-1ade-44af-bdc4-bc2eef38f665",
"destinationArea": "{}",
"shipmentETA": "",
"tenantName": "rt38tenant",
"ruleSetName": "TempExcursionTest",
"originAreadetails": "{\"id\":\"665c2db4-8f4c-4272-a060-1119dc77fb66\",\"externalId\":\"235 East 42nd Street, New York, NY 10017, USA\",\"catalogType\":\"area\",\"entityTypeKey\":\"area\",\"name\":\"235 East 42nd Street, New York, NY 10017, USA\"}",
"assetDtos": "[{\"externalId\":\"050320241211462\",\"name\":\"AssetName-050320241211462\",\"catalogType\":\"asset\",\"entityTypeKey\":\"asset\",\"trackingNumber\":\"6382173256541\"}]",
"modifiedBy": "rt38auto",
"fromAddress": "235 East 42nd Street, New York, NY 10017, USA",
"originAreaType": "area",
"directToResidence": true,
"routeType": "route",
"direction": "Outbound",
"baseTypeKey": "dtpshipment",
"sensorProfile": "",
"eURL": "https://rtt11-share.qopper.com/#/eMr2m88QD4L54LAsmcvTx_AC3RAqA2dPCHWZYC51-nlPd9U_hbi1HAtOvhKZ-3HgyVFQCazjDaT4vfSovGutIyYURD7-PoiF9hibQacpy1tQsMQjmF8FJ2lAqdqDuhkSc8I_3F4W6yiajub242JAykTMdLeCuaoK9cwigsxtolM",
"externalId": "05032024121146",
"chExtDefault": "",
"custName": "Automation User",
"custCode": "",
"notesModifiedBy": "rt38auto",
"destinationAreaName": "609 South Grand Avenue, Los Angeles, CA 90017, USA",
"chExtDTP": "",
"chExtSensitive": "",
"deleted": false,
"routeHidden": true,
"stage": "",
"entityTypeKey": "dtpshipment",
"createdBy": "rt38auto",
"organization": "",
"tenantId": "bd75e6eb-dc89-498e-8ef8-65da6530693f",
"entityTypeId": "89b2c07f-22fd-4e6e-9414-3d6e02b46d5c",
"originArea": "{}",
"originAreaId": "665c2db4-8f4c-4272-a060-1119dc77fb66"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Update DTP Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated DTP shipment object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Patch Shipments
The PATCH method of the shipment API is used to update any shipment, regardless of shipment type, as long as it is identified by the shipment's External ID. PATCH shipment method only supports patching the following shipment types:
- Standard Shipments
- Parcel Shipments
- DTP Shipments
Patch Standard Shipments
This section describes how standard shipments are patched in ParkourSC:
Patch Standard Shipments Request
PATCH $baseURL/api/2/shipment/standard/{{externalId}}?entityTypeKey=standardshipment
"name": "Shipment-123",
"directToResidence": true or false, // Default is false
"direction": "Outbound",
"plannedDeparture": "1674639169248",
"plannedArrival": "1674639529248",
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"organizationName": {{organization name}},
"sensorProfile": "RahulTest",
"modeOfTransport": "Air",
"notes": "This is first shipment",
"orderNum": "ORD1234",
"shipperName": "Shipment Corp",
"custName": "Mr. Alexey",
"custCode": "Cust001",
"ruleSetName": {{rule name}},
"recipientName": "Mr. Sereda",
"mawb": "AWB000123"
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
externalId |
Path | true | External ID for standard shipment to be updated |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Patch Standard Shipments
- Note that request body for PATCH includes only the fields that need to be patched
- External ID cannot be updated
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| direction | true | string | Updates direction with one of the following values:
|
| plannedDeparture | true | numeric | Updates plannedDeparture with value provided. Must be in milliseconds format |
| plannedArrival | true | numeric | Updates plannedArrival with value provided
|
| route | true | string | Updates route associated with shipment with value provided
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
| sensorProfile | false | string | Updates sensorProfile associated with the shipment with value provided
|
| modeOfTransport | false | string | Updates Mode of Transport with one of the valid values:
|
| notes | false | string | Replaces notes for the shipment with value provided |
| orderNum | false | string | Updates order number for the shipment with value provided |
| shipperName | false | string | Updates name of shipper with value provided |
| custName | false | string | Updates Customer name with value provided |
| custCode | false | string | Updates Customer code with value provided |
| ruleSetName | false | string | Replaces rule set associated with shipment with value provided Existing rule sets can be found using the search API
|
| recipientName | false | string | Updates **Name of Recipient with value provided for the shipment |
| mawb | false | string | Updates Master Airway Bill Number (MAWB) with value provided for the shipment |
| postingDate | false | string | Date and time the updated shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Patch Standard Shipments
{
"type": "standardshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"baseType": "standardshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"notes": "",
"modifiedAt": "1674638840512",
"ruleSet": "",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "standardshipment",
"originAreaName": "Area02-2501",
"routeName": "Multi WP Route by Nih 01 ",
"destHidden": false,
"createdAt": "1674638840512",
"assets": [
"975a87ae-ae84-452a-815d-5ad3a199299b"
],
"carrierName": "",
"recipientName": "",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"teststandard1209": "",
"entityType": "Standard Shipment",
"plannedDeparture": "1674638745054",
"shipperName": "",
"tags": "[]",
"route": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"carrierCode": "",
"name": "SShip_Nih_01-2501",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"origin": "Area02-2501",
"destination": "Area06-2501",
"orderNum": "",
"plannedArrival": "1674760245000",
"teststadard0125": "",
"parentEntityType": "standardshipment",
"destinationAreaId": "bfd4b673-488a-4938-8385-028fe4acfcf8",
"custOrdRef": "",
"shipmentType": "Standard",
"originHidden": false,
"routeId": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "975a87ae-ae84-452a-815d-5ad3a199299b",
"baseType": "asset",
"properties": {
"modifiedAt": "1674638736571",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"createdAt": "1674638736571",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/assets.svg",
"modifiedBy": "nihar_trm",
"id": "975a87ae-ae84-452a-815d-5ad3a199299b",
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"externalId": "SSXDC323",
"catalogName": "Asset",
"21NovSatishAttribute1": "default1",
"deleted": "false",
"entityTypeKey": "asset",
"taggedAssetId": "f313e4d5-fb6e-4670-8576-1f7edc66ec13",
"createdBy": "nihar_trm",
"organization": "",
"name": "Asset01-2501",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"category": "asset",
"qrBarCode": "",
"status": "ACTIVE"
},
"locationId": "null",
"toParty": "",
"fromParty": "",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"sTShipTestExAtt01": "",
"21OctSatishEnum": "",
"externalId": "SShip_Nih_01-2501",
"shipmentRouteSegments": "[{\"carrierType\":\"FLIGHT\",\"carrierDeptTime\":0,\"properties\":{\"timeZone\":\"Asia/Kolkata\",\"segmentIndex\":\"0\"},\"segSrcCode\":\"VAPO\",\"segDestCode\":\"VANP\",\"segSrcAreaId\":\"ef7bea98-f568-4837-bc58-81068018d4f3\",\"segDestAreaId\":\"728b9b24-b390-4e4a-9726-78c034ad94d2\"}]",
"custName": "",
"mawb": "",
"custCode": "",
"destinationAreaName": "Area06-2501",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "standardshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "d738cf3a-f1f7-47c6-af27-0d465378d7b6",
"originAreaId": "ef7bea98-f568-4837-bc58-81068018d4f3",
"postingDate":"1674639169248"
},
"locationId": "null",
"toParty": "",
"fromParty": "",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Patch Standard Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated standard shipments object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Patch Parcel Shipments
This section describes how parcel shipments are patched in ParkourSC:
Patch Parcel Shipments Request
PATCH $baseURL/api/2/shipment/parcel/{{externalId}}?entityTypeKey=parcelshipment
{
"name": "Parcel Shipment-123",
"directToResidence": true or false,
"direction": "Outbound",
"plannedDeparture": "1674639169248",
"plannedArrival": "1674639529248",
"carrierCode": "dhl",
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"ruleSetName": {{rule set name}},
"fromAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021",
"toAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021",
"originArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"destinationArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"organizationName": {{organization Name}},
"sensorProfile": {{sensorProfile}},
"modeOfTransport": "Air",
"notes": "This is first shipment",
"orderNum": "ORD1234",
"shipperName": "Shipment Corp",
"custName": "Mr. Alexey",
"custCode": "Cust001",
"recipientName": "Mr. Sereda"
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for parcel shipment to be updated |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Patch Parcel Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| direction | true | string | Updates direction with one of the following values:
|
| plannedDeparture | true | numeric | Updates plannedDeparture with value provided. Must be in milliseconds format |
| plannedArrival | true | numeric | Updates plannedArrival with value provided
|
| carrierCode | true | string | Updates carrierCode associated with shipment with value provided Additional details for carrier can be obtained using search API
|
| route | true | string | Updates route associated with shipment with value provided
|
| fromAddress | conditionally | string | Updates "fromAddress" associated with shipment with value provided
|
| toAddress | conditionally | string | Updates "toAddress" associated with shipment with value provided
|
| originArea | conditionally | string | Updates originArea associated with shipment with value provided
|
| destinationArea | conditionally | string | Updates destinationArea associated with shipment with value provided
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
| sensorProfile | false | string | Updates sensorProfile associated with the shipment with value provided
|
| modeOfTransport | false | string | Updates modeOfTransport with one of the valid values:
|
| notes | false | string | Replaces notes for the shipment with value provided |
| orderNum | false | string | Updates orderNum for the shipment with value provided |
| shipperName | false | string | Updates shipperName with value provided |
| custName | false | string | Updates custName with value provided |
| custCode | false | string | Updates custCode with value provided |
| ruleSetName | false | string | Replaces ruleSetName associated with shipment with value provided Existing rule sets can be found using the search API
|
| recipientName | false | string | Updates recipientName with value provided for the shipment |
| postingDate | false | string | Date and time the updated shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Patch Parcel Shipments
{
"type": "parcelshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"baseType": "parcelshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"2NovSatishAttribute1": "satishDefault1",
"notes": "",
"modifiedAt": "1675773933486",
"ruleSet": "bedf7882-b0cb-4113-bd8d-ee5c86c51a19",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "parcelshipment",
"originAreaName": "BArea101",
"routeName": "Route02-0702",
"destHidden": false,
"createdAt": "1675773933486",
"assets": [
"b6a22bc0-493b-41c4-bfdb-ae37d50be1e5"
],
"carrierName": "FedEx",
"pSattr0207": "",
"recipientName": "",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"entityType": "Parcel Shipment",
"plannedDeparture": "1675708200000",
"trackingNumbers": "14253698",
"shipperName": "",
"tags": "[]",
"route": "5c0a1839-f608-4390-b4c9-1a355545700e",
"27OctSatishAttribute1": "",
"carrierCode": "fedex",
"name": "Starndard Shipment-123",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"21OctSatishAttribute1": "default",
"origin": "BArea101",
"destination": "Area01-0702",
"orderNum": "",
"plannedArrival": "1675794600000",
"parentEntityType": "parcelshipment",
"destinationAreaId": "857d6b7d-519c-4f91-9338-c41314e7d0b6",
"custOrdRef": "",
"shipmentType": "Parcel",
"originHidden": false,
"routeId": "5c0a1839-f608-4390-b4c9-1a355545700e",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"baseType": "asset",
"properties": {
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"modifiedAt": "1675769453591",
"externalId": "BASID03",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"catalogName": "Asset",
"createdAt": "1675769435425",
"21NovSatishAttribute1": "default1",
"deleted": "false",
"entityTypeKey": "asset",
"createdBy": "nihar_trm",
"taggedAssetId": "0cd43273-794d-46ad-a888-4aec0b8c46b3",
"imageURL": "https://s3.amazonaws.com/clf-webapp-storage/1e779185-72b4-4287-afea-2d931017e02d/asset/b6a22bc0-493b-41c4-bfdb-ae37d50be1e5.png",
"name": "BAsset098",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"modifiedBy": "nihar_trm",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"category": "asset",
"qrBarCode": "BASQRC43",
"status": "ACTIVE"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"externalId": "PS01_Nih_0702",
"custName": "",
"custCode": "",
"destinationAreaName": "Area01-0702",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "parcelshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "c9eb3a83-9e2d-420f-a69b-5dd0af72f67a",
"rulesetName": "Nih_RS_for_Asset",
"originAreaId": "9e663359-f5fe-4c9f-a12d-b87a71ccecf1",
"postingDate":"1674639169248"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Patch Parcel Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated parcel shipments object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Patch DTP Shipments
This section describes how DTP shipments are patched in ParkourSC:
Patch DTP Shipments Request
PATCH $baseURL/api/2/shipment/dtp/{{externalId}}?entityTypeKey=dtpshipment
{
"name": "DTP Shipment-123",
"directToResidence": true or false,
"direction": "Outbound",
"plannedDeparture": "1674639169248",
"plannedArrival": "1674639529248",
"carrierCode": "dhl",
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"ruleSetName": {{rule set name}},
"fromAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021",
"toAddress": "Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021",
"originArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"destinationArea": {
"name": {{area name}},
"entityTypeKey": {{area type}}
},
"organizationName": {{organization Name}},
"sensorProfile": {{sensorProfile}},
"modeOfTransport": "Air",
"notes": "This is first shipment",
"orderNum": "ORD1234",
"shipperName": "Shipment Corp",
"custName": "Mr. Alexey",
"custCode": "Cust001",
"recipientName": "Mr. Sereda"
// Extended attributes can be added as follows in "key-value" format: ("<Config Key>": "<value>").
// Note that key must match the Config Key of the extended attribute defined in the system under the Catalog.
// Following are examples of extended attributes:
"shipperNumber": "7483619590",
"jobNumber": "JN1789463892"
}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for DTP shipment to be updated |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Patch DTP Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| name | true | string | Unique external name for the shipment
|
| externalId | false | string | External ID is a unique external identifier provided by external system
|
| directToResidence | true | boolean | Valid values are true or false. Default is false. |
| direction | true | string | Updates direction with one of the following values:
|
| plannedDeparture | true | numeric | Updates plannedDeparture with value provided. Must be in milliseconds format |
| plannedArrival | true | numeric | Updates plannedArrival with value provided
|
| carrierCode | true | string | Updates carrierCode associated with shipment with value provided Additional details for carrier can be obtained using search API
|
| route | true | string | Updates route associated with shipment with value provided
|
| fromAddress | conditionally | string | Updates "fromAddress" associated with shipment with value provided
|
| toAddress | conditionally | string | Updates "toAddress" associated with shipment with value provided
|
| originArea | conditionally | string | Updates originArea associated with shipment with value provided
|
| destinationArea | conditionally | string | Updates destinationArea associated with shipment with value provided
|
| organizationName | false | string | Updates organizationName (unique external ID) with value provided
|
| sensorProfile | false | string | Updates sensorProfile associated with the shipment with value provided
|
| modeOfTransport | false | string | Updates modeOfTransport with one of the valid values:
|
| notes | false | string | Replaces notes for the shipment with value provided |
| orderNum | false | string | Updates orderNum for the shipment with value provided |
| shipperName | false | string | Updates shipperName with value provided |
| custName | false | string | Updates custName with value provided |
| custCode | false | string | Updates custCode with value provided |
| ruleSetName | false | string | Replaces ruleSetName associated with shipment with value provided Existing rule sets can be found using the search API
|
| recipientName | false | string | Updates recipientName with value provided for the shipment |
| postingDate | false | string | Date and time the updated shipment data was extracted from the external system. Must be in milliseconds format |
Response Message Example for Patch DTP Shipments
{
"type": "dtpshipment",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"baseType": "dtpshipment",
"properties": {
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"2NovSatishAttribute1": "satishDefault1",
"notes": "",
"modifiedAt": "1675773933486",
"ruleSet": "bedf7882-b0cb-4113-bd8d-ee5c86c51a19",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "dtpshipment",
"originAreaName": "BArea101",
"routeName": "Route02-0702",
"destHidden": false,
"createdAt": "1675773933486",
"assets": [
"b6a22bc0-493b-41c4-bfdb-ae37d50be1e5"
],
"carrierName": "FedEx",
"pSattr0207": "",
"recipientName": "",
"id": "266ff0e7-7284-4ed6-b831-0772079de138",
"entityType": "Dtp Shipment",
"plannedDeparture": "1675708200000",
"trackingNumbers": "14253698",
"shipperName": "",
"tags": "[]",
"route": "5c0a1839-f608-4390-b4c9-1a355545700e",
"27OctSatishAttribute1": "",
"carrierCode": "fedex",
"name": "DTP Shipment-123",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/QM4m7Rj5iCpqlYb9-H_4o6vi-yLjWi3xf0BhtBtAu-aaTkq7zXvG9_-eW0jUoEfwUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"21OctSatishAttribute1": "default",
"origin": "BArea101",
"destination": "Area01-0702",
"orderNum": "",
"plannedArrival": "1675794600000",
"parentEntityType": "dtpshipment",
"destinationAreaId": "857d6b7d-519c-4f91-9338-c41314e7d0b6",
"custOrdRef": "",
"shipmentType": "Dtp",
"originHidden": false,
"routeId": "5c0a1839-f608-4390-b4c9-1a355545700e",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"assetNodes": [
{
"type": "asset",
"graphType": "Node",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"baseType": "asset",
"properties": {
"monitoredStatus": "UNMONITORED",
"entityType": "Asset",
"modifiedAt": "1675769453591",
"externalId": "BASID03",
"baseClass": "asset",
"parentEntityType": "asset",
"type": "Asset",
"catalogName": "Asset",
"createdAt": "1675769435425",
"21NovSatishAttribute1": "default1",
"deleted": "false",
"entityTypeKey": "asset",
"createdBy": "nihar_trm",
"taggedAssetId": "0cd43273-794d-46ad-a888-4aec0b8c46b3",
"imageURL": "https://s3.amazonaws.com/clf-webapp-storage/1e779185-72b4-4287-afea-2d931017e02d/asset/b6a22bc0-493b-41c4-bfdb-ae37d50be1e5.png",
"name": "BAsset098",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"typeId": "50a48478-8da6-4163-958a-d2e18bb53497",
"modifiedBy": "nihar_trm",
"id": "b6a22bc0-493b-41c4-bfdb-ae37d50be1e5",
"category": "asset",
"qrBarCode": "BASQRC43",
"status": "ACTIVE"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
],
"direction": "Outbound",
"sensorProfile": "",
"externalId": "D01_Nih_0702",
"custName": "",
"custCode": "",
"destinationAreaName": "Area01-0702",
"removedAssets": [],
"deleted": "false",
"entityTypeKey": "dtpshipment",
"routeHidden": false,
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "c9eb3a83-9e2d-420f-a69b-5dd0af72f67a",
"rulesetName": "Nih_RS_for_Asset",
"originAreaId": "9e663359-f5fe-4c9f-a12d-b87a71ccecf1",
"postingDate":"1674639169248"
},
"toParty": "",
"fromParty": "",
"locationId": "null",
"organization": ""
}
Response Messages
Following are the possible Response Messages for Patch DTP Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns the updated DTP shipments object. Note that internal IDs are returned for all entities associated with the shipment. (e.g. Assets, Route, etc.) |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Delete Shipments
The DELETE method of the shipment API is used to delete any shipment, regardless of shipment type, as long as it is identified by the shipment's External ID. DELETE shipments method only supports deleting the following shipment types:
- Standard Shipments
- Parcel Shipments
- DTP Shipments
Delete Shipments using External ID
This section describes how standard and parcel shipments are deleted in ParkourSC:
Delete Shipments Request
DELETE $baseURL/api/2/shipment/{{externalId}}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for standard or parcel shipment to be deleted |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Delete Shipments
Not Applicable
Response Messages
Following are the possible Response Messages for Delete Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Successfully Deleted | |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Delete Composite Shipments using External ID
This section describes how composite shipments are deleted in ParkourSC:
Delete Composite Shipments Request
DELETE $baseURL/api/2/shipment/composite/{{externalId}}
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for composite shipment to be deleted |
entityTypeKey |
Request | true | Object type for shipment |
Request Class Model for Delete Composite Shipments
Not Applicable
Response Messages
Following are the possible Response Messages for Delete Composite Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Successfully Deleted | |
400 |
Invalid Data | Response returns invalid data element. |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Get Shipment Details
The GET Shipment Details method of the shipment API is used to get all the details for a particular shipment using the shipment's External ID. GET shipment details supports the following shipment types:
- Standard Shipments
- Parcel Shipments
- Composite Shipments
Get Standard Shipment Details
This section describes how standard shipment details are fetched in ParkourSC using the shipment's External ID
Get Standard Shipment Details Request
GET $baseURL/api/2/shipment/{{externalId}}
Response Message Example for Get Standard Shipment Details?entityTypeKey=standardshipment
{
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"notes": "",
"modifiedAt": "1674638842498",
"ruleSet": "",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "standardshipment",
"originAreaName": "Area02-2501",
"routeName": "Multi WP Route by Nih 01 ",
"destHidden": false,
"createdAt": "1674638840512",
"carrierName": "",
"recipientName": "",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"teststandard1209": "",
"organizationName": "",
"entityType": "Standard Shipment",
"plannedDeparture": "1674638745054",
"shipperName": "",
"tags": [],
"carrierCode": "",
"name": "SShip_Nih_01-2501",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"statusCode": "Planned",
"origin": "Area02-2501",
"destination": "Area06-2501",
"orderNum": "",
"plannedArrival": "1674760245000",
"teststadard0125": "",
"parentEntityType": "standardshipment",
"destinationAreaId": "bfd4b673-488a-4938-8385-028fe4acfcf8",
"custOrdRef": "",
"shipmentType": "Standard",
"originHidden": false,
"routeId": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"direction": "Outbound",
"sensorProfile": "",
"sTShipTestExAtt01": "",
"21OctSatishEnum": "",
"externalId": "SShip_Nih_01-2501",
"shipmentRouteSegments": "[{\"carrierType\":\"FLIGHT\",\"carrierDeptTime\":0,\"properties\":{\"timeZone\":\"Asia/Kolkata\",\"segmentIndex\":\"0\"},\"segSrcCode\":\"VAPO\",\"segDestCode\":\"VANP\",\"segSrcAreaId\":\"ef7bea98-f568-4837-bc58-81068018d4f3\",\"segDestAreaId\":\"728b9b24-b390-4e4a-9726-78c034ad94d2\"}]",
"statusWithAssetCount": "Planned (1/1)",
"custName": "",
"mawb": "",
"custCode": "",
"destinationAreaName": "Area06-2501",
"deleted": "false",
"entityTypeKey": "standardshipment",
"routeHidden": false,
"subStatusCode": "Planned",
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "d738cf3a-f1f7-47c6-af27-0d465378d7b6",
"originAreaId": "ef7bea98-f568-4837-bc58-81068018d4f3",
"assets": [
{
"externalId": {{asset external id}},
"entityTypeKey": {{asset type}},
"sensor": {
"sensorId": {{sensor id}},
"entityTypeKey": {{asset type}}
},
"trackingNumber": "77898"
}
],
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"originArea": {
"externalId": {{area external id}},
"entityTypeKey": {{area type}}
},
"destinationArea": {
"externalId": {{area external id}},
"entityTypeKey": {{area type}}
},
"ruleSetName": {{rule set name}}
}
This API returns detailed information of standard shipment identified by the shipment's External ID using the GET method.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for composite shipment to be deleted |
entityTypeKey |
Request | true | Object type for shipment |
Response Messages
Following are the possible Response Messages for Get Standard Shipment Details:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Details Successfully Retrieved | |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Get Parcel Shipment Details
This section describes how parcel shipment details are fetched in ParkourSC using the shipment's External ID
Get Parcel Shipment Details Request
GET $baseURL/api/2/shipment/{{externalId}}?entityTypeKey=parcelshipment
Response Message Example for Get Parcel Shipment Details
{
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"notes": "",
"modifiedAt": "1674638842498",
"ruleSet": "",
"isDraft": false,
"modeOfTransport": "",
"baseClass": "shipment",
"type": "standardshipment",
"originAreaName": "Area02-2501",
"routeName": "Multi WP Route by Nih 01 ",
"destHidden": false,
"createdAt": "1674638840512",
"carrierName": "",
"recipientName": "",
"id": "ee96d8ca-7b99-48e6-bbd2-824cb11a83b6",
"teststandard1209": "",
"organizationName": "",
"entityType": "Standard Shipment",
"plannedDeparture": "1674638745054",
"shipperName": "",
"tags": [],
"carrierCode": "",
"name": "SShip_Nih_01-2501",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/5wgDRYRo_qVB_Cw-l5mo7ewIBwtZit0ycC4PmtKy-CTrtozRkoVRI5IwUvp90NfrUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"classType": "",
"statusCode": "Planned",
"origin": "Area02-2501",
"destination": "Area06-2501",
"orderNum": "",
"plannedArrival": "1674760245000",
"teststadard0125": "",
"parentEntityType": "standardshipment",
"destinationAreaId": "bfd4b673-488a-4938-8385-028fe4acfcf8",
"custOrdRef": "",
"shipmentType": "Standard",
"originHidden": false,
"routeId": "fc6bdf38-f3f7-4e7f-b3d9-a2c49fd0c2f2",
"tenantName": "rt35parent",
"modifiedBy": "nihar_trm",
"directToResidence": false,
"direction": "Outbound",
"sensorProfile": "",
"sTShipTestExAtt01": "",
"21OctSatishEnum": "",
"externalId": "SShip_Nih_01-2501",
"shipmentRouteSegments": "[{\"carrierType\":\"FLIGHT\",\"carrierDeptTime\":0,\"properties\":{\"timeZone\":\"Asia/Kolkata\",\"segmentIndex\":\"0\"},\"segSrcCode\":\"VAPO\",\"segDestCode\":\"VANP\",\"segSrcAreaId\":\"ef7bea98-f568-4837-bc58-81068018d4f3\",\"segDestAreaId\":\"728b9b24-b390-4e4a-9726-78c034ad94d2\"}]",
"statusWithAssetCount": "Planned (1/1)",
"custName": "",
"mawb": "",
"custCode": "",
"destinationAreaName": "Area06-2501",
"deleted": "false",
"entityTypeKey": "standardshipment",
"routeHidden": false,
"subStatusCode": "Planned",
"createdBy": "nihar_trm",
"organization": "",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "d738cf3a-f1f7-47c6-af27-0d465378d7b6",
"originAreaId": "ef7bea98-f568-4837-bc58-81068018d4f3",
"assets": [
{
"externalId": {{asset external id}},
"entityTypeKey": {{asset type}},
"sensor": {
"sensorId": {{sensor id}},
"entityTypeKey": {{asset type}}
},
"trackingNumber": "77898"
}
],
"route": {
"externalId": {{route external id}},
"entityTypeKey": {{route type}}
},
"originArea": {
"externalId": {{area external id}},
"entityTypeKey": {{area type}}
},
"destinationArea": {
"externalId": {{area external id}},
"entityTypeKey": {{area type}}
},
"ruleSetName": {{rule set name}}
}
This API returns detailed information of the parcel shipment identified by the shipment's External ID using the GET method.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External ID for composite shipment to be deleted |
entityTypeKey |
Request | true | Object type for shipment |
Response Messages
Following are the possible Response Messages for Get Parcel Shipment Details:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Details Successfully Retrieved | |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Get Composite Shipment Details
This section describes how composite shipment details are retrieved in ParkourSC using the shipment's External ID
Get Composite Shipment Details Request
GET $baseURL/api/2/shipment/composite/{{Id}}?entityTypeKey=compositeshipment
Response Message Example for Get Composite Shipment Details
{
"subShipmentIds": "[\"2ecdb7f4-2b92-4f9c-a399-5be6986e72f2\",\"53f2c775-b015-4860-97c0-4c28c5898f84\"]",
"entityType": "Composite Shipment",
"modifiedAt": 1676288222975,
"origin": "Fergusson",
"destination": "VREC",
"externalId": "skFetb13-Composite07",
"baseClass": "shipment",
"parentEntityType": "compositeshipment",
"type": "compositeshipment",
"subShipments": [
{
"subStatusCode": "ReadyToShip",
"name": "skfeb12-Std02",
"externalId": "skfeb12-Std03",
"type": "parcelshipment",
"statusWithAssetCount": "ReadyToShip (1/1)",
"id": "2ecdb7f4-2b92-4f9c-a399-5be6986e72f2",
"originAreaName": "Fergusson Pune",
"destinationAreaName": "VREC Indur"
},
{
"subStatusCode": "ReadyToShip",
"name": "skFeb12-Std04",
"externalId": "skFeb12-Std04",
"type": "standardshipment",
"statusWithAssetCount": "ReadyToShip (1/1)",
"id": "53f2c775-b015-4860-97c0-4c28c5898f84",
"originAreaName": "Fergusson Pune",
"destinationAreaName": "VREC Indur"
}
],
"duration": null,
"createdAt": 1676288222975,
"deleted": "",
"entityTypeKey": "compositeshipment",
"createdBy": "arun2022",
"organizationName": "",
"tenantId": "9bff5165-63cd-4b3e-9959-b5cb3fde6991",
"tenantName": "",
"name": "skFetb13-Composite07",
"entityTypeId": "b786b955-9c57-4ee5-8fd6-09919baccb18",
"modifiedBy": "arun2022",
"id": "1634519f-17af-498b-83d0-686b6302f007",
"postingDate": 1676288222975
}
This API returns detailed information of the composite shipment identified by the shipment's External ID using the GET method.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
isExternalId |
Header | false | This must be provided, if the {{Id}} passed is the external ID. Valid values are true or false |
Id |
Path | true | Id identifying the composite shipment. Accepts both internal and external IDs for composite shipment. Use isExternalId parameter set to true when passing External ID |
entityTypeKey |
Request | true | Object type for shipment |
Response Messages
Following are the possible Response Messages for Get Composite Shipment Details:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Details Successfully Retrieved | |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
Get List of Shipments
This section describes how a list of all shipments retrieved in ParkourSC using the Search API. This API allows to apply filters and page through the list.
Get List of Shipments Request Example
POST $baseURL/api/2/search
{
{
"globalQueryText": "",
"match": "must",
"scrollId": "",
"scrollSize": 50,
"searchQueries": [
{
"fieldName": "baseClass",
"queryText": "shipment",
"queryOperator": "should",
"queryType": "match",
"childFilters": [
{
"fieldName": "deleted",
"queryText": "true",
"queryOperator": "must_not"
},
{
"fieldName": "statusCode",
"queryOperator": "must",
"queryText": "At Destination,Drafts,In-Transit,Planned,Ready to Ship,Exception,Incomplete,Pending"
}
]
}
]
}
The Get List of Shipments API returns a list of shipments based on query operators and query filters. Results can be narrowed using the "outFields" field to pass required field names. Please refer to Entity Search API to get detailed information on how to use the Entity API.
Path, Header and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Message Example for Get List of Shipments
{
"_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAn0b0WdjRfb05TSmtRUXU3aFNiaDBGYWV4UQ==",
"hits": [
{
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/uyOpM_KKMlO1byyCe6yYQm6mXQzqrOyLAeCUYJvYesYa4KTCbVfF47iyFWHITtQ2mK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"2NovSatishAttribute1": "satishDefault1",
"modifiedAt": 1675989950305,
"ruleSet": "bc21cc0f-92f0-490d-94cb-8aae6d225422",
"isDraft": "false",
"baseClass": "shipment",
"type": "parcelshipment",
"originAreaName": "OriginArea-913510",
"excursionOccourred": "0",
"routeName": "AutomationRoute-913510",
"destHidden": "false",
"createdAt": "1675989882713",
"assets": [
"a7e486ac-18bf-4b34-b363-41bf0705173f"
],
"carrierName": "FedEx",
"clfMappingType": "parcelshipment",
"lastCarrierUpdateAt": 1669655340000,
"id": "6006184e-82f9-4bf0-bae0-0b6e4853d6ad",
"entityType": "Parcel Shipment",
"plannedDeparture": "1675989879166",
"trackingNumbers": "71743559",
"tags": [
{
"name": "RamPTag1",
"id": "2f20e35a-30a3-42cb-8653-576112f55a02"
}
],
"excursionAtOrigin": "0",
"excursionAtIntransit": "0",
"route": "069a7945-176b-4bbc-ae1a-d34be54fcf50",
"carrierCode": "fedex",
"name": "AutoPShip-909111042097-10Feb2023-000216",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/uyOpM_KKMlO1byyCe6yYQm6mXQzqrOyLAeCUYJvYesYa4KTCbVfF47iyFWHITtQ2UQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"excursions": [],
"position": {
"lon": -84.408275,
"lat": 39.3303357
},
"21OctSatishAttribute1": "default",
"statusCode": "At Destination",
"actualDepTime": "1669222489000",
"origin": "OriginArea-913510",
"mileStoneMessage": "Delivered",
"destination": "DestinationArea-913510",
"plannedArrival": "1675999479166",
"parentEntityType": "parcelshipment",
"mileStoneSubMileStone": "Delivered-Delivered",
"destinationAreaId": "65bd0176-6f52-423c-8ffa-25ef233c23dd",
"shipmentType": "Parcel",
"originHidden": "false",
"routeId": "069a7945-176b-4bbc-ae1a-d34be54fcf50",
"tenantName": "rt35parent",
"modifiedBy": "rameshqaproddvp2",
"directToResidence": false,
"direction": "Outbound",
"externalId": "AutoPShip-909111042097-10Feb2023-000216",
"statusWithAssetCount": "At Destination (1/1)",
"destinationAreaName": "DestinationArea-913510",
"deleted": "false",
"entityTypeKey": "parcelshipment",
"routeHidden": "false",
"subStatusCode": "AtDestination",
"createdBy": "rameshqaproddvp2",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"actualArrivalTime": "1669655340000",
"entityTypeId": "c9eb3a83-9e2d-420f-a69b-5dd0af72f67a",
"rulesetName": "AutoRuleSet-913510",
"originAreaId": "96778355-e184-442d-8e00-b23a8a475002",
"excursionAtDestination": "0"
},
{
"permalinkFull": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/V8yJlO4JGx-e3FyjL73bpzIqxNqysDw7zlCdvDejPnA_xjcyXjHjhMavgRJFEbSfmK1iVfpedhQrJyaHzFwFVAV0Feny8XZdIV-obOh3AzZXBzeQJ4NcZIhoyX1ZnzHYC69x5sd8xmrqWCQFWoLfcA",
"modifiedAt": "1675925930953",
"origin": "BulkCustArea02",
"isDraft": "false",
"destination": "25JanBulkArea1",
"plannedArrival": "1678603980000",
"baseClass": "shipment",
"parentEntityType": "standardshipment",
"type": "standardtestshipfeb",
"originAreaName": "BulkCustArea02",
"destinationAreaId": "61b62534-2119-4072-a5ab-f6c4c2b142b0",
"routeName": "routefeb",
"shipmentType": "Standard",
"destHidden": "false",
"createdAt": "1675925930953",
"originHidden": "false",
"assets": [
"795d7d69-06ff-493f-aeec-faf68db9e3de"
],
"routeId": "828d01e4-57b1-459b-b2ac-d5cdd9003e66",
"tenantName": "rt35parent",
"clfMappingType": "standardtestshipfeb",
"modifiedBy": "satishqaproddvp2",
"id": "e5acfe45-a4dd-4a4a-bde5-f0f4bad60bb3",
"directToResidence": false,
"direction": "Outbound",
"entityType": "StandardTestShipFeb",
"plannedDeparture": "1676011980000",
"externalId": "StandardShipFeb9",
"statusWithAssetCount": "Planned (1/1)",
"destinationAreaName": "25JanBulkArea1",
"route": "828d01e4-57b1-459b-b2ac-d5cdd9003e66",
"deleted": "false",
"entityTypeKey": "standardtestshipfeb",
"routeHidden": "false",
"subStatusCode": "Planned",
"createdBy": "satishqaproddvp2",
"name": "StandardShipFeb9",
"permalinkLimited": "https://qaproddvp2-graph.parkoursc.com/clfgraphapp/#/V8yJlO4JGx-e3FyjL73bpzIqxNqysDw7zlCdvDejPnA_xjcyXjHjhMavgRJFEbSfUQ-J2ZJ61ljdI9T9lGL-HQwQ3AUOUvTumDL44as6oBWmNsgjZpQrA-WZlrhaI6kjN_ihEvHWAYcDhWzr6StWxw",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"entityTypeId": "074eac2f-67fc-4211-82c8-05374117e742",
"originAreaId": "32f61f70-b85f-48c6-bd9b-4394fad65755",
"statusCode": "Planned"
}
],
"totalHits": 2
}
Response Messages
Following are the possible Response Messages for Get List of Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Details Successfully Retrieved | |
401 |
Access Denied | |
403 |
Forbidden | |
404 |
Not Found | Resource not found. |
500 |
Internal Server error |
%= partial "sections/api_reference/_dtpshipments.md" %>
Shipment Operations
Version 0.1 - This is a pre-release version of documentation for Shipment APIs. API documentation is subject to change upon release of Shipment APIs
This section covers the following API methods related to shipment operations:
- Terminate Shipments
- Complete Shipments
- Terminate Shipment for Assets
- Complete Shipment for Assets
- Associate Rule Set to Shipments
- Add Assets to Shipments
- Delete Assets from Shipments
- Bind Devices to Assets on Shipments
- Unbind Devices from Assets on Shipments
- Get eURL for Shipments
Terminate Shipments ASYNC
Terminate Shipments Request
POST $baseURL/api/2/shipment/{externalId}/status/terminate
This API terminates shipments that have not taken place or will not be completed. This section describes how particular shipments can be terminated using this API. Shipments are identified by an externalId provided by the external system. If shipment cannot be terminated a 400 Invalid Data error will be returned along with the reason.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External Id of Shipment to be terminated |
entityTypeKey |
Request | true | Object type for shipment. Valid types are:
|
Request Class Model for Terminate Shipments
N/A
Response Message for Terminate Shipments
{
"response" : "Operation performed successfully on shipment : {{external id}}"
}
Response Messages
Following are the possible Response Messages for Terminate Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns a message indicating the External ID for the shipment that has been terminated. |
400 |
Invalid Data | Response returns an error message along with the reason for which the shipment could not be terminated. Error message will be in the format described in the Error Message Format section. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Complete Shipments ASYNC
Complete Shipments Request
POST $baseURL/api/2/shipment/{externalId}/status/complete
This API completes shipments that have arrived at destination. This section describes how particular shipments can be completed using this API. Shipments are identified by an externalId provided by the external system. If shipment cannot be completed a 400 Invalid Data error will be returned along with the reason.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External Id of Shipment to be terminated |
entityTypeKey |
Request | true | Object type for shipment. Valid types are:
|
Request Class Model for Complete Shipments
N/A
Response Message for Complete Shipments
{
"response" : "Operation performed successfully on shipment : {{external id}}"
}
Response Messages
Following are the possible Response Messages for Complete Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Shipment Updated Successfully | Response returns a message indicating the External ID for the shipment that has been terminated. |
400 |
Invalid Data | Response returns an error message along with the reason for which the shipment could not be terminated. Error message will be in the format described in the Error Message Format section. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Terminate Shipment for Assets ASYNC
Terminate Request for Assets on a Shipment
POST $baseURL/api/2/shipment/taggedasset/status/terminate
{
“shipmentExternalId”: {{externalId of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{externalId of asset}},
“entityTypeKey”: {{asset type}}
},
{
“externalId”: {{externalId of asset}},
“entityTypeKey”: {{asset type}}
}
]
}
This API terminates the shipment process for one or more assets which are on a shipment.
For example, if three assets are on the shipment, two of three assets that are associated on a shipment can be terminated because they will no longer be shipped. If an asset shipment status can't be terminated a 400 Invalid Data error will be returned along with the reason.
Note that this can only occur prior to completion of the shipment.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
Request Class Model for Terminate Request for Assets on a Shipment
| Attribute | Required | Format | Description |
|---|---|---|---|
| shipmentExternalId | true | string | Unique external ID to identify shipment. If a shipment instance is not found, then 400 Invalid Data will be returned. |
| entityTypeKey | false | string | Type of shipment: standard or parcel |
| assets | true | string | Array of assets to be terminated. Each asset is identified by entityTypeKey and externalId for the entity. |
Response Message for Terminate Request for Assets on a Shipment
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
“entityTypeKey”: {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
},
{
“externalId”: {{external Id of asset}},
“entityTypeKey”: {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
}
]
}
Response Messages
Following are the possible Response Messages for Terminate Request for Assets on a Shipment:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that one or more assets have been successfully terminated for the shipment. |
400 |
Invalid Data | Response returns an error message along with the reason for which assets on the shipment could not be terminated. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Complete Shipment for Assets ASYNC
Complete Request for Assets on a Shipment
POST $baseURL/api/2/shipment/taggedasset/status/complete
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}}
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}}
}
]
}
This API completes the shipment process for one or more assets which are on a shipment.
For example, if three assets are on the shipment, two of three assets that are associated on a shipment can be completed because they reached destination before the third asset. If an asset's shipment status cannot be completed a 400 Invalid Data error will be returned along with the reason.
Note that this can only occur prior to completion of the shipment and after the shipment is In Transit.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
Request Class Model for Complete Request for Assets on a Shipment
| Attribute | Required | Format | Description |
|---|---|---|---|
| shipmentExternalId | true | string | Unique external ID to identify shipment. If a shipment instance is not found, then 400 Invalid Data will be returned. |
| entityTypeKey | false | string | Type of shipment: standard or parcel |
| assets | true | string | Array of assets to be completed. Each asset is identified by entityTypeKey and externalId for the entity. |
Response Message for Complete Request for Assets on a Shipment
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
}
]
}
Response Messages
Following are the possible Response Messages for Complete Request for Assets on a Shipment:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that one or more assets have been successfully completed for the shipment. |
400 |
Invalid Data | Response returns an error message along with the reason for which assets on the shipment could not be completed. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Associate Rule Set to Shipments
Associate Rule Set to Shipments Request
POST $baseURL/api/2/shipment/ruleset
{
"rulesetName": "{{rule set name}}",
"shipments": [
{
“externalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}}
},
{
“externalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}}
}
]
}
This API associate rule sets to one or more shipments. If rule set cannot be associated with one or more shipments, a 400 Invalid Data error will be returned along with the reason.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
Request Class Model for Associate Rule Set to Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| rulesetId | true | string | Unique external ID to identify a rule set. If a rule set instance is not found, then 400 Invalid Data will be returned. |
| shipments | true | string | Array of shipments to be associated with rule set. Each asset is identified by entityTypeKey and externalId for the entity. |
Response Message for Associate Rule Set to Shipments
{
"rulesetId": "{{rule set id}}",
"rulesetName": "{{rule set name}}",
"shipments": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
}
]
}
Response Messages
Following are the possible Response Messages for Complete Request for Assets on a Shipment:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that one or more assets have been successfully completed for the shipment. |
400 |
Invalid Data | Response returns an error message along with the reason for which assets on the shipment could not be completed. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Add Assets to Shipments
Add Assets to Shipments Request
POST $baseURL/api/2/shipment/assets
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}}
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}}
}
]
}
This API adds one or more assets to a shipment.If one or more assets cannot be added to a shipment, then a 400 Invalid Data error will be returned along with the reason. Note that this can only occur prior a shipment is completed.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
Request Class Model for Add Assets to Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| shipmentExternalId | true | string | Unique external ID to identify shipment. If a shipment instance is not found, then 400 Invalid Data will be returned. |
| entityTypeKey | false | string | Type of shipment: standard or parcel |
| assets | true | string | Array of assets to be added to shipment. Each asset is identified by entityTypeKey and externalId for the entity. In case of parcelshipment user need to add extra parameter trackingNumber in payload |
Response Message for Add Assets to Shipments
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
}
]
}
Response Messages
Following are the possible Response Messages for Add Assets to Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that one or more assets have been successfully added to the shipment. |
400 |
Invalid Data | Response returns an error message along with the reason for which assets on the shipment could not be added. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Delete Assets from Shipments
Delete Assets from Shipments Request
DELETE $baseURL/api/2/shipment/assets
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}}
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}}
}
]
}
This API deletes one or more assets from a shipment. If one or more assets cannot be deleted from a shipment, then a 400 Invalid Data error will be returned along with the reason. Note that this can only occur prior an asset is InTransit.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
Request Class Model for Add Assets to Shipments
| Attribute | Required | Format | Description |
|---|---|---|---|
| shipmentExternalId | true | string | Unique external ID to identify shipment. If a shipment instance is not found, then 400 Invalid Data will be returned. |
| entityTypeKey | false | string | Type of shipment: standard or parcel |
| assets | true | string | Array of assets to be deleted from shipment. Each asset is identified by entityTypeKey and externalId for the entity |
Response Message for Delete Assets from Shipments
{
“shipmentExternalId”: {{external Id of shipment}},
“entityTypeKey”: {{shipment type}},
"assets": [
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
},
{
“externalId”: {{external Id of asset}},
"entityTypeKey": {{asset type}},
"status" : "Success or Fail",
"message" : "Error message in case of error"
}
]
}
Response Messages
Following are the possible Response Messages for Delete Assets from Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that one or more assets have been successfully deleted the shipment. |
400 |
Invalid Data | Response returns an error message along with the reason for which assets on the shipment could not be deleted. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Get eURL for Shipments
Get eURLs for Shipments Request
GET $baseURL/api/2/shipment/{{externalId}}/eURL?entityTypeKey=standardshipment
This API returns the single eURLs for a particular shipment
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
externalId |
Path | true | External Id of Shipment for which eURL is requested |
entityTypeKey |
Request | true | Object type for shipment. Valid types are:
|
Request Class Model for Get eURL for Shipments
N/A
Response Message Example
{
"shipmentExtId": {{shipment external id}},
"entityTypeKey": {{shipment type}},
"permaLinkFull": {{http url with link},
"permaLinkLimited": {{http url with link}}
}
Response Class Model for Get eURL for Shipments
| Attribute | Format | Description |
|---|---|---|
| shipmentExtId | string | External ID that uniquely identifies shipment for tenant |
| entityTypeKey | string | Entity Type Key: standard or parcel |
| permaLinkFull | string | Full eURL for shipment |
| permaLinkLimited | string | Limited eURL for shipment. This is not functional yet. DO NOT USE |
Response Messages
Following are the possible Response Messages for Get eURL for Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
OK | Response returns a message indicating that eURL was successfully returned. |
400 |
Invalid Data | Response returns an error message with reason why eURL data was not successfully returned. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Bulk eURL's of shipments
This api is used to get Bulk eURL's of shipments.
POST $baseURL/api/2/shipment/eURL/bulk
This API will provide all the bulk eURL's for given shipments names provided in the payload.
Path, Header and Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call |
Request Class Model for Bulk eURL's of shipments
{
"dtpshipment": [
"EId-DTP06060001",
"khgckhgckhgckhgckh",
"DTP06080002"
],
"parcelshipment": [
"PS0620005",
"PS0620003"
]
}
Response Message for Bulk eURL's of shipments
[
{
"id": "2b338435-dbad-481a-b796-217ba5c182be",
"name": "PS0620005",
"entityTypeKey": "parcelshipment",
"externalId": "PS0620005",
"permalinkFull": "https://test2-share.parkoursc.com/#/saegZW8CVDHxN7D9H-3JLfpu86DbUZ4oIliriu8cDqUwysPdzn9z10fL1QhpfC4GofxerVBZ6PbxBj3ODIbKMOhBwixBVrL6h-COJbPiPbTRMxFrsfrK_bmbuZIL9VnG0wcjmltZ87ipT88PBym8fWt_lM4ujck-zjRaUQd-1fA",
"permalinkLimited": "https://test2-share.parkoursc.com/#/saegZW8CVDHxN7D9H-3JLfpu86DbUZ4oIliriu8cDqUwysPdzn9z10fL1QhpfC4GhnBH9wtUI8CZ-woXd05oPlSxB19cZuAtAb8IDYqNkGzNrqN-J9qkjl2YzAfjZdb8HAoQr1lfn1qeS8YdWJC09JjD2CS8p-uI1hcAIP9Z5oM"
},
{
"id": "f5c9d915-e187-4bbf-86a6-40e85d4be264",
"name": "PS0620003",
"entityTypeKey": "parcelshipment",
"externalId": "PS0620003",
"permalinkFull": "https://test2-share.parkoursc.com/#/JQtQ_WycdtDX11oua4tHcKREpJfILSPcPL7NQV-7gBBw_WGMpoMqarIkKdrXK63LofxerVBZ6PbxBj3ODIbKMOhBwixBVrL6h-COJbPiPbTRMxFrsfrK_bmbuZIL9VnG0wcjmltZ87ipT88PBym8fWt_lM4ujck-zjRaUQd-1fA",
"permalinkLimited": "https://test2-share.parkoursc.com/#/JQtQ_WycdtDX11oua4tHcKREpJfILSPcPL7NQV-7gBBw_WGMpoMqarIkKdrXK63LhnBH9wtUI8CZ-woXd05oPlSxB19cZuAtAb8IDYqNkGzNrqN-J9qkjl2YzAfjZdb8HAoQr1lfn1qeS8YdWJC09JjD2CS8p-uI1hcAIP9Z5oM"
}
]
Response Messages
Following are the possible Response Messages for Terminate Shipments:
| HTTP Status Code | Reason | Notes |
|---|---|---|
200 |
Get eURL's Successfully | Response returns a message indicating the External ID for the shipment that has been terminated. |
400 |
Invalid Data | Response returns an error message along with the reason for which the shipment could not be terminated. Error message will be in the format described in the Error Message Format section. |
401 |
Access Denied | |
403 |
Forbidden | |
500 |
Internal Server error |
Entity Lookup
Version 1.0
This section covers the payload format of Search API.
Note:- To get more details of Search API you can go through Entity Search
Get Carrier Code
GET $baseURL/api/2/carrierCode
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
[
{
"carrierCode": "agility",
"carrierName": "Agility",
"tenantId": "cloudleaf",
"slug": "agility",
"valid": true
},
{
"carrierCode": "dhl",
"carrierName": "DHL Express",
"tenantId": "cloudleaf",
"slug": "dhl",
"valid": true
}
]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Sensor Profiles
GET $baseURL/api/2/eventprofiles
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
onlyActiveProfiles |
Request | true | Default value true |
Response Format
[
{
"deviceConfig": [
{
"identifier": "LoggerService",
"name": "LoggerService",
"characteristics": [
{
"identifier": "sth_spl",
"name": "sth_spl",
"configParams": {
"uom": "mins",
"enabled": "true",
"value": "20"
}
}
]
}
],
"eventProfileName": "SenTMBLE_Rec20m",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"deleted": false,
"eventConfig": {
"tempUnitType": "C"
},
"sensorType": "SEN-TT-Ultra-Multi-BLE",
"mappedDevices": [
{
"id": "AB12312122",
"accountId": "850f0993-33ee-44f9-bc09-31123fdbd41c",
"type": "SEN-TT-Ultra-Multi-BLE",
"status": "ACTIVE",
"createdAt": 1675330972053,
"modifiedAt": 1675331430873,
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"properties": {
"accountName": "test",
"deviceType": "tracker",
"eventProfileName": "SenTMBLE_Rec20m",
"mfgdate": "1675331430",
"model": "SEN-TT-Ultra-Multi-BLE",
"sku": "SEN-TT-Ultra-Multi-BLE",
"vendor": "Sensitech"
},
"eventProfileName": "SenTMBLE_Rec20m",
"physical": true
}
],
"tenantName": "rt35parent",
"organization": "",
"default": false
}
]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get All Routes
POST $baseURL/api/2/search
{
"globalQueryText": "",
"match": "must",
"scrollId": "",
"scrollSize": 50,
"searchQueries": [
{
"fieldName": "parentEntityType",
"queryText": "route",
"queryOperator": "should",
"childFilters": [
{
"fieldName": "deleted",
"queryText": "true",
"queryOperator": "must_not"
},
{
"fieldName": "dynamicRoute",
"queryText": "true",
"queryOperator": "must_not"
}
]
}
],
"outFields": [
"name",
"id",
"externalId"
]
}
This API will give detailed information of Route present in system for this tenant. We can reduce result size by using field "outFields" by passing required field name.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAn0b0WdjRfb05TSmtRUXU3aFNiaDBGYWV4UQ==",
"hits": [
{
"name": "routefeb",
"externalId": "routefeb",
"id": "828d01e4-57b1-459b-b2ac-d5cdd9003e66"
},
{
"name": "AutomationRoute-305989",
"externalId": "SourceArea-305989-To-DestinationArea-305989",
"id": "cc906c40-eb0b-44d0-94f9-ce839913c23a"
},
{
"name": "AutomationRoute-126644",
"externalId": "SourceArea-126644-To-DestinationArea-126644",
"id": "99a23f87-1443-489e-a4d9-9d32e139a3f1"
},
{
"name": "rameshdhl-Route-136862",
"externalId": "rameshdhl-SA-136862-To-rameshdhl-DA-136862",
"id": "54d6716c-59df-4a31-ac61-34ece8ec9385"
}
],
"totalHits": 540
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get All Assets
POST $baseURL/api/2/search
{
"globalQueryText": "",
"match": "must",
"scrollId": "",
"scrollSize": 50,
"searchQueries": [
{
"fieldName": "parentEntityType",
"queryText": "asset",
"queryOperator": "should",
"childFilters": [
{
"fieldName": "deleted",
"queryText": "true",
"queryOperator": "must_not"
}
]
}
],
"outFields": [
"name",
"id",
"externalId",
"monitoredStatus"
]
}
This API will give detailed information of assets present in system for this tenant. We can reduce result size by using field "outFields" by passing required field name. We can add filter conditions also in case we want only monitored assets by adding one more child filter object with monitoredStatus as Monitored or UnMonitored
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAn0lEWdjRfb05TSmtRUXU3aFNiaDBGYWV4UQ==",
"hits": [
{
"monitoredStatus": "UNMONITORED",
"name": "skfeb",
"externalId": "skfeb",
"id": "89a492b5-348d-4daf-840a-dfebfaecadf4"
},
{
"monitoredStatus": "MONITORED",
"name": "A-Mul_different",
"externalId": "A-Mul_different",
"id": "64e01bea-23bf-4e58-ba1d-835850b4be44"
}
],
"totalHits": 2
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get All Area
POST $baseURL/api/2/search
{
"globalQueryText": "",
"match": "must",
"scrollId": "",
"scrollSize": 50,
"searchQueries": [
{
"fieldName": "parentEntityType",
"queryText": "area",
"queryOperator": "should",
"childFilters": [
{
"fieldName": "deleted",
"queryText": "true",
"queryOperator": "must_not"
}
]
}
],
"outFields": [
"name",
"id",
"externalId"
]
}
This API will give detailed information of area present in system for this tenant. We can reduce result size by using field "outFields" by passing required field name. We can add filter conditions also in case we want only monitored assets by adding one more child filter objects.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAn0lEWdjRfb05TSmtRUXU3aFNiaDBGYWV4UQ==",
"hits": [
{
"name": "DestinationArea-913510",
"externalId": "DestinationArea-913510",
"id": "65bd0176-6f52-423c-8ffa-25ef233c23dd"
},
{
"name": "DestinationArea-933857",
"externalId": "DestinationArea-933857",
"id": "9ba8df69-9d95-4251-9956-779725823abb"
}
],
"totalHits": 2
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Rule Sets for tenant
GET $baseURL/api/2/ruleset/bytenant
This API will give detailed information of assets present in system for this tenant. We can reduce result size by using field "outFields" by passing required field name. We can add filter conditions also in case we want only monitored assets by adding one more child filter object with monitoredStatus as Monitored or UnMonitored
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
[
{
"id": "bc21cc0f-92f0-490d-94cb-8aae6d225422",
"name": "AutoRuleSet-913510",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"recipeIdNames": {
"645f027b-e729-4419-9a5e-32c4153b64b7": {
"recipeIdNames": "AutoAmbientTempRule-913510",
"application": "all"
},
"c07bca78-b9a7-42f6-b268-9936f93774e4": {
"recipeIdNames": "AutoSSAnyInfo-913510",
"application": "intransit"
}
},
"createdBy": "rameshqaproddvp2",
"createdAt": 1675989585668,
"modifiedAt": 1675989585668,
"modifiedBy": "rameshqaproddvp2"
},
{
"id": "f13eb8cf-73de-4475-b772-2675f826aa93",
"name": "AutoRuleSet-933857",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"recipeIdNames": {
"7e72b65d-115d-4b99-ac2d-c42de9032a71": {
"recipeIdNames": "AutoAmbientTempRule-933857",
"application": "all"
},
"5fbb3ef1-3453-4fb6-8dfc-513db2c51c87": {
"recipeIdNames": "AutoSSAnyInfo-933857",
"application": "intransit"
}
},
"createdBy": "rameshqaproddvp2",
"createdAt": 1675989584677,
"modifiedAt": 1675989584677,
"modifiedBy": "rameshqaproddvp2"
}
]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Geo Codes
POST $baseURL/api/2/geocodes
BODY => {{any valid address string }}
example:- Ambashish, Plot 3-4 Pakharbaug,, NDA Pashan Rd, Bavdhan, Pune, Maharashtra 411021
This API will give lat and lng associated with address. Lat and Lng will be returned only in case of valid address is entered by user. For wrong address string empty response will be returned
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
| Content-Type: text/plain | Header | true |
Response Format
{
"lat": 18.5209009,
"lng": 73.7786062,
"height": 0.0
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Tenant
This section covers the payload format of Tenant API.
Create Tenant ASYNC
POST $baseURL/api/2/tenants
This api is used to create the tenant.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"customer": {
"type": "ORGANIZATION",
"status": "ACTIVE",
"name": "AutoChildName230602034855"
},
"userDTO": {
"userDevices": [
{
"transport": "email",
"deviceIdentifier": "mailto:abhukta+autochildname230602034855@parkoursc.com"
}
],
"id": "autochildname230602034855",
"name": "AutoChildName230602034855"
}
}
Response Format
{
"messgae": "Tenant is created successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Update Tenant
PUT $baseURL/api/2/tenants/{tenantId}
This api is used to update the tenant.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"name": "AutoChildName230602034855Updated",
"logo": "",
"status":"SUSPENDED"
}
Response Format
{
"messgae": "Tenant is updated successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get All Tenants
GET $baseURL/api/2/tenants/all
This api is used to get the details of all tenants.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
[
{
"id":"387480a4-87ad-44bd-8d19-15b70f220553",
"type":"ORGANIZATION",
"status":"ACTIVE",
"name":"AutoChildName230602034855",
"logo":"https://s3.amazonaws.com/clf-webapp-storage/gateway/ParkourSC-Logo_Horizontal-Solid.png"
},
{
"id":"90dd2d67-5486-4496-ba93-3ea65023c95b",
"type":"ORGANIZATION",
"status":"ACTIVE",
"name":"testoct28UATchildtenant",
"logo":"https://s3.amazonaws.com/clf-webapp-storage/gateway/ParkourSC-Logo_Horizontal-Solid.png"
},
{
"id":"e835167a-fcc1-496f-b240-2601a48ad462",
"type":"ORGANIZATION",
"status":"ACTIVE",
"name":"Jamie-subtenant1",
"logo":"https://s3.amazonaws.com/clf-webapp-storage/gateway/ParkourSC-Logo_Horizontal-Solid.png"
},
{
"id":"fae093d5-d187-4493-aed4-14499668e1d4",
"type":"ORGANIZATION",
"status":"ACTIVE",
"name":"rameshdhl",
"logo":"https://s3.amazonaws.com/clf-webapp-storage/gateway/ParkourSC-Logo_Horizontal-Solid.png"
}]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Users
This section covers the payload format of User API.
Create User
POST $baseURL/api/2/users
This api is used to create the user.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"type": "NORMAL_USER",
"enabled": false,
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb97457",
"roles": [
"0168ee64-fec2-479d-8f3c-54e6d58dc957",
"9d809120-3841-4213-9f66-91f23a8b9304",
"aab9c3b9-96c0-4bbd-afb2-c84e538032e9",
"faa474d5-faf5-4632-8c37-010102d9f457"
],
"id": "autouserid230602034355",
"name": "Automation User 230602034355",
"email": "mailto:abhukta+autouserid230602034355@parkoursc.com",
"managerName": "",
"managerEmail": "",
"timezone": "Asia/Calcutta",
"uiProfileId": "fc21a4d8-ba8a-11eb-bc03-2b8dde4dcdcd", // Pass either uiProfileId or uiProfile
"uiProfile": "{{Profile Name}}"
}
Response Format
{
"messgae": "User is created successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Update User
PUT $baseURL/api/2/users/{userId}
This api is used to update the user.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"enabled": true,
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb97457",
"roles": [
"0168ee64-fec2-479d-8f3c-54e6d58dc957",
"9d809120-3841-4213-9f66-91f23a8b9304",
"aab9c3b9-96c0-4bbd-afb2-c84e538032e9",
"faa474d5-faf5-4632-8c37-010102d9f457"
],
"name": "Automation User 230529101906 Updated",
"email": "mailto:abhukta+autouserid230602034355@parkoursc.com",
"phone": "+917008680114",
"managerName": "New Manager Updated",
"managerEmail": "mailto:abhukta+6787665@parkoursc.com",
"timezone": "Asia/Calcutta",
"uiProfileId": "fc21a4d8-ba8a-11eb-bc03-2b8dde4dcdcd"
}
Response Format
{
"messgae": "User is updated successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get User
GET $baseURL/api/2/users/{userId}
This api is used to get the user details.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"id":"autouserid230602034355",
"tenantId":"26743150-c6cc-47b8-a182-be1b59c52735",
"enabled":true,
"name":"Automation User 230529101906 Updated",
"type":"NORMAL_USER",
"roles":[
"ROLE_APP_INTRANSIT",
"ROLE_APP_CLOUD",
"0168ee64-fec2-479d-8f3c-54e6d58dc957",
"faa474d5-faf5-4632-8c37-010102d9f457",
"aab9c3b9-96c0-4bbd-afb2-c84e538032e9",
"9d809120-3841-4213-9f66-91f23a8b9304"],
"properties":{
"mailto:manageremail":"abhukta+6787665@parkoursc.com",
"userTenantAccessType":"DIRECT",
"encoded.cred.archive":"",
"autouserid230602034355!BBAH1Gi7pb1A":"1685787264858",
"managerName":"New Manager Updated"
},
"userDevices":[
{
"id":"1cc65092-144e-491f-acd7-c694336ba7da",
"userId":"autouserid230602034355",
"deviceIdentifier":"+917008680114",
"deviceName":null,
"transport":"sms",
"appPlatform":null,
"status":"CONFIRMED",
"providerDetails":null,
"confirmationKey":null,
"cc":null,
"bcc":null
},
{
"id":"9f709e36-4695-4c67-91d7-2de7e3207ffe",
"userId":"autouserid230602034355",
"deviceIdentifier":"web",
"deviceName":null,
"transport":"web",
"appPlatform":null,
"status":"SUBSCRIBED",
"providerDetails":null,
"confirmationKey":null,
"cc":null,
"bcc":null
},
{
"id":"9bebb72e-58f0-47f7-a465-2e397b68d0a5",
"userId":"autouserid230602034355",
"mailto:deviceidentifier":"abhukta+autouserid230602034355@parkoursc.com",
"deviceName":null,
"transport":"email",
"appPlatform":null,
"status":"PENDING_CONFIRMATION",
"providerDetails":null,
"confirmationKey":null,
"cc":null,
"bcc":null
}],
"modifiedTime":1685701085971,
"locked":false,
"timezone":"Asia/Calcutta",
"module":"INTRANSIT",
"uiProfileId":"fc21a4d8-ba8a-11eb-bc03-2b8dde4dcdcd",
"uiProfileName":"Default UI Profile",
"notificationChannels":{
"Predictive Metric":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
},
"Time Delays":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
},
"Device Health":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
},
"Presence And Movement":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
},
"Carrier Milestone":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
},
"Conditions":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
},
"Shipment Status":{
"web":true,
"sms":true,
"notificationType":"ALL",
"email":true
}
},
"userTenantAccessType":"DIRECT",
"proxyLogin":false,
"orgAware":false
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Delete User
DELETE $baseURL/api/2/users/{userId}
This api is used to delete the user.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"messgae": "User is deleted successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Create SSO User
POST $baseURL/api/2/sso/user
This api is used to create the SSO user.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"userEmail": "rhuturajg351@parkoursc.com",
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"roles": [
"ROLE_DEVELOPER"
],
"displayName": "Rtest-351",
"managerName": "TestManager",
"managerEmail": "npatil+11@parkoursc.com",
"phone": "",
"timezone": "Asia/Calcutta",
"uiProfile": "",
"enabled":true
}
Response Format
{
"messgae": "SSO user created successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get UI Profile
GET $baseURL/api/2/uiprofiles
This api is used to get the ui profiles.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
[
{
"id": "335b02ef-e990-47f1-900c-c60d6f5e4e3e",
"profileName": "DTP Shipments UI"
},
{
"id": "fc21a4d8-ba8a-11eb-bc03-2b8dde4dcdcd",
"profileName": "Default UI Profile"
}
]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
Roles
This section covers the payload format of Role API.
Create Role
POST $baseURL/api/2/role
This api is used to create the role.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"roleName" : "TestRole2206-1",
"includedPolicies": ["TestPolicy_2206-1"],
"roleScope":"SHARED",
"shareRoleWithTenants":["cfe3a3ea-6ab3-466a-b833-03121d041d19"],
"shareRoleWithTenantsNamed":["Ranjan DHL"]
}
Response Format
{
"messgae": "Role is created successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Update Role
PUT $baseURL/api/2/role/{roleId}
This api is used to update the role.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"roleName": "TestRole2206-1",
"includedPolicies": [
"TestPolicy_2206-1"
],
"roleScope": "SHARED",
"shareRoleWithTenants": [
"cfe3a3ea-6ab3-466a-b833-03121d041d19"
],
"shareRoleWithTenantsNamed": [
]
}
Response Format
{
"messgae": "Role is updated successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get All Roles
GET $baseURL/api/2/role
This api is used to get the details of all roles.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
[
{
"id": "c3c7c5e7-078c-49b3-82a5-e0ee563a25ab",
"name": "TestRole2206-1",
"editable": true,
"policies": [
{
"id": "4f55dc7c-45d1-469f-82e3-52b41c1b5ce0",
"name": "TestPolicy_2206-1",
"editable": false,
"allowed": false
}
],
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"moduleName": "ALL",
"roleProperties": {
"roleScope": "SHARED"
},
"createdAt": 1687426621116,
"createdBy": "test2qa",
"modifiedAt": 1687427118933,
"modifiedBy": "test2qa",
"permissions": [
"TestPolicy_2206-1"
]
},
{
"id": "05b930bf-5715-47fe-930a-a3e40e2c6767",
"name": "DTP_temp ROLE",
"editable": true,
"policies": [
{
"id": "dc675d78-a12e-11ec-b909-0242ac120002",
"name": "CdmInstance-Read-Access",
"editable": false,
"allowed": false
},
{
"id": "ea0018a0-24b4-11eb-adc1-0242ac120002",
"name": "Route-Read-Access",
"editable": false,
"allowed": false
},
{
"id": "ea007688-24b4-11eb-adc1-0242ac120002",
"name": "Tagged-Asset-All-Access",
"editable": false,
"allowed": false
},
{
"id": "ea000036-24b4-11eb-adc1-0242ac120002",
"name": "Asset-Read-Access",
"editable": false,
"allowed": false
},
{
"id": "ea002228-24b4-11eb-adc1-0242ac120002",
"name": "Site-Read-Access",
"editable": false,
"allowed": false
},
{
"id": "99197c5a-84cc-4491-8d71-e3d6963f3be2",
"name": "DTP-CdmInstance-Read-Access1",
"editable": false,
"allowed": false
}
],
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"moduleName": "ALL",
"roleProperties": {
"roleScope": "SHARED"
},
"createdAt": 1684762688661,
"createdBy": "test2qa",
"modifiedAt": 1684814936575,
"modifiedBy": "test2qa",
"sharedTenants": [
"3890d45c-cad6-4887-a039-c232f3fc286a"
],
"permissions": [
"CdmInstance-Read-Access",
"Route-Read-Access",
"DTP-CdmInstance-Read-Access1",
"Asset-Read-Access",
"Tagged-Asset-All-Access",
"Site-Read-Access"
]
}
]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Single Role
GET $baseURL/api/2/role/{roleId}
This api is used to get the details of role using roleId.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"id": "c3c7c5e7-078c-49b3-82a5-e0ee563a25ab",
"name": "TestRole2206-1",
"editable": true,
"policies": [
{
"id": "4f55dc7c-45d1-469f-82e3-52b41c1b5ce0",
"name": "TestPolicy_2206-1",
"editable": false,
"allowed": false
}
],
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"moduleName": "ALL",
"roleProperties": {
"roleScope": "SHARED"
},
"createdAt": 1687426621116,
"createdBy": "test2qa",
"modifiedAt": 1687427118933,
"modifiedBy": "test2qa",
"permissions": [
"TestPolicy_2206-1"
]
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Delete Role
DELETE $baseURL/api/2/role/{roleId}
This api is used to delete the role using roleId.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"messgae": "Role deleted successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Policies
This section covers the payload format of Policy API.
Create Policy
POST $baseURL/api/2/policy
This api is used to create the policy.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"name": "APIAutomationPolicy-2023-01",
"destinations":["DestinationArea-135926"],
"origines":["SourceArea-20230614013508"],
"destinations":["DestinationArea-135926"],
"actions": [
"CREATE",
"DELETE",
"DETAIL",
"SHARE",
"SUMMARY",
"TERMINATE",
"UPDATE"
],
"entityName": "SHIPMENT"
}
Response Format
{
"messgae": "Policy is created successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Update Policy
PUT $baseURL/api/2/policy/{policyId}
This api is used to update the policy.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Request Format
{
"name": "APIAutomationPolicy-2023-01",
"destinations":["DestinationArea-135926"],
"origines":["SourceArea-20230614013508"],
"destinations":["DestinationArea-135926"],
"actions": [
"CREATE",
"DELETE",
"DETAIL",
"SHARE",
"SUMMARY",
"TERMINATE",
"UPDATE"
],
"entityName": "SHIPMENT"
}
Response Format
{
"messgae": "Policy is updated successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get All Policies
GET $baseURL/api/2/policy
This api is used to get the details of all policies.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
[
{
"id": "8cc60d2c-a0ac-4cc9-a481-6d935f0fa3f0",
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"name": "Test P -01- 2206",
"actions": [
"CREATE",
"SUMMARY",
"UPDATE",
"DETAIL"
],
"entityName": "PRODUCT",
"entityUILabel": "Product",
"moduleName": "INTRANSIT",
"effect": "ALLOW",
"createdAt": 1687413544881,
"createdBy": "test2qa",
"policyType": "Custom Policy",
"dataClassification": "DEFAULT",
"editable": true,
"allowed": true
},
{
"id": "c196f69d-9772-4682-aa25-121c65b20470",
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"name": "Test P 2206",
"actions": [
"DELETE",
"CREATE",
"SUMMARY",
"UPDATE",
"DETAIL"
],
"entityName": "CDMINSTANCE",
"entityUILabel": "Entity Access Control",
"moduleName": "INTRANSIT",
"effect": "ALLOW",
"createdAt": 1687412397277,
"createdBy": "test2qa",
"policyType": "Custom Policy",
"dataClassification": "RESTRICTED,DTP_RESTRICTED_DATA",
"editable": true,
"allowed": true
}
]
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Single Policy
GET $baseURL/api/2/policy/{policyId}
This api is used to get the details of policy using policyId.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"id": "8cc60d2c-a0ac-4cc9-a481-6d935f0fa3f0",
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"name": "Test P -01- 2206",
"actions": [
"CREATE",
"SUMMARY",
"UPDATE",
"DETAIL"
],
"entityName": "PRODUCT",
"entityUILabel": "Product",
"moduleName": "INTRANSIT",
"effect": "ALLOW",
"createdAt": 1687413544881,
"createdBy": "test2qa",
"policyType": "Custom Policy",
"dataClassification": "DEFAULT",
"editable": true,
"allowed": true
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Single Policy By Name
GET $baseURL/api/2/policy/getPolicyByName/{policyName}
This api is used to get the details of policy using policyName.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"id": "8cc60d2c-a0ac-4cc9-a481-6d935f0fa3f0",
"tenantId": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"name": "Test P -01- 2206",
"actions": [
"CREATE",
"SUMMARY",
"UPDATE",
"DETAIL"
],
"entityName": "PRODUCT",
"entityUILabel": "Product",
"moduleName": "INTRANSIT",
"effect": "ALLOW",
"createdAt": 1687413544881,
"createdBy": "test2qa",
"policyType": "Custom Policy",
"dataClassification": "DEFAULT",
"editable": true,
"allowed": true
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Delete Policy
DELETE $baseURL/api/2/policy/{policyId}
This api is used to delete the policy using policyId.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"messgae": "Policy deleted successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Delete Policy By Name
DELETE $baseURL/api/2/policy/deleteByName/{policyName}
This api is used to delete the policy using policyName.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login APi call. |
Response Format
{
"messgae": "Policy deleted successfully"
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Inbound Telemetry Simulation
Version 1.0
This section covers the payload format used by the ParkourSC Inbound Telemetry Simulation API.
Format Requirements
The telemetry message format has the following requirements:
- Adopt industry standards for
Units of Measurement - Enable multiple/bulk inputs of telemetry events
- Define standard event types for reuse
- Extend to allow custom event types
Event Modeling
This section covers the data models for telemetry events. These models make up the JSON payloads used in ParkourSC Telemetry APIs.
Telemetry Message
Telemetry Message Model
[
{ StandardEventGroup 1 },
{ StandardEventGroup 2 },
{ StandardEventGroup 3 },
...
]
At the top level, a single Telemetry Message payload is an array of StandardEventGroup JSON objects. These objects do not require a key. A Telemetry Message must contain at least one StandardEventGroup.
StandardEventGroup
StandardEventGroup Model
{
"source": { EntityDefinition },
"time": <long>,
"events": {
"<eventType>": { StandardEvent 1 },
"<eventType>": { StandardEvent 2 },
"<eventType>": { StandardEvent 3 },
}
}
The StandardEventGroup model contains a batch of StandardEvent objects associated with a single source entity. The source is generally the sensor that is publishing the event data.
| Field | Type | Usage |
|---|---|---|
source |
EntityDefinition |
Contains the ID and type of the EventGroup source, i.e., a sensor |
time |
Long | EPOCH time in milliseconds for events in this EventGroup |
events |
Map |
Map of Event Type (e.g., "cargoTemp") to StandardEvent object with corresponding data. See Event Types below for the list of supported types and their formats. |
EntityDefinition
EntityDefinition Model
{
"id": "<entityID>"
"type": "<entityType>"
}
The EntityDefinition model captures metadata about the entities associated with a given EventGroup. Currently, only one EntityDefinition object is required for the source of the EventGroup data.
| Field | Type | Usage |
|---|---|---|
id |
String | ID of the entity. For source, this is the sensorId |
type |
String | Type of the entity. For source, this is the sensorType, e.g., "RFID" |
StandardEvent
StandardEvent Model
{
"type": "<dataType>"
"value": {
"<quantityName>": {Quantity}
// more Quantities depending on Event Type
}
}
The StandardEvent model represents a single telemetry event from a sensor.
| Field | Type | Usage |
|---|---|---|
type |
String | The data type of this event. See the Data Type column in the Event Types table below |
value |
Object | Event data. Contains one or more Quantity objects depending on the Event Type. |
Quantity
Quantity Model
{
"value": "<number>"
"unit": "<unit>"
}
The Quantity model represents a single unit of event data.
| Field | Type | Usage |
|---|---|---|
value |
Number | Numeric value |
unit |
String | Unit of measure. Standard unit values are represented by the international standard unit short forms described here |
Event Types
The following table describes all possible telemetry event types currently supported in the ParkourSC platform. The JSON format for each type is shown on the right.
New event types will be introduced without disrupting the payload models described in Event Modeling.
Supported Event Types
Data Type = Battery
{
"value" : "number",
"unit" : "percent"
}
Data Type = GeoLocation
{
"lat": {
"value" : "number",
"unit" : "degree"
},
"lon": {
"value" : "number",
"unit" : "degree"
} ,
"alt": {
"value" : "number",
"unit" : "m"
}
}
Data Type = Pressure
{
"value" : "number",
"unit" : "hPa"
}
Data Type = Vibration
{
"value" : "boolean (true | false)",
"unit" : "bool"
}
Data Type = Humidity
{
"value" : "number",
"unit" : "percent"
}
Data Type = Light
{
"value" : "number",
"unit" : "lux"
}
Data Type = Tilt
{
"value" : "number",
"unit" : "degree"
}
Data Type = Tilt3D
{
"x": {
"value" : "number",
"unit" : "degree"
},
"y": {
"value" : "number",
"unit" : "degree"
} ,
"g": {
"value" : "number",
"unit" : "degree"
}
}
Data Type = DoorStatus
{
"value" : "boolean (true | false)",
"unit" : "bool"
}
Data Type = Temperature
{
"value" : "number",
"unit" : "degC"
}
Data Type = Temperature
same as above
Data Type = Shock
{
"value" : "number",
"unit" : "g"
}
Data Type = Shock3D
{
"x": {
"value" : "number",
"unit" : "g"
},
"y": {
"value" : "number",
"unit" : "g"
} ,
"z": {
"value" : "number",
"unit" : "g"
}
}
| Event Type | Data Type | Unit Type | Description |
|---|---|---|---|
battery |
Battery | percent | Remaining battery level in percentage |
geoLocation |
GeoLocation | degrees, degrees, meters | Latitude and longitude of the location in either GPS coordinates, cell tower coordinates, or cell tower triangulation coordinates. Altitude is optional |
pressure |
Pressure | hPa | Ambient pressure |
vibration |
Vibration | boolean | Motion detected (T/F) |
humidity |
Humidity | percent | Ambient relative humidity |
light |
Light | lux | Ambient light |
tiltMagnitude |
Tilt | degrees | Magnitude of vertical tilt angle |
tilt |
Tilt3D | degrees, degrees, degrees | Tilt angle on each axis - x, y, z |
doorStatus |
DoorStatus | boolean | Door open/closed (T/F) |
ambientTemp |
Temperature | degC | Ambient temperature |
cargoTemp |
Temperature | degC | Temperature from probe |
shockMagnitude |
Shock | g | Magnitude of shock (as an acceleration) |
shock |
Shock3D | g, g, g | Shock on each axis - x, y, z (as an acceleration) |
Example Payload
Example payload for a typical message
[
{
"source": {
"id": "{{Sensor ID}}",
"type": "{{Sensor Type}}"
},
"time": "1642107080902",
"events": {
"geoLocation": {
"type": "GeoLocation",
"value": {
"lat": {
"value": "41.40338",
"unit": "degree"
},
"lon": {
"value": "2.17403",
"unit": "degree"
},
"alt": {
"value": "1000.0",
"unit": "m"
}
}
},
"battery": {
"type": "Battery",
"value": {
"value": "88.8",
"unit": "percent"
}
},
"cargoTemp": {
"type": "Temperature",
"value": {
"value": "68.8",
"unit": "degC"
}
},
"ambientTemp": {
"type": "Temperature",
"value": {
"value": "62.8",
"unit": "degC"
}
}
}
},
{
"source": {
"id": "{{Sensor ID}}",
"type": "{{Sensor Type}}"
},
"time": "1642107080902",
"events": {
"custom-AreaEntry": {
"type": "StringType",
"value": {
"value": "ENTRY"
}
},
"shockMagnitude": {
"type": "Shock",
"value": {
"value": "88.8",
"unit": "g"
}
},
"ambientTemp": {
"type": "Temperature",
"value": {
"value": "62.8",
"unit": "degC"
}
}
}
}
]
The example payload to the right is a fully populated TelemetryMessage.
Inbound API
Version 1.0
ParkourSC provides standard RESTful APIs to interact with the platform. The format of the telemetry message payload is described in Event Modeling.
RESTful Interface
Inbound Telemetry API
POST $baseURL/api/2/telemetry
Call this API to post telemetry data to the platform.
Outbound Telemetry
This section covers the sensor metrics request and response.
Get Shipment Telemetry Data (On-Demand)
POST $baseURL/api/2/shipment/{externalId}/metrics?entityTypeKey={entityTypeKey}
This api is used to get sensor metrics for shipment assets using from and to time. Asset will be optional array accepting external Id and entityTypeKey.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
externalId |
Path | true | Shipment external Id. |
entityTypeKey |
Request | true | Object type for shipment. |
limit |
Request | false | Number of records to be pulled. Default value 1000. Maximum 1000 records can be pull at a time for each paginated call |
offset |
Request | false | Page number. Default value 0 |
Request Class Model for fetching Telemetry Data of Shipment
| Attribute | Required | Format | Description |
|---|---|---|---|
| assets | true | string | Array of all assets that are part of the shipment
|
| from | true | string | Time in ISO Date Format e.g. 2023-02-24T20:23:34.000000Z |
| to | true | string | Time in ISO Date Format e.g. 2023-02-24T20:23:34.000000Z |
| scrollId | true | string | This is required parameter from offset 1. Value of srollId will be part of each response |
Request Format
{
"from": “2023-02-24T20:23:34.000000Z”,
"to": “2023-02-24T20:23:34.000000Z”,
"assets": [
{
"externalId": "{{asset external id}}",
"entityTypeKey": "{{asset type}}"
},
{
"externalId": "{{asset external id}}",
"entityTypeKey": "{{asset type}}"
}
]
}
Response Format
{
"shipmentExternalId": "DHL Aps bind test 2 from wc orig",
"shipmentType": "standardshipment",
"assets": [
{
"assetExternalId": "APPS 10008 7K",
"assetType": "APSS",
"assetName": "APPS 10008 7K",
"conditionalData": [
{
"conditionName": "Light",
"deviceId": "3737C15052332007",
"value": "257.0",
"uom": "Lux",
"timestamp": 1677270214000,
"datetime": "2023-02-24T20:23:34.000000Z"
},
{
"conditionName": "Humidity",
"deviceId": "3737C15052332007",
"value": "45",
"uom": "%",
"timestamp": 1677270214000,
"datetime": "2023-02-24T20:23:34.000000Z"
},
{
"conditionName": "Battery",
"deviceId": "3737C15052332007",
"value": "100",
"uom": "%",
"timestamp": 1677270214000,
"datetime": "2023-02-24T20:23:34.000000Z"
},
{
"conditionName": "Temperature",
"deviceId": "3737C15052332007",
"value": "23.1",
"uom": "C",
"timestamp": 1677270214000,
"datetime": "2023-02-24T20:23:34.000000Z"
}
]
}
],
"limit": 500,
"offset": 0,
"totalRecordCount": 253450,
"isDirty": false,
"scrollId": "eyJvZmZzZXQiOjAsImxpbWl0Ijo1MDAsImV4dGVybmFsSWQiOiJESEwgQXBzIGJpbmQgdGVzdCAyIGZyb20gd2Mgb3JpZyIsInRvdGFsUmVjb3JkQ291bnQiOjI1MzQ1MH0="
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Shipment Telemetry Data Snapshot
GET $baseURL/api/2/shipment/{externalId}/metrics?entityTypeKey={entityTypeKey}
This api is used to get sensor metrics for shipment using last snapshot.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
externalId |
Path | true | Shipment external Id. |
entityTypeKey |
Request | true | Object type for shipment. |
Request Format
N/A
Response Format
{
"shipmentExternalId": "",
"shipmentType": "",
"assets": [
{
"assetExternalId": "",
"assetType": "",
"assetName": "",
"conditionalData": [
{
"conditionName": "Canonical Name",
"deviceId": "",
"value": "",
"uom": "",
"timestamp": "Unix timestamp", //long value
"datetime": "ISO Date format represenation"
}
]
}
]
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Asset Telemetry Location Data (RT38.0.1)
POST $baseURL/api/2/asset/{externalId}/metrics/location?entityTypeKey={entityTypeKey}
This api is used to get location metrics for asset
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
externalId |
Path | true | Asset external Id. |
entityTypeKey |
Request | true | Object type for asset. |
limit |
Request | false | Number of records to be pulled. Default value 1000. Maximum 1000 records can be pull at a time for each paginated call |
offset |
Request | false | Page number. Default value 0 |
Request Class Model for fetching Telemetry Data of Shipment
| Attribute | Required | Format | Description |
|---|---|---|---|
| from | true | string | Time in ISO Date Format e.g. 2023-02-24T20:23:34.000000Z |
| to | true | string | Time in ISO Date Format e.g. 2023-02-24T20:23:34.000000Z |
| scrollId | true | string | This is required parameter from offset 1. Value of srollId will be part of each response |
Request Format
{
"from": “2024-10-09T01:23:34.000000Z”,
"to": “2024-10-11T20:23:59.000000Z”
}
Response Format
{
"asset": {
"assetExternalId": "09102024101738",
"assetType": "asset",
"assetName": "AssetName-09102024101738",
"conditionalData": [
{
"deviceId": "09102024101843",
"timestamp": 1728449607709,
"datetime": "2024-10-09T04:53:27.709000Z",
"gps": "16.9890648,82.2474648"
},
{
"deviceId": "09102024101843",
"timestamp": 1728449663967,
"datetime": "2024-10-09T04:54:23.967000Z",
"gps": "16.9890648,82.2474648"
},
{
"deviceId": "09102024101843",
"timestamp": 1728449725735,
"datetime": "2024-10-09T04:55:25.735000Z",
"gps": "17.3261049426153,82.86549509917252"
},
{
"deviceId": "09102024101843",
"timestamp": 1728449732279,
"datetime": "2024-10-09T04:55:32.279000Z",
"gps": "17.490828673377415,82.51508247608912"
},
{
"deviceId": "09102024101843",
"timestamp": 1728449738634,
"datetime": "2024-10-09T04:55:38.634000Z",
"gps": "17.637417569440316,82.40965895884132"
}
]
},
"limit": 5,
"offset": 0,
"totalRecordCount": 19,
"isDirty": false,
"scrollId": "eyJvZmZzZXQiOjAsImxpbWl0Ijo1LCJleHRlcm5hbElkIjoiMDkxMDIwMjQxMDE3MzgiLCJ0b3RhbFJlY29yZENvdW50IjoxOX0="
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Get Asset Telemetry Conditional Data (Beta - RT38.0.1 )
POST $baseURL/api/2/asset/{externalId}/metrics/all?entityTypeKey={entityTypeKey}
This api is used to get conditional metrics for asset. You can get 1 years data from current date using this API.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
externalId |
Path | true | Asset external Id. |
entityTypeKey |
Request | true | Object type for asset. |
limit |
Request | false | Number of records to be pulled. Default value 1000. Maximum 1000 records can be pull at a time for each paginated call |
offset |
Request | false | Page number. Default value 0 |
Request Class Model for fetching Telemetry Data of Shipment
| Attribute | Required | Format | Description |
|---|---|---|---|
| from | true | string | Time in ISO Date Format e.g. 2023-02-24T20:23:34.000000Z |
| to | true | string | Time in ISO Date Format e.g. 2023-02-24T20:23:34.000000Z |
| scrollId | true | string | This is required parameter from offset 1. Value of srollId will be part of each response |
Request Format
{
"from": “2024-09-27T01:23:34.000000Z”,
"to": “2024-09-28T20:23:59.000000Z”
}
Response Format
{
"asset": {
"assetExternalId": "09102024101738",
"assetType": "asset",
"assetName": "AssetName-09102024101738",
"conditionalData": [
{
"propertyName": "180F:2A19",
"conditionName": "Battery",
"deviceId": "27092024023058",
"value": "21",
"uom": "%",
"timestamp": 1727427735250,
"datetime": "2024-09-27T09:02:15.250000Z",
"gps": "16.9890648,82.2474648"
},
{
"propertyName": "37C7BB40-B06A-11E3-8000-B70F3AB862A4:ambientTemp",
"conditionName": "Ambient Temperature",
"deviceId": "27092024023058",
"value": "63.0",
"uom": "C",
"timestamp": 1727427735250,
"datetime": "2024-09-27T09:02:15.250000Z",
"gps": "16.9890648,82.2474648"
},
{
"propertyName": "37C7BB40-B06A-11E3-8000-B70F3AB862A4:cargoTemp",
"conditionName": "Cargo Temperature",
"deviceId": "27092024023058",
"value": "20.0",
"uom": "C",
"timestamp": 1727427735250,
"datetime": "2024-09-27T09:02:15.250000Z",
"gps": "16.9890648,82.2474648"
},
{
"propertyName": "AA20:AA21",
"conditionName": "Humidity",
"deviceId": "27092024023058",
"value": "47",
"uom": "%",
"timestamp": 1727427735250,
"datetime": "2024-09-27T09:02:15.250000Z",
"gps": "16.9890648,82.2474648"
},
{
"propertyName": "Door:doorStatus",
"conditionName": "Door",
"deviceId": "27092024023058",
"value": "false",
"uom": "boolean",
"timestamp": 1727427735250,
"datetime": "2024-09-27T09:02:15.250000Z",
"gps": "16.9890648,82.2474648"
}
]
},
"limit": 5,
"offset": 0,
"totalRecordCount": 19,
"isDirty": false,
"scrollId": "eyJvZmZzZXQiOjAsImxpbWl0Ijo1LCJleHRlcm5hbElkIjoiMDkxMDIwMjQxMDE3MzgiLCJ0b3RhbFJlY29yZENvdW50IjoxOX0="
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Shipment Exceptions
This section covers the violations for shipments request and response.
Get Shipment Exceptions (RT38.0.2)
GET $baseURL/{externalId}/exceptions?entityTypeKey={entityTypeKey}&from={from}&to={to}
This api is used to get exception for shipment using from and to time accepting external Id and entityTypeKey.
Path and Query Parameters
| Parameter | Type | Required | Usage |
|---|---|---|---|
token |
Header | true | JWT token received via Login API call. |
externalId |
Path | true | Shipment external Id. |
entityTypeKey |
Request | true | Object type for shipment. |
from |
Request | string | Time in ISO Date Format e.g. 2024-10-21T06:33:56.279000Z |
to |
Request | string | Time in ISO Date Format e.g. 2024-10-23T06:33:56.279000Z |
> Request Format
N/A ```
Response Format
{
"shipmentExternalId": "23102024115132",
"shipmentType": "standardshipment",
"shipmentName": "Sship-23102024115132",
"assets": [
{
"assetExternalId": "APPS 10008 7K",
"assetName": "APPS 10008 7K",
"exceptions": {
"Shock:rxShockMagnitude": [
{
"streamId": "1b3b69e7-95ef-4e1b-a259-5437acee61fb",
"lat": 16.9890648,
"lon": 82.2474648,
"deviceTime": 1729665236279,
"propertyValue": "31.664",
"propertyName": "Shock:rxShockMagnitude",
"canonicalPropertyName": "Shock:rxShockMagnitude",
"violationType": "Shock",
"violationTypeGroup": "Conditions",
"recipeId": "b2e37c5b-ee2b-4f11-887c-db4171cd8e6a",
"violationResolutionState": "Open",
"shipId": "fdff7c84-3cce-4cf8-9504-6e33473da1fb",
"eventUnit": "g",
"severity": "Critical",
"alertStatus": "Active",
"actionRequired": true,
"violated": true,
"dateTime": "2024-10-23T06:33:56.279000Z"
}
],
"Light:rxLight": [
{
"streamId": "1b3b69e7-95ef-4e1b-a259-5437acee61fb",
"lat": 16.9890648,
"lon": 82.2474648,
"deviceTime": 1729665236279,
"propertyValue": "18.0",
"propertyName": "Light:rxLight",
"canonicalPropertyName": "Light:rxLight",
"violationType": "Light",
"violationTypeGroup": "Conditions",
"recipeId": "5abc8565-abe8-4a59-8527-656749799834",
"violationResolutionState": "Open",
"shipId": "fdff7c84-3cce-4cf8-9504-6e33473da1fb",
"eventUnit": "Lux",
"severity": "Warning",
"alertStatus": "Active",
"actionRequired": true,
"violated": true,
"dateTime": "2024-10-23T06:33:56.279000Z"
}
]
}
}
]
}
Response Codes
| Parameter | Type |
|---|---|
200 |
Ok |
401 |
Access Denied |
500 |
Internal Server error |
Error Message Format
Version 1.0
Error Message Format
{
"errors": [
{
"code": "400",
"message": "You can not update values of field externalId",
"messageKey": "instance.nonupdatable.fields",
"messageParams": [
"externalId"
],
"details": {
"severity": 3,
"correlationId": null
},
"exception": null
}
],
"status": "FAILURE",
"statusCode": 400,
"metadata": null,
"errorsCount": 1,
"data": null
}
This section covers the error message format used for ParkourSC APIs.
Whenever an 4XX error occurs, the response shall contain a message in the following format shown, where the message attribute contains detailed information about the error, and it's corresponding error code.
Recipes
Overview
Unlock the power of Recipes — short, low-code snippets crafted with ParkourSC’s scripting language to define supply chain entity behaviors triggered by various events. These Recipes allow for effortlessly creating a digital twin of your real-world supply chain. Recipes can be seamlessly adapted to changes and growth over time, ensuring your operations stay ahead of the curve with a dynamic digital twin.
Creating Recipes
Recipes can be created, as needed, on the entity in the Catalog or using the Recipes workspace. Recipes are defined through a combination of simple configuration, a trigger, and code snippet to drive the desired behaviors for the entities created as part of the supply chain digital twin
Recipe Configuration
Mode:
- Test Mode: If you select the recipe mode as 'TEST' it will only be available to be execute as part of the recipe test bench.
- Prod Mode: If you select the recipe mode as 'PROD' it will be executed automatically against all relevant instances in your tenant as per the trigger specified.
Status:
- Enabled: If the recipe status is set to 'Enabled' then the recipe will be allowed to be executed whether that is in test mode or in prod mode.
- Disabled: If the recipe status is set to 'Disabled' then the recipe will not be allowed to be executed regardless of whether it is in test mode or in prod mode.
Recipe Triggers
We support the following triggers for recipes:
- Create - recipe is executed when the entity instance object is created
- Update - recipe is executed when the the entity instance object is updated
- Timer - recipe is executed on a timer based on the interval provided (minimum interval time is enforced). Only supported for shipment entity instance objects currently
- Event - recipe is executed when a streaming event is received. Type of streaming event can be selected or set to ANY
- Violation - recipe is executed when any violation is generated, i.e. a rule is triggered due the "violation" of the rules defined conditions
- UI - recipe is executed via the UI for a given entity instance object
- Collaboration Post - recipe is executed when a post if made to the collaboration channel for a given entity instance object
- Custom Event - recipe is executed is a custom event is published by another recipe
- Function - this recipe is executed from another recipe as a "function" call ## Tutorials
Introduction to Recipe Code
Recipe Code is the scripting language for Recipes. It is a high-level, untyped, and interpreted language that supports basic constructs common to most scripting languages. It can be leveraged to automate the execution of simple tasks. Programs written in Recipe Code are called Recipes, and are run in a special runtime environment on the ParkourSC Behavior Engine.
Recipe Structure
- A recipe is composed of a set of statements.
- Statements are terminated by a semicolon
;or;\n - Statements can be expressions, assignments or control structures.
- One symbol table contains all local variables, and is accessible to all statements in the recipe.
- Payload is passed to the recipe as the local variable
@input - Variables can be persisted and accessed across invocations of the recipe by using the config data structure on the instance.
Comments
/\* this is a comment \*/
Comments can be inserted in Recipe Code as follows:
Variables
"string" or 'string'
@var = "Hello Recipe" ;
- Literal string supported with single or double quotes.
- Local variables are referenced with an
@symbol. -
thisis a reserved keyword, used to reference the "current" asset. The parser swapsthisfor the[asset]at runtime. - Variables can be persisted or retreived using
db.setPropertyanddb.getProperty. See built-in functions below.
Operators
/\* addition \*/
@var = 1+2;
@newvar = @var+1;
@var++;
@newvar += 1;
/\* subtraction \*/
@var = 2-1;
@newvar = @var-1;
@var--;
@var -= 1;
/\* multiply \*/
@var = 2\*3;
@newvar = @var\*3;
@var \*= 3;
@newvar = @var \* (7\*@oldvar);
/\* divide \*/
@var = 6/3;
@newvar = @var/2;
@var /= 2;
Supports basic math operators:
-
+ -
- -
* -
/ -
+= -
-= -
*= -
/= -
++ -
--
Control Structures
/\* equal check \*/
if( @var == 1 ) {
/\* do something \*/
/\* nested if( ) NOT supported \*/
}
/\* greater than || less than \*/
else if( @var > 1 ) {
/\* do something \*/
}
else {
/\* do something else \*/
/\* nested { } NOT supported \*/
}
Supports if( ) { … } as well as else if( ) { … } else { … }
Supports basic comparison operators within if ( … ):
-
== -
!= -
&& -
|| -
> -
>= -
< -
<=
Functions
/\* takes @seed as argument and returns a random number \*/
@seed = 123;
@randomNumber = system.random;
Built-in functions are available within recipes and can be called as
system.\*(system capabilities),calendar.\*(date-time manipulation), orjson.\*(manipulating json structures)No arguments are passed explicitly to the built-in function. A copy of the entire symbol table is passed with the function call.
Arguments needed for each built-in function are documented with the glossary of built-in functions here.
Samples
Sample Payload
"metrics": [
{
"temp": "28",
"humidity": "86"
}
]
Recipe Invocation
@source = @input;
@t = json.temp;
@h = json.humidity;
A recipe is invoked for each element in the metrics array. When invoked for metrics[0], the payload can be accessed within the recipe using the following Recipe Code:
Sample Recipes
HighHumidityAlert
/\* parse humidity from payload \*/
@source = @input;
@humidity = json.humidity;
/\* check humidity condition and create alert \*/
if ( @humidity > 84 ) {
@title = "High Humidity Alert - "+@humidity;
db.newAlert;
}
HumidityStats
/\* parse humidity from payload \*/
@source = @input;
@humidity = json.humidity;
/\* check aggregate value \*/
@property = "aggregateHumidity";
@isThere = db.hasProperty;
if(@isThere == false) {
/\* first time \*/
@aggregateHumidity = 0;
}
@aggregateHumidity += @humidity;
/\* save aggregate value \*/
@property = "aggregateHumidity";
@value = @aggregateHumidity;
db.setProperty;
/\* check aggregate value \*/
@property = "aggregateHumidityCount";
@isThere = db.hasProperty;
if( @isThere == false) {
/\* first time \*/
@aggregateHumidityCount = 0;
}
@aggregateHumidityCount += 1;
/* save aggregate value */
@property = "aggregateHumidityCount";
@value = @aggregateHumidityCount;
db.setProperty;
/\* check standard deviation and alert \*/
@averageHumidity = @aggregateHumidity/@aggregateHumidityCount;
@pctDeviation = (@humidity-@averageHumidity)\*100/@averageHumidity;
if( @pctDeviation > 20 ) {
@title = "Sharp rise in Humidity - "+@humidity;
db.newAlert;
}
if( @pctDeviation < -20 ) {
@title = "Sharp drop in Humidity - "+@humidity;
db.newAlert;
}
MinorTempIncident
/\* parse temperature from payload \*/
@source = @input;
@temp = json.temp;
/\* check temperature condition and create incident \*/
if (@temp > 80) {
@summaryTitle = "High Temperature";
@description = "Temperature exceeding acceptable limits: " + @temp + "F, exceeds 80F limit";
@priority = "MINOR";
@assignedTo = "rob";
@incidentType = "TEMPERATURE";
db.newIncident;
}
UpgradeTempIncident
/\* parse temperature from payload \*/
@source = @input;
@temp = json.temp;
/\* check temperature and upgrade incident if temperature above critical limit \*/
if (@temp > 120) {
/\* upgrade priority for incident \*/
@priority = "CRITICAL";
@incidentType = "TEMPERATURE";
db.updateIncidentPriority;
}
ResolveTempIncident
/\* parse temperature from payload \*/
@source = @input;
@temp = json.temp;
/\* check temperature and resolve incident if temperature returns below normal \*/
if (@temp < 80) {
@incidentType = "TEMPERATURE";
db.resolveIncident;
}
Triggers
Recipe Triggers
FUNCTION:
This trigger is used to create the recipes that can be treated as functions and are called by other recipes. These type of recipes therefore become “reusable” code that can be executed by more than one recipe associated with this entity type.
UPDATE:
This trigger is used to execute recipes when the instance attribute data is updated.
CREATE:
This trigger is used to execute recipes when the instance has been created.
PROPERTIES:
This trigger is used to execute recipes when specific attributes of the instance are updated.
TIMER:
This trigger is used to execute the recipe on a cycle based on the time duration specified as part of the trigger. Note a global scheduler runs every 60 mins to determine which timer recipes need to be executed and therefore the minimum duration to be specified for the time interval is 60 mins. The combination of when the recipe is created and the global scheduler execution time cycle could result in the recipe executing with a delay instead of exactly at the time interval specified in this recipe trigger.
EVENT:
This trigger is used to execute a recipe based on streaming event data that is being received for this particular instance. Based on the trigger selections the recipe will execute when the trigger conditions are satisfied.
VIOLATION:
This trigger is used to execute a recipe if a violation is generated against this particular instance by a business rule.
UI:
This trigger is used to execute the recipe manually via the UI on the details page for this instance.
COLLABORATION POST:
This trigger is used to execute a recipe anytime a new message post is sent to the collaboration app component for a given instance.
CUSTOM EVENT:
This trigger is used to create recipes that will be triggered whenever a custom event is published.
Recipe Test Bench
Using the Recipe Test Bench
You can test various recipes using the Recipes Test Bench functionality provided as part of the Recipes workspace in the platform. The recipes test bench allows you to select a particular instance in the platform and execute a recipe against it by manually triggering the recipe including mocking the any data to be provided as part of the trigger and monitoring the recipe execution.
Triggering Recipes
To trigger and test a recipe we begin first by selecting the instance that we want to execute the recipe against for testing purposes.
Once an instance is selected we will then click on the “Test Recipe” button to test execute the recipe against this specific instance.
This will open the recipe test execution page for that instance.
We will now select the different recipe triggers available, update any associated trigger data and click on execute.
This will in turn trigger one or more recipes for that instance based on the selected trigger and using the trigger data provided.
The recipe or recipes execution output will be shown in the Datastream and Console depending on the recipe code.
Test Triggers
CHANGELOG
You can simulate the changelog topic recipes(postCreate and postUpdate operations) using changelog type.
Payload:
{
"id": "2f95db51-df48-4f23-835f-2b179123b6e0",
"tenant_id": "1e779185-72b4-4287-afea-2d931017e02d",
"type": "custodyasset",
"base_type": "custodyasset",
"graph_type": null,
"properties": {
"modifiedAt": "1681131806044",
"baseClass": "asset",
"parentEntityType": "custodyasset",
"type": "Custody Asset",
"createdAt": "1681131806044",
"imageURL": "https://clf-webapp-storage.s3.amazonaws.com/Catalog_Entity_Icons/custody+assets.svg",
"clfMappingType": "custodyasset",
"modifiedBy": "rameshqaproddvp2",
"id": "2f95db51-df48-4f23-835f-2b179123b6e0",
"monitoredStatus": "UNMONITORED",
"custodyStatus": "AVAILABLE",
"entityType": "Custody Asset",
"externalId": "TESTLOG1",
"catalogName": "Custody Asset",
"condition": "Good",
"deleted": "false",
"entityTypeKey": "custodyasset",
"taggedAssetId": "418d13d4-c8dd-49ca-b100-189c876fef2a",
"createdBy": "rameshqaproddvp2",
"organization": "45d92c3b-49d2-49b7-b952-d8d577c7722e",
"name": "TESTLOG1",
"tenantId": "1e779185-72b4-4287-afea-2d931017e02d",
"toParty": "",
"entityTypeId": "03c957b0-f617-496c-bfa4-a033ba22197e",
"typeId": "03c957b0-f617-496c-bfa4-a033ba22197e",
"category": "custodyasset",
"qrBarCode": "qavcoed",
"status": "ACTIVE"
}
}
STREAM
You can simulate the recipes for stream events data(timer, tagged-asset and shipment stream events) using stream type.
Payload:
EXAMPLE 1(TIMER)-
{
"object_id": "4650ac54-6df6-46df-8c9b-ef33e9327fc0",
"tenant_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"source_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974_OUT_OF_COVERAGE",
"source_type": "APP",
"property_name": "37C7BB40-B06A-11E3-8000-B70F3AB862A4:cargoTemp",
"stream_type": "TAGGEDASSET"
}
EXAMPLE 2(TAGGEDASSET)-
{
"object_id": "4650ac54-6df6-46df-8c9b-ef33e9327fc0",
"tenant_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"source_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974_OUT_OF_COVERAGE",
"source_type": "APP",
"property_name": "37C7BB40-B06A-11E3-8000-B70F3AB862A4:cargoTemp",
"stream_type": "TAGGEDASSET"
}
EXAMPLE 3(SHIPMENT)-
{
"object_id": "eaeb29f4-2a1b-40bb-8576-dd8d8c161f18",
"tenant_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"source_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974_OUT_OF_COVERAGE",
"source_type": "APP",
"property_name": "37C7BB40-B06A-11E3-8000-B70F3AB862A4:cargoTemp",
"stream_type": "SHIPMENT"
}
VIOLATION
You can simulate the recipes for violation events data(tagged-asset and shipment violation events) using violation type.
Payload:
EXAMPLE 1(TAGGEDASSET)-
{
"object_id": "4650ac54-6df6-46df-8c9b-ef33e9327fc0",
"object_type": "TAGGEDASSET",
"tenant_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"context_id": "6dc1e3be-1947-41e3-85e1-237a392cb0ca",
"context_type": "ASSET",
"property_name": "37C7BB40-B06A-11E3-8000-B70F3AB862A4:cargoTemp",
"property_value": "180.0"
}
EXAMPLE 2(SHIPMENT)-
{
"object_id": "4650ac54-6df6-46df-8c9b-ef33e9327fc0",
"object_type": "TAGGEDASSET",
"tenant_id": "ecb9fc95-8461-4f18-9f97-eb2bda3fb974",
"context_id": "eaeb29f4-2a1b-40bb-8576-dd8d8c161f18",
"context_type": "SHIPMENT",
"property_name": "Shipment:status",
"property_value": "At Destination"
}
Built-In Functions
System
system.random
@seed = 123;
@randomNumber = system.random;
used to generate a stream of pseudorandom numbers. Uses a seed, which is modified using a linear congruential formula
arguments:
@seed - seed variable
return:
@randomNumber - random number between 0 and 1.
system.uuid
@uniqueId = system.uuid;
used to generate a cryptographically strong 16-digit random number
arguments:
n/a
return:
@uniqueId - 16-char alpha-numeric unique Id
system.int
@value = '123.445';
@intVal = system.int; /* @intVal is '123' */
drops values after decimal to convert to an int
arguments:
@value - numeric value
return:
@intVal - new integer value
system.base64encode
@input = 'defaultKey';
@encString = system.base64encode;
base64encode the input string
arguments:
@input - input string
return:
@encString - base64encoded String
example:
system.substitute
@source = 'replace oldWord with newWord';
@orig = 'oldWord';
@repl = 'newWord';
@newStr = system.substitute;` /* @newStr is 'replace newWord with newWord' */
string replace
arguments:
@source - source string
@orig - original substring to search and replace
@repl - replacement string to replace original with
return:
@newStr - new string post-substitution
system.isEmpty
@source = 'color';
@isThere = system.isEmpty;
check if a property empty for the instance
arguments:
@source - Name of the property to check
return:
"1.0" | "0.0"
system.pad02
@source = '1';
@newNum = system.pad02; /* @newNum is '01' */
pad a single digit number with leading 0s. 1 will become 01, etc.
arguments:
@source - input digit
return:
@newNum - new number
system.searchString
@source = 'search for thisWord in source string';
@keyword = 'thisWord';
@idx = system.searchString; /* @idx is 11 */
returns index of keyword within a larger string. returns -1, if keyword is not found
arguments:
@source - input string
@keyword - search keyword
return:
@idx - index of keyword or -1
system.searchRegexString [RT38]
@regex = "\bCA01\b";
@source= object.name;
@idx = system.searchRegexString; /* @idx is 11 */
returns index of keyword within a larger string. returns -1, if keyword is not found
arguments:
@source - input string
@regex - regex pattern
return:
@idx - index of keyword or -1
system.subString
@source = 'extract substring starting at thisWord in source string';
@fromIdx = 30;
@subStr = system.subString; /* @subStr is 'thisWord in source string' */
returns substring starting at given index within source
arguments:
@source - input string
@fromIdx - index of the start of the substring within source
return:
@subStr - substring within source or original string, if no substring found
system.formatNumber
@number = 100000000;
@pattern = '#M';
@formattedNumber = system.formatNumber; /* @formattedNumber is 1M */
returns formatted number
arguments:
@number - input string
@pattern - Support patterns such as ###,###,###.##, #.##, #,###k, #.##M. By default we use #.## , #k and #M
return:
@formattedNumber - The formatted number based on the provided pattern
Database
db.hasProperty
@property = 'color';
@isThere = db.hasProperty;
if( @isThere == true ) {
/* do something */
}
check if a property exists on the instance
arguments:
@property - name of property to check
return:
true|false
db.getProperty
@property = 'ip';
@val = db.getProperty;
if( @val != null ) {
/* do something */
}
get the value of a property on the instance
arguments:
@property - Name of property to get
return:
@val - value of the property, == null, if no value found
db.setProperty ASYNC
@property = 'color';
@value = 'blue';
db.setProperty;
set the value of a property on the instance for the extended attributes only
arguments:
@property - name of property
@value - value of property
return: n/a
db.updateViolationSeverity ASYNC
@severity = "INFO";
db.updateViolationSeverity;
update the violation severity
arguments:
@severity - value for severity
return:
n/a
db.publishViolation ASYNC
db.publishViolation;
update the violation severity
arguments:
@severity (optional) - INFO, WARNING, CRITICAL; Default value is WARNING
@outputMetric – Metric from Property Meta- Default value is Complex:behaviorScript
return:
n/a
db.resetViolation ASYNC
db.resetViolation;
reset the violation to a NORMAL severity
arguments:
n/a
return:
n/a
db.isNotified
@isNotified = db.isNotified;
if(@isNotified == true) {
/*Do something*/
}
check if a user is notified or not
arguments:
n/a
return:
true | false
db.getLastNotificationTime
if(@isNotified == true) {
@fromDate = db.getLastNotificationTime;
}
get the last notification time
arguments:
n/a
return:
DateTime(millis)
db.publishNotification ASYNC
@emailEndpoint = @toEmail;
@smsEndpoint = "Enter Phone Number";
@severity = "INFO";
@appEndpoint = @toParty;
db.publishNotification;
publish the notification
arguments:
@title – Title of the email/subject
@description – Description/body
@emailEndpoint – Comma-separated email Ids
@cc (optional)- Comma-separated email Ids
@bcc (optional) – Comma-separated email Ids
@smsEndpoint - Comma-separated phone numbers
@appEndpoint – Comma-separated user Ids
@severity (optional)- INFO, WARNING, CRITICAL-Default value is WARNING
@outputMetric – Metric from Property Meta- Default value is Complex:behaviorScript
return:
n/a
db.publishToWebhookSubscriber ASYNC
@webhookSubscriber = "subscriberName";
@xyz= object.name;
@webhookPayloadData = {
"eventTime": "Sample",
"packageName": @xyz,
"trackerName": "456",
"shipmentStatus": "In-Transit",
"cargoTemperature": "10",
"ambientTemperature": "10"
};
db.publishToWebhookSubscriber;
To publish the data to webhook
arguments:
@webhookSubscriber – Webhook subscriber name
@webhookPayloadData – Data object to publish
return:
n/a
db.publishEvent ASYNC[RT38]
@externalId = "SFTP_D3_03_7";
@entityTypeKey = "parcelshipment";
@eventTypeKey = "event type key";
@eventData = {
"name":"SFTP_D3_03_7",
"value":"TestValue"
};
db.publishEvent;
This function allows for publishing events (as a JSON structure) from one instance targeted towards another instance
arguments:
@externalId-A unique ID (string) to identify a specific instance of a given entity type.
@entityTypeKey- The entity type key (string) that identifies an existing entity type defined in the Catalog.
@eventTypeKey- This is an option parameter provided by the recipe author to include in the published custom event’s envelope.
@eventData- text (JSON text) that will be included in an event message that is published to the targeted instance identified by the @externalId and @entityTypeKey values
return:
n/a
db.getInstanceId [RT38]
@externalId = "SFTP_D3_03_7";
@entityTypeKey = "parcelshipment";
@id = db.getInstanceId;
This function returns a UUID for the instance that is identified by the provided inputs.
arguments:
@externalId-A unique ID (string) to identify a specific instance of a given entity type.
@entityTypeKey- The entity type key (string) that identifies an existing entity type defined in the Catalog.
return:
UUID - A UUID for the instance.
Object
object.getProperty
@property = 'color';
@value = object.getProperty;
get the value of the property on the instance
arguments:
@property - Name of the property to get
return:
@value – Value of the property
object.setProperty ASYNC
@property = 'color';
@value = 'blue';
object.setProperty;
set the value of the property on the instance for the extended attributes only
arguments:
@property - Name of the property
@value – Value of the property
return:
n/a
object.hasProperty
@property = 'color';
@isThere = object.hasProperty;
check if a property exists for the instance
arguments:
@property - Name of the property to check
return:
true | false
object.< property >
@value = object.color;
get the value of a property
arguments:
n/a
return:
@value – Value of the property
Event
event.< property >
@value = event.color;
get the value of an event property
arguments:
n/a
return:
@value – Value of an event property
Function
function.< functionName >
@log="This is a function call from another recipe";
log.info;
function.ViolationCheck;
To call the function from another recipe
syntax:
Trigger type: FUNCTION
Recipe Name: violationCheck
function.violationCheck;
return:
n/a
User
user.< property >
@userId="testUser";
@value = user.name;
get the value of a user property
arguments:
@userId = User ID to find user.
return:
@value – Value of a user property
Chain Of Custody
chainOfCustody.updateLifecycleStatus ASYNC
@status = "IN TRANSFER";
chainOfCustody.updateLifecycleStatus;
To update the lifecycle status of the custody aaset
arguments:
@status - Lifecycle status to be updated
return:
n/a
chainOfCustody.confirmReceipt ASYNC
chainOfCustody.confirmReceipt;
This function is used to perform the confirm receipt operation on custody asset arguments:
n/a
return:
n/a
chainOfCustody.checkIn ASYNC
@condition = "Good";
chainOfCustody.checkIn;
This function is used to perform the check-in operation on custody asset arguments:
@condition - Condition of custody asset
return:
n/a
Context
context.getProperty
@property = 'color';
@value = context.getProperty;
get the value of the property on the instance
arguments:
@property - Name of the property to get
return:
@value – Value of the property
context.hasProperty
@property = 'color';
@isThere = context.hasProperty;
check if a property exists for the context
arguments:
@property - Name of the property to check
return:
true | false
context.< property >
@value = context.color;
get the value of a property
arguments:
n/a
return:
@value – Value of the property
Log
log.< level >
@log = “This is an info log”;
log.info
print the logs
arguments:
@log - String
<level> – info, debug, error, warn, trace
return:
n/a
Calendar
calendar.utc
@utcTime = calendar.utc;
fetch current UTC time
arguments:
n/a
return:
@utcTime - UTC time
calendar.parseUtc
@datetime = '30-Jun-2019 15:52:40';
@utcTime = calendar.parseUtc;
parse UTC from date-time string "dd-MMM-yyyy HH:mm:ss"
arguments:
@datetime - date time string in the format "dd-MMM-yyyy HH:mm:ss"
return:
@utcTime - UTC time for datetime string provided
calendar.time
@timezone = 'America/Los_Angeles';
@timeStr = calendar.time;
fetch current time string in specific timezone
arguments:
@timezone - timezone in the format "America/Los_Angeles"
return:
@timeStr - time string in the specified timezone
calendar.year
@year = calendar.year;
fetch current year
arguments:
n/a
return:
@year - current year
calendar.month
@month = calendar.month;
fetch current month
arguments:
n/a
return:
@month - current month
calendar.dayOfMonth
@dayOfMonth = calendar.dayOfMonth;
fetch current day of month
arguments:
n/a
return:
@dayOfMonth - current day of month
calendar.dayOfWeek
@dayOfWeek = calendar.dayOfWeek;
fetch current day of week
arguments:
n/a
return:
@dayOfWeekt day of week
calendar.weekOfYear
@weekOfYear = calendar.weekOfYear;
fetch current week of year
arguments:
n/a
return:
@weekOfYear - current week of year
calendar.weekOfMonth
@weekOfMonth = calendar.weekOfMonth;
fetch current week of month
arguments:
n/a
return:
@weekOfMonth - current week of month
calendar.hour
@hour = calendar.hour;
fetch current hour
arguments:
n/a
return:
@hour - current hour
calendar.hourOfDay
@hourOfDay = calendar.hourOfDay;
fetch current hour of day
arguments:
n/a
return:
@hourOfDay - current hour of day
calendar.tzHourOfDay
@timezone = 'America/Los_Angeles';
@tzHourOfDay = calendar.tzHourOfDay;
fetch current hour of day in given timezone
arguments:
@timezone - timezone in the format "America/Los_Angeles" (default)
return:
@tzHourOfDay - current hour of day in the specified timezone
calendar.minute
@minute = calendar.minute;
fetch current minute
arguments:
n/a
return:
@minute - current minute
calendar.second
@second = calendar.second;
fetch current second
arguments:
n/a
return:
@second - current second
calendar.millisecond
@millisecond = calendar.millisecond;
fetch current millisecond
arguments:
n/a
return:
@millisecond - current millisecond
Shipment
shipment.getActiveShipment
@shipment = shipment.getActiveShipment;
@sourceObject = @shipment;
@keyName = "carrierCode";
@value = json.getAttribute;
To get the active shipment on asset.
arguments: n/a
return:
Shipment- It will return shipment object with properties.
shipment.completeShipment ASYNC[RT38]
shipment.completeShipment;
This function is used to send the shipment to complete status.
arguments:
@shipmentReference - Reference of shipment.
return: n/a
shipment.terminateShipment ASYNC[RT38]
shipment.terminateShipment;
This function is used to send the shipment to terminate status.
arguments:
@shipmentReference - Reference of shipment.
return: n/a
Model[RT38]
model.createModel ASYNC
@modelName = "TestModel";
@modelExternalId = "TestModel";
@modelTypeKey = "lotsizehorizon";
@modelParamsJSON = {
"IQVWeightage": "0.3",
"BatchesWeightage": "0.4",
"SetupTimeWeightage": "0.3"
};
@modelRunId = models.createModel;
This function is used to create the model.
arguments:
@modelName - Defines the Name of the model run instance that we will be creating
@modelExternalId - Defines the external ID for the model run instance and is optional
@modelTypeKey - Model type key for the specific model we are running against (example: lshmodel)
@modelParams - defines the attributes and parameter values we are passing to the function to create the model
return:
Run Id- It will return run Id of the created model.
model.runModel ASYNC
@modelRunId = models.createModel;
models.runModel;
This function is used to run the model.
arguments:
@modelRunId - Run Id of the created model
return: n/a
Collaboration[RT38]
collaboration.postMessage ASYNC
@id=object.id;
@message="Posting message from recipe for demo with </br><b>a new line break</b>";
@messageVisibilityType = "Collaborators";
collaboration.postMessage;
This function is used to post the message on collaboration channel.
arguments:
@externalId - Used to identify a specific instance of a given entity type by our customers where the collaboration message should be posted
@entityTypeKey - The entity type key for the instance
@id - Alternative to the externalId and entityTypeKey to identify an instance a UUID can be provided as well
@messageVisibilityType - Message can be one of "Public", "Collaborators", "Self"
@message - Full text of the message that is intended to be posted
return: n/a