Versions Compared

Old Version 24

changes.mady.by.user Former user

Saved on

compared with

New Version 25

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 This section explains the following REST operations regarding the associations of the resource which have been secured with OAuth 2.0.

...

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.

Array of values

Array of values for the property e.g.: ["val1","val2","val3",......].
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                

GET
Request URI/associations?path={ resource path }&start={ start page }&size={ number of records }
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
ResponseIt retrieves all the associations posted on the specific resource.
Response TypeJSON

...

AttributesValues

HTTP Method                 

GET
Request URI/associations?path={ resource path }&type={ association type }
HTTP Request HeaderAuthorization: Bearer {OAuth access token}

Response

It retrieves all the associations for the specific type on the given resource
Response TypeJSON

...

AttributesValues

HTTP Method                 

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

Authorization: Bearer {OAuth access token}

Content-Type: application/json

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

Description

It adds the array of associations passed as the payload for the source resource
Response TypeJSON

...

AttributesValues

HTTP Method                 

DELETE
Request URI/association?path={resource path}&type={association type}&target={target resource path}
HTTP Request HeaderAuthorization: Bearer {OAuth access token}

Description

It deletes the association between the source and target resources for the given association type.
Response TypeJSON

...