Associations with REST API

This section explains the following REST operations regarding the associations / association of the resource which have been secured with Basic Auth.

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 association. These are usedBy, ownedBy, and other.
start	Start page number.
size	Number of associations to be fetched.
target	Target resource path

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: 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 on a Given 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
Response	HTTP 204 No Content.
Response Type	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