Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Note

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

ParameterExplanation
pathPath of the resource.
OAuth access tokenAuthorized access token per user for an hour by default.
typeType of association. By default, Governance Registry has three types of association. These are usedBy, ownedBy, and other.
startStart page number.
sizeNumber of associations to be fetched.
targetTarget resource path

 

 

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.

...

AttributesValues

HTTP Method                 

POST
Request URI/associationassociations?path={resource path}
HTTP Request Header

Authorization: Bearer {OAuth access token}

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
ResponseHTTP 204 No Content.
Response Typeapplication/json

...

Add Association to a Resource

[{ "type":"<type of the association>","target":"<valid resource path>"}] 
AttributesValues

HTTP Method                 

DELETEPOST
Request URI/associationassociations?path={resource path}Payload&targetPath={target resource}&type={assocation type}
HTTP Request Header

Authorization: Bearer {OAuth access token}

Content-Type: application/json

ResponseHTTP 204 No Content.
Response Typeapplication/json

Delete Associations on a Given Resource

AttributesValues

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.
ResponseHTTP 204 No Content.
Response Typeapplication/json

...