On this Page:
xUML Service
Resource | Method | Description | API Version | Bridge Version |
---|---|---|---|---|
/pstate/engine | GET | Check if the xUML service uses persistent state and get general information on the persistent state configuration. | 1.0.0 | Runtime 2019.5 |
/status | GET | Get the status of the persistent state server. | 1.0.0 | Runtime 2019.5 |
/stop | PUT | Stop the running xUML service. | 1.0.0 | Runtime 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
Resource | Method | Description | API Version | Bridge Version |
---|---|---|---|---|
/pstate/classes | GET | List all available persistent state classes. | 1.0.0 | Runtime 2019.5 |
/pstate/classes/{class} | GET | Get the persistent state object/state counters for a given class. | 1.0.0 | Runtime 2019.5 |
/pstate/classes/{class}/meta | GET | Get the persistent state metadata of a given class. | 1.0.0 | Runtime 2019.5 |
Persistent State Objects
Resource | Method | Description | API Version | Bridge Version |
---|---|---|---|---|
/pstate/objects/{objectId}
| GET | Get the metadata of a given persistent state object. The object is identified by its ID. | 1.0.0 | Runtime 2019.5 |
DELETE | Delete a persistent state object by its ID. | 1.0.0 | Runtime 2019.5 | |
/pstate/objects/{objectId}/events
| GET | Get all pending events of a persistent state object. The object is identified by its ID. | 1.0.0 | Runtime 2019.5 |
/pstate/objects/{objectId}/signals/completion
| POST | Send a completion signal to a persistent state object. The object is identified by its ID and the state it is stalled in. | 1.0.0 | Runtime 2019.5 |
/pstate/objects/{objectId}/states
| GET | Get all states a persistent state object is in and possible transitions. The object is identified by its ID. | 1.0.0 | Runtime 2019.5 |
/pstate/queryObjects
| POST | Globally, find persistent state objects matching the search criteria given by parameter. | 1.0.0 | Runtime 2019.5 |
Persistent State Objects of <class name>
Resource | Method | Description | API Version | Bridge Version |
---|---|---|---|---|
/pstate/classes/<class name>/object | GET | Find a persistent state object of a given class by its primary key. | 1.0.0 | Runtime 2019.5 |
/pstate/classes/<class name>/objects/{objectId} | GET | Get the details of a persistent state object of a given class by its object ID. | 1.0.0 | Runtime 2019.5 |
/pstate/classes/<class name>/ objects/{objectId}/signals/<signal name> | POST | Send the given signal to a persistent state object. The object is identified by its ID. | 1.0.0 | Runtime 2019.5 |
/pstate/classes/<class name>/queryObjects | POST | Find all persistent state objects matching the search criteria given by parameter. | 1.0.0 | Runtime 2019.5 |
Persistent State Owners
Resource | Method | Description | API Version | Bridge Version |
---|---|---|---|---|
/pstate/owners | GET | Get a list of all persistent state owners and some details on the xUML services and objects they own. | 1.0.0 | Runtime 2019.5 |
Peristent State Events
Resource | Method | Description | API Version | Bridge Version |
---|---|---|---|---|
/pstate/events/{eventId} | GET | Get the details of a given persistent state event. | 1.0.0 | Runtime 2019.5 |
Overview
Content Tools