Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

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

...

Panel

HTTP Method                 : GET

Request URI                   : http://<ip address>:<port>/restapi/associations?path=/_system/A<resource path>&pagestart=0&pageend=0

HTTP Request Header : Authorization: Bearer <OAuth access token>

Response                       : it retrieves all the associations posted on the specific resource.

Response Type             : JSON

Get

...

associations of specific type on a given resource

Panel

HTTP Method                 : GET

Request URI                   : http://<ip address>:<port>/restapi/propertyassociations?path=<resource path>&nametype=<property name><association type>

HTTP Request Header : Authorization: Bearer <OAuth access token>

Response                       : it retrieves  the specific  property associated with the given property name.retrieves all the associations for the specific type on the given resource

Response Type             : JSON

...

Add  associations to a resource

Panel

HTTP Method                   : POST

Request URI                     : http://<ip address>:<port>/restapi/propertyassociation?path=<resource path>

HTTP Request Headers : Authorization: Bearer <OAuth access token>

                                            : Content-Type: application/json

Payload                             : [ {"nametarget":"<property name><target path>","valuetype":[<array of values>] "<association type>" }]

Response                         :  it retrieves all the properties associations with the added one for the given resource.

Response Type               : JSON

Update properties on a given resource

Panel

HTTP Method                   : PUT

Request URI                     : http://<ip address>:<port>/restapi/property?path=<resource path>

HTTP Request Headers : Authorization: Bearer <OAuth access token>

                                            : Content-Type: application/json

Payload                             : [ {"name":"<property name>","value":[<array of updated values>] }]

Response                         :  it retrieves all the properties including the updated one for the given resource. The property is updated with the array of updated values

Response Type               : JSON

...

Delete an association on a given resource

Panel

HTTP Method                   : DELETE

Request URI                     :http://<ip address>:<port>/restapi/propertyassociation?path=<resource path>&nametype=<property name><association type>

HTTP Request Headers : Authorization: Bearer <OAuth access token>

Response                         :  it retrieves rest of the properties 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
  • port                              - HTTP port number at the Governance Registry is up
  • resource path            - Path of the resource
  • OAuth access token - Authorized access token per user for an hour by default.
  • property name           - name of the property on the given resource
  • array of values          - eg: ["val1","val2","val3",......]association type        - type of association. By Default, Greg has 3 types, such as usedBy, ownedBy, other.
  • restapi                         - name of the War file for the REST API resides at {Greg_home}/repository/deployment/server/jaxwebapps/.
                                           If the user renamed this war file, the new name value will be used instead of restapi.

...