This section explains the following REST operations regarding the associations / association of the resource which have been secured with OAuth 2.0.
...
| Note | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The following terms explain the meaning of the query parameters passed with the following REST URIs.
|
...
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /associations?path={ resource path }&type={ association type } |
| HTTP Request Header | Authorization: Bearer {OAuth access token} |
Description | It retrieves all the associations for the specific type on of the given resource |
| Response | HTTP 200 OK |
| Response TypeJSON | application/json |
Add Associations to a Resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | /association?path={resource path} |
| HTTP Request Header | Authorization: Bearer {OAuth access token} Content-Type: application/json |
| Payload | [{ "type":"<type of the association>","target":"<valid resource path>"}] |
Description | It adds the array of associations passed as the payload for the source resource |
| Response | HTTP 204 No Content. |
| Response TypeJSON | application/json |
Delete
...
Associations on a Given Resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | /association?path={resource path} |
| Payload | [{ "type":"<type of the association>","target":"<valid resource path>"}] |
| HTTP Request Header | Authorization: Bearer {OAuth access token} |
Description | It deletes the association between the source and target resources for the given association type. |
| Response | HTTP 204 No Content. |
| Response TypeJSON | application/json |