You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Find below a list of resources that can be accessed via the xUML Runtime API.

xUML Service

ResourceMethodDescriptionAPI VersionBridge Version
/pstate/engineGETCheck if the xUML service uses persistent state and get general information on the persistent state configuration.1.0.0Runtime 2019.5
/statusGETGet the status of the persistent state server.1.0.0Runtime 2019.5
/stopPUTStop the running xUML service.1.0.0Runtime 2019.5

Persistent State

MultiExcerpt named adapter_runtime_api was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro

Persistent State Classes

ResourceMethodDescriptionAPI VersionBridge Version
/pstate/classesGETList all available persistent state classes.1.0.0Runtime 2019.5
/pstate/classes/{class}GETGet the persistent state object/state counters for a given class.1.0.0Runtime 2019.5
/pstate/classes/{class}/metaGETGet the persistent state metadata of a given class.1.0.0Runtime 2019.5

Persistent State Objects

ResourceMethodDescriptionAPI VersionBridge Version
/pstate/objects/{objectId}  GETGet the metadata of a given persistent state object. The object is identified by its ID.1.0.0Runtime 2019.5
DELETEDelete a persistent state object by its ID.1.0.0Runtime 2019.5
/pstate/objects/{objectId}/events GETGet all pending events of a persistent state object. The object is identified by its ID.1.0.0Runtime 2019.5
/pstate/objects/{objectId}/signals/completion POSTSend a completion signal to a persistent state object. The object is identified by its ID and the state it is stalled in.1.0.0Runtime 2019.5
/pstate/objects/{objectId}/states GETGet all states a persistent state object is in and possible transitions. The object is identified by its ID.1.0.0Runtime 2019.5
/pstate/queryObjects POSTGlobally, find persistent state objects matching the search criteria given by parameter.1.0.0Runtime 2019.5

Persistent State Objects of <class name>

ResourceMethodDescriptionAPI VersionBridge Version
/pstate/classes/<class name>/objectGET     Find a persistent state object of a given class by its primary key.1.0.0Runtime 2019.5
/pstate/classes/<class name>/objects/{objectId}GETGet the details of a persistent state object of a given class by its object ID.1.0.0Runtime 2019.5
/pstate/classes/<class name>/ objects/{objectId}/signals/<signal name>POSTSend the given signal to a persistent state object. The object is identified by its ID.1.0.0Runtime 2019.5
/pstate/classes/<class name>/queryObjectsPOST

Find all persistent state objects matching the search criteria given by parameter.

Due to a bug in Swagger UI, this resource cannot be tested with Swagger UI.

1.0.0Runtime 2019.5

Persistent State Owners

ResourceMethodDescriptionAPI VersionBridge Version
/pstate/ownersGET     Get a list of all persistent state owners and some details on the xUML services and objects they own.1.0.0Runtime 2019.5

Peristent State Events

ResourceMethodDescriptionAPI VersionBridge Version
/pstate/events/{eventId}GET     Get the details of a given persistent state event.1.0.0Runtime 2019.5
  • No labels