This section explains the following REST operations regarding the associations / association of the resource which has have been secured with OAuth 2.0.
| Table of Contents |
|---|
| Note |
|---|
The following terms explain the meaning of the query parameters passed with the following REST URIs. |
...
- Get all the associations on a resource.
- Get an association of specific type on a given resource.
- Add the associations to a resource.
- Delete an association on a given resource.
| Note |
|---|
Since the current Registry REST API did not implement the pagination right now, If the user specifies any value other than 0 for the pagestart or pageend in the REST requests will throw HTTP 404 error code. Even though the user omits the pagestart and pageend parameters to be passed with URL , the request will work with the current REST API. Pagination support to REST API will be adapted soon. |
...
|
| Note |
|---|
The { start page } and { number of records } parameters can take any value greater than or equal to 0. The { start page } and { number of records } begins with 1. If both of them are 0, then all the associations are retrieved. |
Get all the Associations on a Resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /associations?path={ resource path }&start={ start page }&size={ number of records } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Response | It retrieves all the associations posted on the specific resource. |
| Response | HTTP 200 OK |
| Response TypeJSON | application/json |
Get
...
Associations of
...
Specific Type on a
...
Given Resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /associations?path={ resource path }&type={ association type } |
| HTTP Request Header | Authorization: Bearer <OAuth {OAuth access token>token} |
ResponseDescription | It retrieves all the associations for the specific type on of the given resource |
| Response | HTTP 200 OK |
| Response Type | JSON |
...
| application/json |
Add Associations to a
...
Resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | http://<ip address>:<port>/restapi/association/associations?path=<resource path>&type=<association type>{resource path} |
| HTTP Request Header | Authorization: Bearer <OAuth {OAuth access token>token} Content-Type: application/json |
| Payload | [{ "targettype":"<target path><type of the association>","typetarget":"<association type><valid resource path>"}] |
ResponseDescription | It retrieves all adds the associations including the added onesarray of associations passed as the payload for the source resource |
| Response | HTTP 204 No Content. |
| Response Type | JSON |
...
| application/json |
Add Association to a Resource
...
| Attributes | Values | ||
|---|---|---|---|
HTTP Method | DELETEPOST | ||
| Request URI | http://<ip address>:<port>/restapi/association/associations?path=<resource path>&type=<association type>&target=<target resource path>{resource path}&targetPath={target resource}&type={assocation type} | ||
| HTTP Request Header | Authorization: Bearer <OAuth access token> | Response | It retrieves the rest of the associations for the given resource after deletion {OAuth access token} Content-Type: application/json |
| Response | HTTP 204 No Content. | ||
| Response Type | JSON |
| Note |
|---|
Please note the following points for the above requests.
|
| application/json |
Delete Associations on a Given Resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | /association?path={resource path}&targetPath={target path}&type={association type} |
Description | It deletes the association between the source and target resources for the given association type. |
| Response | HTTP 204 No Content. |
| Response Type | application/json |