This section explains the following REST operations regarding the associations of the resource which has been secured with OAuth 2.0.
- 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
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.
Get all the associations on a resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | http://<ip address>:<port>/restapi/associations?path=<resource path>&pagestart=0&pageend=0 |
| HTTP Request Header | Authorization: Bearer <OAuth access token> |
| Response | It retrieves all the associations posted on the specific resource. |
| Response Type | JSON |
Get associations of specific type on a given resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | http://<ip address>:<port>/restapi/associations?path=<resource path>&type=<association type> |
| HTTP Request Header | Authorization: Bearer <OAuth access token> |
Response | It retrieves all the associations for the specific type on the given resource |
| Response Type | JSON |
Add associations to a resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | http://<ip address>:<port>/restapi/association?path=<resource path>&type=<association type> |
| HTTP Request Header | Authorization: Bearer <OAuth access token> Content-Type: application/json |
| Payload | [ {"target":"<target path>","type":"<association type>" }] |
Response | It retrieves all the associations including the added ones |
| Response Type | JSON |
Delete an association on a given resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | http://<ip address>:<port>/restapi/association?path=<resource path>&type=<association type>&target=<target resource path> |
| HTTP Request Header | Authorization: Bearer <OAuth access token> |
Response | It retrieves the rest of the associations for the given resource after deletion. |
| Response Type | JSON |
Please note the following points for the above requests.
- ip address - IP address at which Governance Registry is running.
- port - HTTP port number at the Governance Registry is up.
- resource path - Path of the resource.
- OAuth access token - Authorized access token per user for an hour by default.
- association type - Type of association. By Default, Governance Registry has three types of association. These are usedBy, ownedBy, and other.
- restapi - Name of the .war file for the REST API resides at
{Greg_home}/repository/deployment/server/jaxwebapps/. If you renamed this .war file, the new name is used instead of restapi. - target - The path of the target resource with which the association is established.