Bridge API Reference
List of Resources
User
| Resource | Method | Description | API Version | Bridge Version |
|---|---|---|---|---|
/groups | GET | Get a list of all user groups and their members. | 2.8.0 | Bridge 7.1.0 |
/groups/{id} | GET | Get group information an a list of members. | 2.8.0 | Bridge 7.1.0 |
| POST | Create a new user group. | 2.8.0 | Bridge 7.1.0 | |
| PUT | Update the group details of a specific group. | 2.8.0 | Bridge 7.1.0 | |
| DELETE | Delete a specific group. | 2.8.0 | Bridge 7.1.0 | |
/users | GET | Get a list of all users and their details. | 2.8.0 | Bridge 7.1.0 |
/users/{id} | GET | Get the details of a specific user. | 2.8.0 | Bridge 7.1.0 |
| POST | Create a new user. | 2.8.0 | Bridge 7.1.0 | |
| PUT | Update the details of a specific user. | 2.8.0 | Bridge 7.1.0 | |
| DELETE | Delete a specific user. | 2.8.0 | Bridge 7.1.0 |
All Services
| Resource | Method | Description | API Version | Bridge Version |
|---|---|---|---|---|
/services | GET | Get a list of all xUML, Node.js and Java services. For each service, you get type and current status. | 1.0.0 | Bridge 6.0.56.2 |
| POST | Deploy a service of any type (xUML, Node.js, Java). | 2.5.0 | Bridge 7.0.0-beta1 |
All xUML Services
| Resource | Method | Description | API Version | Bridge Version |
|---|---|---|---|---|
/xuml/java
| GET | Get a list of all Java resource archives that have been uploaded to the E2E Bridge. | 2.6.0 | Bridge 7.0.0-beta2 |
| POST | Upload a Java resource archive to the E2E Bridge. If the resource already exists, you must remove it prior to uploading a new version. | 2.6.0 | Bridge 7.0.0-beta2 | |
/xuml/java/{fileName}
| GET | Get a specific Java resource archive. | 2.6.0 | Bridge 7.0.0-beta2 |
| DELETE | Delete a specific Java resource archive. | 2.6.0 | Bridge 7.0.0-beta2 | |
/xuml/resource
| GET | Get a list of all resource files that have been uploaded to the E2E Bridge. | 2.6.0 | Bridge 7.0.0-beta2 |
| POST | Upload a resource file to the E2E Bridge. If the resource already exists, you must remove it prior to uploading a new version. | 2.6.0 | Bridge 7.0.0-beta2 | |
/xuml/resource/{fileName}
| GET | Get a specific resource file. | 2.6.0 | Bridge 7.0.0-beta2 |
| DELETE | Delete a specific resource file. | 2.6.0 | Bridge 7.0.0-beta2 | |
/xuml/variables | GET | Get a list of all setting variables and their values. | 2.6.0 | Bridge 7.0.0-beta2 |
| PUT | Change setting variables. | 2.6.0 | Bridge 7.0.0-beta2 | |
| PATCH | Change a single setting variable. | 2.8.0 | Bridge 7.1.0 | |
/xuml/xslt | GET | Get a list of all XSLT resources that have been uploaded to the E2E Bridge. | 2.6.0 | Bridge 7.0.0-beta2 |
| POST | Upload an XSLT resource file to the E2E Bridge. If the resource already exists, you must remove it prior to uploading a new version. | 2.6.0 | Bridge 7.0.0-beta2 | |
/xuml/xslt
| GET | Get a specific XSLT resource. | 2.6.0 | Bridge 7.0.0-beta2 |
| DELETE | Delete a specific XSLT resource file. | 2.6.0 | Bridge 7.0.0-beta2 |
Single xUML Service
| Resource | Method | Description | API Version | Bridge Version |
|---|---|---|---|---|
/services/xuml | GET | Get a list of all xUML services. For each service, you get type and current status. | 1.0.0 | Bridge 6.0.56.2 |
/services/xuml/{name} | GET | Get the current status of a specific service and a link list of all possible actions. | 1.0.0 | Bridge 6.0.56.2 |
| DELETE | Delete a specific xUML service. | 2.3.0 | Bridge 6.0.60 | |
/services/xuml/{name}/customnotes | GET | Get the custom service description (custom notes file) of a specific xUML service. | 1.0.0 | Bridge 6.0.56.2 |
| PUT | Change the content of the custom model notes file. | 1.0.0 | Bridge 6.0.56.2 | |
/services/xuml/{name}/info | GET | Get a list of all available SOAP and REST ports of a specific xUML service. | 2.6.0 | Bridge 7.0.0-beta2 |
/services/xuml/{name}/kill | PUT | Kill the running xUML service. | 2.5.0 | Bridge 7.0.0-beta1 |
/services/xuml/{name}/modelnotes | GET | Get a list of all available service descriptions (model notes files) that are available for a specific xUML service. | 1.0.0 | Bridge 6.0.56.2 |
/services/xuml/{name}/modelnotes/{file} | GET | Get the content of the service description (model notes file) of a specific xUML service. | 1.0.0 | Bridge 6.0.56.2 |
/services/xuml/{name}/owner
| GET | Retrieve the current service owner. | 2.14.0 | Bridge 7.25.0 |
| PUT | Change the service owner. Only users with role Admin can call PUT. | 2.14.0 | Bridge 7.25.0 | |
/services/xuml/{name}/preferences | GET | Get the preferences of a specific xUML service. | 1.0.0 | Bridge 6.0.56.2 |
| PUT | Change the preferences of a specific xUML service. | 2.3.0 | Bridge 6.0.60 | |
/services/xuml/{name}/repository | GET | Export the repository file of a specific xUML service. | 2.5.0 | Bridge 7.0.0-beta1 |
/services/xuml/{name}/sessions | GET | Get a list of all sessions of a specific xUML service. | 2.5.0 | Bridge 7.0.0-beta1 |
/services/xuml/{name}/sessions/{sessionid} | DELETE | Delete the session of the xUML service with the given ID. | 2.5.0 | Bridge 7.0.0-beta1 |
/services/xuml/{name}/settings | GET | Get the settings of the xUML service. Modified settings and original values from model are reported. | 1.0.0 | Bridge 6.0.56.2 |
| PUT | Change the settings of a specific xUML service. If the request contains a non-existing setting id, it returns status code '400 (Bad Request)'. | 2.3.0 | Bridge 6.0.60 | |
/services/xuml/{name}/start | PUT | Start a specific stopped xUML service. | 2.3.0 | Bridge 6.0.60 |
/services/xuml/{name}/stop | PUT | Stop a specific running xUML service. | 2.3.0 | Bridge 6.0.60 |
/services/xuml/{name}/version
| GET | Get detailed version information of a specific xUML service. | 2.8.0 | Bridge 7.1.0 |
Java Services
| Resource | Method | Description | API Version | Bridge Version |
|---|---|---|---|---|
/services/java | GET | Get a list of all Java services. For each service, you get type and current status. | 1.0.0 | Bridge 6.0.56.2 |
/services/java/{name} | GET | Get the current status of the service and a link list of all possible actions. | 1.0.0 | Bridge 6.0.56.2 |
| DELETE | Delete the Java service. | 2.5.0 | Bridge 7.0.0-beta1 | |
/services/java/{name}/kill | PUT | Kill the Java service. | 2.9.0 | Bridge 7.2.0 |
/services/java/{name}/owner | GET | Retrieve the current service owner. | 2.14.0 | Bridge 7.25.0 |
| PUT | Change the service owner. Only users with role Admin can call PUT. | 2.14.0 | Bridge 7.25.0 | |
/services/java/{name}/preferences | GET | Get the preferences of the Java service. | 1.0.0 | Bridge 6.0.56.2 |
| PUT | Change the preferences of the Java service. | 1.0.0 | Bridge 6.0.56.2 | |
/services/java/{name}/start | PUT | Start the stopped Java service. | 1.0.0 | Bridge 6.0.56.2 |
/services/java/{name}/stop | PUT | Stop the running Java service. | 1.0.0 | Bridge 6.0.56.2 |
Node.js Services
| Resource | Method | Description | API Version | Bridge Version |
|---|---|---|---|---|
/services/nodejs | GET | Get a list of all Node.js services. For each service, you get type and current status. | 1.0.0 | Bridge 6.0.56.2 |
/services/nodejs/{name} | GET | Get the current status of the service and a link list of all possible actions. | 1.0.0 | Bridge 6.0.56.2 |
| DELETE | Delete the Node.js service. | 2.5.0 | Bridge 7.0.0-beta1 | |
/services/nodejs/{name}/kill | PUT | Kill the Node.js service. | 2.9.0 | Bridge 7.2.0 |
/services/nodejs/{name}/owner | GET | Retrieve the current service owner. | 2.14.0 | Bridge 7.25.0 |
| PUT | Change the service owner. Only users with role Admin can call PUT. | 2.14.0 | Bridge 7.25.0 | |
/services/nodejs/{name}/preferences | GET | Get the preferences of the Node.js service. | 1.0.0 | Bridge 6.0.56.2 |
| PUT | Change the preferences of the Node.js service. | 1.0.0 | Bridge 6.0.56.2 | |
/services/nodejs/{name}/settings | GET | Get the settings of the Node.js service. | 2.3.0 | Bridge 6.0.60 |
| PUT | Change the settings of the Node.js service. | 2.3.0 | Bridge 6.0.60 | |
/services/nodejs/{name}/start | PUT | Start the stopped Node.js service. | 1.0.0 | Bridge 6.0.56.2 |
/services/nodejs/{name}/stop | PUT | Stop the running Node.js service. | 1.0.0 | Bridge 6.0.56.2 |
Type "Link"
| Type | Attribute | Type | Description | Examples |
|---|---|---|---|---|
| Link | rel | String | Name of the relation for href (see also list of relations below). | self http://e2e.ch/bridge/start
|
| href | String | Link corresponding to relation rel. | https://e2ebridge.e2e.ch:8080/bridge/rest/services/xuml
|
The relations (rel) are stable within a major API version, but for the resource links (href) this is not guaranteed. You should read the resource link via the relation from the resource and not hard code the resource link.
Available Relations
| Relation (rel) | Description | API Version | Bridge Version |
|---|---|---|---|
self | href contains a link to the resource itself. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/service | href contains a link to the service. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/start | href contains a link to the start action of the service. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/stop | href contains a link to the stop action of the service. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/kill
| href contains a link to the kill action of the service. | 2.5.0 | Bridge 7.0.0-beta1 |
http://e2e.ch/bridge/sessions
| href contains a link to the list of running sessions of the service. | 2.5.0 | Bridge 7.0.0-beta1 |
http://e2e.ch/bridge/repository
| href contains a link to the export action of the service. | 2.5.0 | Bridge 7.0.0-beta1 |
http://e2e.ch/bridge/preferences | href contains a link to the service preferences. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/settings | href contains a link to the service settings. | 2.3.0 | Bridge 6.0.60 |
http://e2e.ch/bridge/modelnotes
| href contains a link to the service description. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/customnotes
| href contains a link to the custom service description. | 1.0.0 | Bridge 6.0.56.2 |
http://e2e.ch/bridge/info
| href contains a link to all SOAP and REST ports of the service. | 2.6.0 | Bridge 7.0.0-beta2 |
Related Pages: