Page History
...
Bridge 7 Find below a list of resources that can be accessed via the xUML Runtime API. All resources refer to base path /api.
xUML Service
| Resource | Method | Description | API Version | Runtime Version |
|---|---|---|---|---|
/hooks/shutdown/fire | PUT | Fire the service shutdown activity. | 1.1.0 | Runtime 2020.13 |
/hooks/startup/fire | PUT | Fire the service startup activity. | 1.1.0 | Runtime 2020.13 |
/scheduler/events/{schedulerName}/fire | PUT | Fire the scheduler event (without checking the conditions). | 1.1.0 | Runtime 2020.13 |
/timer/events/{timerName}/fire | PUT | Fire the timer event (without checking the conditions). | 1.1.0 | Runtime 2020.13 |
/timer/events/{eventObserverActivity}/fire | PUT | Fire the event (without checking the conditions). | 1.1.0 | Runtime 2020.13 |
/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 |
...
| Resource | Method | Description | API Version | Runtime Version |
|---|---|---|---|---|
/pstate/events/{eventId} | GET | Get the details of a given persistent state event. | 1.0.0 | Runtime 2019.5 |
Asynchronous Tracing
The API of asynchronous tracing allows to manage the trace settings and trace data of a service.
- A classifier in this context is a model element that can be traced.
- An identifier in this context identifies the recorded trace data.
You can clear all tracing of a service by performing
- DELETE on
/trace/configurations/to remove all active traces. - DELETE on
/trace/identifiers/to remove all trace data.
| Resource | Method | Description | API Version | Runtime Version |
|---|---|---|---|---|
/trace/configurations/ | GET | List all asynchronous trace configurations of this service. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/ | POST | Insert a new asynchronous trace configuration to this service. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/ | DELETE | Remove all asynchronous trace configurations for this service. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier} | GET | List all asynchronous trace configurations for the given classifier. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier} | PUT | Replace the asynchronous trace configuration of the given classifier. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier} | DELETE | Remove all asynchronous trace configurations for the given classifier. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier}/identifiers/ | GET | List all available trace identifiers of the the given classifier. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier}/identifiers/ | DELETE | Remove all trace identifiers of the the given classifier. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier}/identifiers/{id} | DELETE | Remove the trace identifier with the given ID within the the given classifier. | 1.1.0 | Runtime 2020.14 |
/trace/configurations/{classifier}/identifiers/{id}/raw | GET | Get the tracing data of the identifier with the given ID within the the given classifier as stored internally (raw data). | 1.1.0 | Runtime 2020.14 |
/trace/identifiers/ | GET | List all asynchronous trace identifiers of the service. | 1.1.0 | Runtime 2020.14 |
/trace/identifiers/ | DELETE | Remove all asynchronous trace identifiers of the service. | 1.1.0 | Runtime 2020.14 |
Overview
Content Tools