TThe REST API provides the following method to return basic engine information:
GET /api/info
URI |
|
---|---|
Description |
Retrieves engine version, name and uptime duration. |
Request Header |
|
Accept: application/vnd.orchestral.rhapsody.6_0+json |
|
Request Body |
Empty. |
Response Status | 200 OK - operation successful. |
Response Body |
The response body has the following data object structure: { "data": { "version": "6.1.0", "name": "my engine to test", "uptime": "P0Y0M0DT0H1M51.725S" }, "error": null } |
Access Rights |
'Call REST API'. |
GET /api/info/enginename
URI | GET /api/info/enginename |
---|---|
Description | Retrieves engine name. |
Request Header | Accept: text/plain |
Accept: text/vnd.orchestral.rhapsody.6_4+plain |
|
Request Body | Empty. |
Response Status | 200 OK - operation successful. |
Response Body | The engine name. |
Access Rights | 'Call REST API' |
PUT /api/info/enginename
URI | PUT /api/info/enginename |
---|---|
Description | Renames the engine. |
Request Header | Content-Type: text/plain CSRF Protection Enabled |
Content-Type: text/ vnd.orchestral.rhapsody.6_4+plain CSRF Protection Enabled |
|
Request Body | The new engine name. Providing no name resets the engine name to the default name: "Rhapsody Integration Engine". |
Response Status | 204 No Content - operation successful. |
Response Body | Empty. |
Access Rights | 'Manage general settings REST API'. |