Associations with REST API

This section describes the REST URIs for working with the associations of resources that have been secured with Basic Auth.

Query parameters

The following terms explain the meaning of the query parameters passed with the following REST URIs:

Parameter	Explanation
path	Path of the resource
type	Type of association. By default, Governance Registry has three types of associations: usedBy, ownedBy, and other.
start	Start page number (optional)
size	Number of comments to be fetched (optional)
target	Target resource path

The {start page} and {number of records} can be any value greater than or equal to 0. The {start page} and {number of records} begin with 1. If both of them are 0, then all the records are retrieved. Note that start and size are optional parameters and will default to 0 by default.

For details on security (the authorization header) and the URI syntax (port, context, etc.), see Registry REST API.

Get all the associations for a resource

Attributes	Values
HTTP Method	GET
Request URI	/associations?path={ resource path }&start={ start page }&size={ number of records }
HTTP Request Header	Authorization: Basic { base64encoded(username:password) }
Response	It retrieves all the associations posted on the specific resource.
Response	HTTP 200 OK
Response Type	application/json

Get associations of specific type for a resource

Attributes	Values
HTTP Method	GET
Request URI	/associations?path={ resource path }&type={ association type }
HTTP Request Header	Authorization: Basic { base64encoded(username:password) }
Description	It retrieves all the associations for the specific type of the given resource
Response	HTTP 200 OK
Response Type	application/json

Add associations to a resource

Attributes	Values
HTTP Method	POST
Request URI	/associations?path={resource path}
HTTP Request Header	Authorization: Basic { base64encoded(username:password) } 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 Type	application/json

Add association to a resource

Attributes	Values
HTTP Method	POST
Request URI	/associations?path={resource path}&targetPath={target resource}&type={assocation type}
HTTP Request Header	Authorization: Basic { base64encoded(username:password) } Content-Type: application/json
Description	Adds an association between the source and target resources
Response	HTTP 204 No Content.
Response Type	application/json

Delete associations for a 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