JUMP TOOverviewAPI Reference OverviewHow to use the API 'Try It' featureAuthentication And Authorization (AAA) ServiceRole ManagementCreate App RolepostGet all RolesgetUpdate a RoleputGet specific role information.getUser ManagementCreate UserpostGet all UsersgetUpdate UserputGet UsergetGet User RolesgetGet Apps assigned to UsergetBlock a UserpostUnblock a blocked UserpostGet the user info from access tokengetAuthenticationClient credentials grant tokenpostConnection ManagementGet all ConnectionsgetCreate a Social ConnectionpostGet Social ConnectiongetUpdate Social ConnectionputCreate SAML ConnectionpostGet SAML ConnectiongetUpdate SAML ConnectionputCreate OIDC clientpostUpdate OIDC clientputGet OIDC connectiongetGroup ManagementCreate GrouppostGet all GroupgetUpdate GroupputGet GroupsgetUpdate roles mapping for a GroupputUpdate Roles mapping for a GroupputParticipant ServiceTenantGet details of tenant.getUpdate details of tenant.putGet Attribute Config of Tenant.getUpdate Attribute Config of Tenant.putParticipant TypeCreate a new participant typepostGet all participant types and their configurationsgetGet configuration of a participant typegetUpdate participant type configurationputParticipant Type - Custom Code ConfigRegister custom code configurations of a Participant TypepostUpdate custom code configurations of a participant type.putGet custom code configurations of a participant typegetParticipant Type - Attributes ConfigGet core attributes configurations of a participant typegetUpdate core attributes configurations for a participant typeputParticipant Type - State MachineGet state-machine configurtion of a participant typegetUpdate state machine configuration for a participant typeputUpdate an EntityputGet all eventsgetCreate events for a participant-typepostUpdate events for a participant-typeputGet events for a participant-typegetAPI to get list of orphan event codes (not associated with any reason code).getPost reasons for a participant type.postGet all reasonsgetUpdate reasons for a participant type.putGet reasons for a participant type.getAPI to get list of orphan reasons codes (not associated with any reason code).getParticipantCreate a new participantpostGet list of participants of a participant type.getGet base & core attribute values of a participant.getUpdate core attributes of a participant.putTemplatesCreate a new TemplatepostGet list of Templates of a participant type and category.getGet a template with a given id.getUpdate a template with a given id.putParticipant StateGet the current state of the participant.getTransition the current state of the participant.putChange LogGet the participant type change loggetGet the audit trail of the participant details.getParticipant - Batch ProcessingPerform create operation on participants in batch.postPerform update operation on participants in batch.putGet the status of batch request.getPerform create operation on participants via file upload.postPerform update operation on participants via file upload.putGet the status of batch file request.getContainer ServiceContainer TypeCreate a new container typepostFetch container type details based on the filters passedgetGet container type deatils by containerTypeNamegetUpdate container type basic deatilsputContainer Type - Custom Code Configregister custom code configurations of a container typepostupdate custom code configurations of a container typeputget custom code configurations of a container typegetContainer Type - Attributes ConfigGet core attributes configurations of a container typegetUpdate core attributes configurations for a Container type.putContainer Type - State Machine ConfigGet state machine configuration of container typegetUpdate state machine configuration of container typeputUpdate an EntityputGet all eventsgetCreate events for a container-typepostUpdate events for a container-typeputGet events for a container-typegetAPI to get list of orphan event codes (not associated with any reason code).getAPI to get list of orphan event codes (not associated with any reason code).postGet all reasonsgetAPI to get list of orphan event codes (not associated with any reason code).putAPI to get list of orphan event codes (not associated with any reason code).getAPI to get list of orphan event codes (not associated with any reason code).getContainerCreate a containerpostFetch details of containergetUpdate attribute of ContainerputFetch container details based on the filters passed.getFetch details of container by trackingIdgetcontainerization/decontainerization of the containerputcontainerization/decontainerization of the containerputFetch details of containergetUpdate attribute of ContainerputContainer StateGet the current state of a containergetApply event on the container.putGet the current state of a containergetApply event on the container.putNew Mockget mockgetmockpostget mockgetget mockgetget mockgetmockgetmockmockgetContainer GroupAdd containers to a grouppostRemove containers from a grouppostGet list of containers of a groupgetApply event on a group of containerspostUpdate attributes of containers in bulkpostContainer - Batch ProcessingCreate container in batchespostPerform update operation on container in batchesputGet the status of batch requestgetPerform create operation on container via file uploadpostPerform update operation on container via file uploadputGet the status of batch file requestgetDispatch ServiceJob TypeCreate a new job typepostGet configuration of job typesgetGet configuration of a job typegetupdate a job typeputJob WorkflowCreate a new job workflow draftpostCreate a new job workflowpostGet job workflow by job workflow idgetUpdate job workflow statusputJobCreate a new jobpostUpdate job by job refputGet job by job idgetUpdate job by idputUpdate some values of custom data for a jobpatchChange status and subStatus of a jobpostChange sub status of a jobpostChange sub status of jobspostcancel the jobpostJob - ConfigGet attribute config of a job typegetPost attribute config for jobputDispatch TypeCreate a new dispatch typepostGet configuration of dispatch typesgetGet configuration of a dispatch typegetDispatchCreate a new dispatchpostUpdate all the values of custom data for a dispatchputUpdate some values of custom data for a dispatchpatchChange status and subStatus of a dispatchpostChange sub status of a dispatchpostAdd job to a dispatchpatchAdd multiple jobs to a dispatchpatchRemove multiple jobs from a dispatchdeleteRemove a job from dispatchdeleteUpdate job within dispatch on receiving acknowledgmentputAdd participant to a dispatchpatchAdd multiple participants to a dispatchpatchRemove a participant from dispatchdeleteChange status and subStatus of a dispatch by refpostChange sub status of a dispatch by refpostAdd job to a dispatch by refpatchAdd multiple jobs to a dispatch by refpatchRemove multiple jobs from a dispatch by refdeleteRemove a job from dispatch by refdeleteAdd participant to a dispatch by refpatchAdd multiple participants to a dispatch by refpatchRemove a participant from dispatch by refdeleteUpdate all the values of custom data for a dispatch by refputUpdate some values of custom data for a dispatch by refpatchMobile APIsRemove multiple jobs from dispatchputStatus update for an Execution WOrkflowpostStatus update for an Execution Worklow using workflow idputDispatch - ConfigGet attribute config of dispatchgetPost attribute config for dispatchputLedgerApply CustodyIn ScanpostApply CustodyOut ScanpostLedger in batchApply CustodyIn ScanpostApply CustodyOut ScanpostCustom Code Configregister custom code configurationspostupdate custom code configurationsputget custom code configurationsgetWorkflow ServiceExecution TaskRegister TaskpostGet TaskgetUpdate TaskputDelete TaskputChangelogGet Execution Task Change LoggetGet Execution Macro Change LoggetGet Execution Workflow Change LoggetExecution MacroRegister MacropostGet MacrogetUpdate MacroputDelete MacroputExecution WorkflowRegister WorkflowpostGet WorkflowgetUpdate WorkflowputExecution Workflow InstanceCreate Workflow InstancepostGet Workflow InstancegetUpdate Workflow InstanceputUpdate Task InstanceputHealth CheckDB Server HealthgetWorkflow WrapperJob WorkflowRegister a job workflowpostGet a specific job workflow or draftgetRegister a job workflow draftpostExecution MacroRegister a macropostGet a specific execution macrogetExecution WorkflowRegister a workflowpostGet a specific execution workflow or draftgetRegister a draftpostUpload ImageUpload workflow svg to s3 (image/svg+xml)postHealth CheckHealth of the DB ServergetSDS ServiceAppRegister ApplicationpostGet App DetailsgetUpdate App Public KeyputVaultCreate VaultpostGet VaultgetUpdate VaultputDataCreate DatapostGet DatagetUpdate DataputGet secure datagetFileUpload FilepostGet FilegetSearch FilesgetChange LogGet File Change LoggetChange log of appgetGet Vault Change LoggetGet Data Change LoggetFile Management ServiceFoldersCreate FolderpostGet all FoldersgetGet FoldergetUpdate FolderputFilesUpload FilepostSearch FilegetGenerates File IDpostGet FilegetUpdate FileputGet File StatusgetChangeLogFolder Change LoggetFile Change LoggetState Machine ServiceState Machine ConfigCreate State Machine ConfigpostGet State Machine ConfiggetUpdate State Machine ConfigputValidate State Machine ConfigpostEntityCreate EntitypostGet All EntitygetUpdate EntityputGet EntitygetValidate Entity StatepostEventsGet All EventsgetCreate EventpostUpdate EventputGet EventgetGet Orphan EventgetReasonsCreate ReasonpostGet All ReasonsgetUpdate ReasonputGet ReasongetGet Orphan ReasongetInstance StateOnboard InstancepostGet Instance StategetUpdate Instance EventputUpdate State EventputChange LogGet Entity Change LoggetGet Reason Change LoggetGet Event Change LoggetGet Entity Type Change LoggetGet Instance Change LoggetEntity ServiceEntity TypeCreate a new entity typepostGet all entity types and their configurationsgetGet configuration of a entity typegetUpdate entity type configurationputState Machine ConfigRegister State Machine Config for Entity TypepostGet configuration of a entity typegetUpdate entity type configurationputEntity InstanceCreate a new EntitypostGet list of Entities of a entity type.getGet base & core attribute values of a Entity.getUpdate core attributes of a Entity.putEntity Type - Custom Code Configregister custom code configurations of a entity typepostupdate custom code configurations of a entity typeputget custom code configurations of a entity typegetEntity Instance StateGet current state of the entity instancegetApply Event to the entity instanceputTemplatesCreate a new TemplatepostGet list of Templates of a entity type and category.getGet a template with a given id.getUpdate a template with a given id.putChange LogGet the entity type change loggetGet the audit trail of the Entity details.getEntity - Batch ProcessingPerform create operation on Entities in batch.postPerform update operation on Entities in batch.putGet the status of batch request.getPerform create operation on Entities via file upload.postPerform update operation on Entities via file upload.putGet the status of batch file request.getNotification ServiceApp NotificationAdd App Notification ConfigpostGet App Notification ConfiggetUpdate App Notification ConfigputFilterAdd FilterpostGet all FiltersgetGet FiltergetUpdate Filter StateputEventPush Event to KafkapostChange LogGet App Change LoggetGet Filter Change LoggetLocation ServiceLocationCreate LocationpostUpdate LocationputGet LocationgetCountryCreate CountrypostGet CountrygetUpdate CountryputUpload Country Info in BulkpostGet File StatusgetMovement Tracking ServiceTrace DataGET Trace DatagetUpdate Trace DataputMissing Sequence NumbersGET Missing Sequence NumbersgetIOT DeviceRegister Iot DevicepostGet Device DetailsgetDeregister DeviceputGet All DevicesgetGeofenceCreates GeofencepostDelete GeofenceputGet GeofencegetGet all GeofencesgetMTS SubscriptionCreates SubscriptionpostGet SubscriptiongetSet Topic to InactiveputOrder ServiceOrder Configcreate order configpostupdate order configputget the custom attributes of an ordergetOrder State Machine Configurationupdate state machine configuration for an orderputget state machine configuration for an ordergetOrder State Machine Transitionapply event on the order.putapply event on the order.putWork Order State Machine Configurationupdate state machine configuration for a work-orderputget state machine configuration for a work-ordergetWork Order State TransitionTransition the current state of a work-orderputTransition the current state of a work-order using client-detailsputOrderCreate a new orderpostUpdates the order attributesputGet Order DetailsgetTakes order cancellation requestputAdd workOrder to the orderputBatch OrderCreate orders in batchpostCustom Code Configregister custom code configurationspostupdate custom code configurationsputget custom code configurationsgetPlugin Callbackplugin callbackpostExternal Reference APIsUpdates order attributes by using client id and client order idputGet Order Details by using client id and client order idgetTakes order cancellation requestputWork Order ConfigCreate work order configpostupdate work order configputGet work order entity attributesgetWork Order Statusupdate work order statusputPluginsCreate a new pluginpostUpdate a pluginputGet a plugingetDelete a plugindeletePluginWorkflowcreate a new plugin workflowpostupdate a plugin workflowputfetch a plugin workflow detailsgetDelete a plugin workflowdeleteAddress ServiceAddress ConfigCreate Address ConfigpostGet Address ConfiggetGet all Address ConfiggetAddressCreate AddresspostGet all AddressesgetGet AddressgetUpdate AddressputUser framework appUser FPA APICreate a new User as a participant and AAApostGet list of all the currently added usersgetGet details of particular user with user idgetUpdate the properties of a particular user with user idputGet the current state of a particular usergetTransition the state of a particular user with its user id and transition eventputGet all designations present in the systemgetFacility APIFacility FPA APICreate a FacilitypostGet list of all the currently added FacilitiesgetGet a particular facility with facility idgetUpdate a particular facility with facility idputGet a particular facility state with facility idgetTransition a particular facility state with facility idputProperty APICreate a propertypostGet list of currently added propertiesgetGet a particular property with property idgetUpdate a particular property with property idputGet a particular property state with property idgetTransition a particular property state with property idputVehicle FPAVehicle FPA APICreate a new Vehicle as a participantpostGet a list of currently added VehiclesgetGet details of a particular vehicle with vehicle idgetUpdate details of a particular vehicle with vehicle idputGet the current state of a particular vehicle with vehicle idgetTransition the state of a particular vehicle with its vehicle id and transition eventputLogisticsOrder APIOrderCreate a new orderpostGet Order DetailsgetOrder cancellation requestputBatch OrderCreate orders in batchpostExternal AuthorizerAuthorizationValidate the input token.postAuthorizes the input request.postOrchestratorPluginsCreate a new pluginpostUpdate a pluginputGet a plugingetPluginWorkflowCreate a new plugin workflowpostUpdate a plugin workflowputFetch a plugin workflow detailsgetRulesCreate a new execution rulepostUpdate an execution ruleputGet an execution rule for a plugin-workflowgetGet all execution rules for an eventgetGet Entity StatusFetch plugin execution status by using Entity IDgetFetch rule execution status by using Entity IDgetFetch rule and plugin execution status on UI for the given Entity IDgetPowered by Delete a plugindelete https://{base_url}/core/api/v1/orders/plugins/{pluginId}Delete a plugin