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 allows you to work with registry resources such as comments, properties, and tags. The API uses the GET, POST, PUT, and DELETE operations of the well-defined HTTP protocol to do the CRUD operation via any REST Clientclient. Google Chrome's Advanced REST client is one of the client tools used to test the functionality of the Registry REST API.
| Panel |
|---|
The Registry REST API is one of many APIs supported by the WSO2 Governance Registry. Read more on Supported APIs and Standards for a complete list of APIs supported by WSO2 Governance Registry. |
Security
The Registry REST API is secured with a Basic Auth access token. You can invoke the rest API with the Basic Auth header
Authorization: Basic YWRtaW46YWRtaW4= where the format is Authorization: Basic {base64encoded(username:password)}URI syntax
Each API is constructed as a URI. For example, to get all the comments, the syntax is:
http://{ip:port}/{context}/{version}/comments?path={resource path}&start={start page}&size={no of records}
The prefix of each URI contains the following elements:
ip- IP address of the Governance Registryport- Port at which the Governance Registry is running.context- Context of REST API invocation. By default it is "resource".version- Since it is the initial version of the REST API, it is denoted as "1.0.0"
Here is a sample request that gets all the comments:
curl -X GET -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" "https://localhost:9443/resource/1.0.0/comments?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService" -i -k
API reference and samples
...
...
...
| Panel |
|---|
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 Ratings --- 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 Collections --- Information on how to add, retrieve and delete a collection. Metadata --- Metadata information about for the resources and collections Copy and move — Information on how to copy and move resources Revisions — Information on how to add, retrieve, and delete versions of a resource |