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

ResourceMethodDescriptionAPI VersionRuntime Version
/isAliveGETCheck if the xUML service is ready. A success HTTP code indicated readiness, an error HTTP code indicates startup still in progress.1.2.0Runtime 2021.6
/hooks/shutdown/firePUTFire the service shutdown activity.1.1.0Runtime 2020.13
/hooks/startup/firePUTFire the service startup activity.1.1.0Runtime 2020.13
/scheduler/events/{schedulerName}/firePUTFire the scheduler event (without checking the conditions).1.1.0

Runtime 2020.13

/timer/events/{timerName}/firePUTFire the timer event (without checking the conditions).1.1.0Runtime 2020.13
/timer/events/{eventObserverActivity}/fire PUTFire the event (without checking the conditions).1.1.0Runtime 2020.13
/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

Logging

ResourceMethodDescriptionAPI VersionRuntime Version
/log/channels/GET

List all configured log channels.

1.1.0Runtime 2020.1
/log/channels/{channel}/sinksGETList all configured sinks of a channel.1.1.0Runtime 2020.1
/log/channels/{channel}/sinks/{sink}/filtersPUTReplace all filters of the given sink.1.1.0Runtime 2020.1
/log/channels/{channel}/sinks/{sink}/filters/GETList filters on a given sink.1.1.0Runtime 2020.1
/log/channels/{channel}/sinks/{sink}/filters/POST

Create a new filter.

1.1.0Runtime 2020.1
/log/channels/{channel}/sinks/{sink}/filters/{filterNum}DELETERemove the filter with the given number.1.1.0Runtime 2020.1
/log/channels/{channel}/sinks/{sink}/filters/{filterNum}GETRetrieve the filter with the given number from the given sink.1.1.0Runtime 2020.1
/log/channels/{channel}/sinks/{sink}/filters/{filterNum}PUTChange the filter with the given number.1.1.0Runtime 2020.1

Persistent State

Persistent State Classes

ResourceMethodDescriptionAPI VersionRuntime Version
/pstate/classes/GETList 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 VersionRuntime 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 VersionRuntime 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.

1.0.0Runtime 2019.5

Persistent State Owners

ResourceMethodDescriptionAPI VersionRuntime 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.0Runtime 2019.5

Peristent State Events

ResourceMethodDescriptionAPI VersionRuntime Version
/pstate/events/{eventId}GET     Get the details of a given persistent state event.1.0.0Runtime 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

  1. DELETE on  /trace/configurations/ to remove all active traces.
  2. DELETE on  /trace/identifiers/ to remove all trace data.
ResourceMethodDescriptionAPI VersionRuntime Version
/trace/configurations/GET List all asynchronous trace configurations of this service.1.1.0Runtime 2020.14
/trace/configurations/POSTInsert a new asynchronous trace configuration to this service.1.1.0Runtime 2020.14
/trace/configurations/DELETERemove all asynchronous trace configurations for this service.1.1.0Runtime 2020.14
/trace/configurations/{classifier}GET List all asynchronous trace configurations for the given classifier.1.1.0Runtime 2020.14
/trace/configurations/{classifier}PUTReplace the asynchronous trace configuration of the given classifier.1.1.0Runtime 2020.14
/trace/configurations/{classifier}DELETE Remove all asynchronous trace configurations for the given classifier.1.1.0Runtime 2020.14
/trace/configurations/{classifier}/identifiers/GET     List all available trace identifiers of the the given classifier.1.1.0Runtime 2020.14
/trace/configurations/{classifier}/identifiers/DELETERemove all trace identifiers of the the given classifier.1.1.0Runtime 2020.14
/trace/configurations/{classifier}/identifiers/{id}DELETERemove the trace identifier with the given ID within the the given classifier.1.1.0Runtime 2020.14
/trace/configurations/{classifier}/identifiers/{id}/rawGET

Get the tracing data of the identifier with the given ID within the the given classifier as stored internally (raw data).

1.1.0Runtime 2020.14
/trace/identifiers/GETList all asynchronous trace identifiers of the service.1.1.0Runtime 2020.14
/trace/identifiers/DELETERemove all asynchronous trace identifiers of the service.1.1.0Runtime 2020.14