ServiceDataResource
A REST Web Service for managing External Concepts.
The following resources are applicable:
- /change-sets/{csId}/service-data
- /change-sets/{csId}/service-data/addToArray
- /change-sets/{csId}/service-data/delete
- /change-sets/{csId}/service-data/dependencies
- /change-sets/{csId}/service-data/rename
/change-sets/{csId}/service-data
Mount Point: /change-sets/{csId}/service-data
The following operations are supported on this resource:
GET
Retrieves all service data for a given change set. This by default is the same as change-sets/{csId}/service-data/dependencies.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path | |
| includeChain | True to include parent change sets, false for this change set only | query | true |
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
A JsonNode object containing all service data
POST
Creates new Service Data. If the field does not exist, it is created. If it does exist, it is updated.
Parameters
| name | description | type | default |
|---|---|---|---|
| JSESSIONID | The user session ID | cookie | |
| csId | The change set ID | path |
Request Body
| element: | serviceData |
| media types: | application/xml text/xml application/json |
The service data JSON String
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
The created/updated document
PUT
Updates the service data specified in request.
Parameters
| name | description | type | default |
|---|---|---|---|
| JSESSIONID | The session of the user performing the update | cookie | |
| csId | The change set ID for editing | path |
Request Body
| element: | serviceData |
| media types: | application/xml text/xml application/json |
The JSON object containing fields to remove
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
200 on success, 404 on error
/change-sets/{csId}/service-data/addToArray
Mount Point: /change-sets/{csId}/service-data/addToArray
PUT
Adds new elements to existing arrays.
Parameters
| name | description | type | default |
|---|---|---|---|
| JSESSIONID | The session of the user performing the update | cookie | |
| csId | The change set ID for editing | path |
Request Body
| element: | serviceData |
| media types: | application/xml text/xml application/json |
The JSON object containing array elements to add
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
200 on success, 404 on error
/change-sets/{csId}/service-data/delete
Mount Point: /change-sets/{csId}/service-data/delete
PUT
Deletes all service data specified in request. If the fields specified exist in a parent change set, a new entry is created, or an existing one is updated, marked as deleted. If it only exists in this change set, and it is not deployed, the entry is removed from the database.
Parameters
| name | description | type | default |
|---|---|---|---|
| JSESSIONID | The session of the user performing the update | cookie | |
| csId | The change set ID for editing | path |
Request Body
| element: | serviceData |
| media types: | application/xml text/xml application/json |
The JSON object containing fields to remove
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
200 on success, 404 on error
/change-sets/{csId}/service-data/dependencies
Mount Point: /change-sets/{csId}/service-data/dependencies
GET
Returns service data as key-value pairs, with any dependencies.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path |
Response Body
| element: | serviceData |
| media types: | application/xml text/xml application/json |
Service Data object
/change-sets/{csId}/service-data/rename
Mount Point: /change-sets/{csId}/service-data/rename
PUT
Renames all service data specified in request. Rename works by finding the service data entry/entries matching the given prefix/key. All matching entries found will have the key renamed to the new name.
Parameters
| name | description | type | default |
|---|---|---|---|
| JSESSIONID | The session of the user performing the update | cookie | |
| csId | The change set ID for editing | path |
Request Body
| element: | serviceData |
| media types: | application/xml text/xml application/json |
The JSON object containing fields to remove
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
200 on success, 404 on error