The Registry REST API basically facilitates the capability to perform the CRUD operations via the well-defined HTTP protocol on the registry resources and its attributes such as tags, properties, associations, etc. The REST API uses the GET, POST, PUT, and DELETE operations of the well-defined HTTP protocol to do the CRUD operation via any REST Client. Google Chrome's Advanced REST client is one of the client tools used to test the functionality of the Registry REST API.
Under the REST API panel, all the REST invocations are summarized. Click on the links below to get more information about the REST support specific to that aspect.
Comments ---- Information on how to add, retrieve, edit and delete comments of a resource
Properties --- Information on how to add, retrieve, edit and delete properties of a resource
Tags --- Information on how to add, retrieve and delete tags of a resource and retrieve resources tagged together
Associations --- Information on how to add, retrieve, edit and delete associations of a resource
Rating --- Information on how to add, retrieve, edit and delete rating of a resource.
Resources --- Information on how to add, retrieve and delete a resource
Collection --- Information on how to add, retrieve and delete a collection.
Metadata --- Metadata information about the resources and collections
Sample requests
Following are some sample REST calls format to the Registry REST API.
IMPORTANT
- context - Context of REST API invocation. It is the by default "resource".
- version - Since it is the initial version of the REST API, it is denoted as "1.0.0"
- ip - IP address of the Governance Registry
- port - Port at which the Governance Registry is running.
Get All the Comments:
Format : http://{ ip:port }/{context}/{version}/comments?path={resource path}&start={ start page}&size={ no of records}
Example : http://localhost:9763/resource/1.0.0/comments?path=/_system/governance/sample.xml&start=1&size=3
Post a Comment:
Format : http://{ip:port}/{context}/{version}/comment?path={resource path}
Header : Content-Type = text/plain
Example : http://localhost:9763/resource/1.0.0/comment?path=/_system/governance/sample.xml
Header : Content-Type = text/plain