The REST API provides the following methods to manage templates configurations specifically in automated deployment scenarios:
GET /admin/templates/status/<id>
URI |
|
---|---|
Description |
Returns the status of the current templates configuration load. |
Request Header |
|
|
|
Request Body |
Empty. |
Response Status |
|
Response Body | Status of the current load in JSON format. The response body has the following structure:
For example:
COMPLETED Response
{"data":{"state":"COMPLETED","result":{"resultType":"SUCCESS","configErrors":null}},"error":null}
RUNNING Response
{"data":{"state":"RUNNING","result":null},"error":null} |
Access Rights |
'Log in to Rhapsody IDE. |
GET /admin/templates
URI |
|
---|---|
Description |
Returns the templates configuration in the datastore in a ZIP format (the templates configuration in this format can only be loaded onto the engine through the |
Request Header |
|
Accept: application/vnd.orchestral.rhapsody.6_4+zip |
|
Request Body |
Empty. |
Response Status |
|
Response Body | The response body has the following structure:
The configuration XML file has the following structure:
|
Access Rights |
'Log in to Rhapsody IDE'. |
POST /admin/templates
URI |
|
---|---|
Description |
Clears the existing templates configuration and loads the one provided in ZIP format (as created by calling the The configuration will fail to load if you do not have the 'Clear configurations' access right. |
Request Header |
|
Content-Type: application/vnd.orchestral.rhapsody.6_4+zip CSRF Protection Enabled |
|
Request Parameter |
|
Request Body |
The content of the templates configuration in the data store in ZIP format. |
Response Status |
|
Response Header |
The load status URI: Location: https://localhost:8444/admin/templates/status/1 |
Response Body |
Empty when the operation is successful. |
Access Rights |
'Log in to Rhapsody IDE'. |