This section explains the REST operations for working with properties of resources that have been secured with Basic Auth.
Query parameters
The following terms explain the meaning of the query parameters passed with the following REST URIs:
| Parameter | Explanation |
|---|---|
| path | Path of the resource |
| name | Name of the property on the given resource |
| array of values | Array of values for the property, e.g., [ {"name":"Name","value":["Smith","Chris"]} ] |
| start | Start page number (optional) |
| size | Number of comments to be fetched (optional) |
| user | Username of the user |
The {start page} and {number of records} can be any value greater than or equal to 0. The {start page} and {number of records} begin with 1. If both of them are 0, then all the comments are retrieved. Note that start and size are optional parameters and will default to 0 by default.
For details on security (the authorization header) and the URI syntax (port, context, etc.), see Registry REST API.
Get all the properties of a resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /properties?path={ resource path }&start={ start page }&size={ number of records } |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } |
| Description | This retrieves all the properties posted on the specific resource with a specified start page and size. |
| Response | HTTP 200 OK |
| Response Type | application/json |
Get a property of a given resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /property?path={ resource path }&name={ property name } |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } |
| Description | This retrieves the specific property associated with the given property name. |
| Response | HTTP 200 OK |
| Response Type | application/json |
Sample request
curl -X GET -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Cache-Control: no-cache" "https://localhost:9443/resource/1.0.0/property?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService&name=resource.source" -i -k
Add properties to a resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | /properties?path={ resource path } |
| HTTP Request Headers | Authorization: Basic { base64encoded(username:password) } Content-Type: application/json |
| Payload | [ {"name":"property1","value":["value1","value2"]} ] |
| Description | Add the array of properties for the given resource |
| Response | 204 No Content |
| Response Type | application/json |
Sample request
curl -X POST -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '[ {"name":"property1","value":["value1","value2"]} ] ' "https://localhost:9443/resource/1.0.0/properties?path=/_system/governance/trunk/soapservices/org/wso2/www/types/1.0.0/Axis2Service"
Delete a property of a given resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | /property?path={ resource path }&name={property name} |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } |
| Description | Deletes the specified property from the given resource |
| Response | HTTP 204 No Content |
| Response Type | application/json |
Sample request
curl -X DELETE -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://localhost:9443/resource/1.0.0/property?path=/_system/governance/trunk/soapservices/com/amazon/soap/1.0.0/AmazonSearchService&name=resource.source" -i -k