...
- 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 soonThe following terms explains the meaning of the parameters passed with the below REST URIs.
|
Get all the associations on a 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} |
Response | It retrieves all the associations for the specific type on the given resource |
Response Type | JSON |
...
Attributes | Values |
---|---|
HTTP Method | POST |
Request URI | http://<ip address>:<port>/restapi/association?path=<resource path>{resource path}&type=<association type>{association type} |
HTTP Request Header | Authorization: Bearer <OAuth {OAuth access token>token} Content-Type: application/json |
Payload | [ {"target":"<target resource path>","type":"<association type>" } ] |
Response | It retrieves all the associations including the added ones |
Response Type | JSON |
...
Attributes | Values |
---|---|
HTTP Method | DELETE |
Request URI | http://<ip address>:<port>/restapi/association?path=<resource path>{resource path}&type=<association type>{association type}&target=<target {target resource path>path} |
HTTP Request Header | Authorization: Bearer <OAuth {OAuth access token>token} |
Response | It retrieves the rest of the associations for the given resource after deletion. |
Response Type | JSON |
Note |
---|
Please note the following points for the above requests. ip address - IP address at which Governance Registry is running.
|