...
| Note | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The following terms explain the meaning of the parameters passed with the following REST URIs
|
| 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 properties are retrieved. |
...
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /properties?path={ resource path }&start={ start page }&size={ number of records }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Description | This retrieves all the properties posted on the specific resource with a specified start page and size. |
| Response | HTTP 200 OK |
| Response TypeJSON | application/json |
Get a Property of a Given Resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /property?path={ resource path }&name={ property name }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Description | This retrieves the specific property associated with the given property name. |
| Response | HTTP 200 OK |
| Response TypeJSON | application/json |
Add Properties to a Resource
| Attributes | Values | |
|---|---|---|
HTTP Method | POST | |
| Request URI | /propertyproperties?path={ resource path }&user={ user name } | |
| HTTP Request HeaderHeaders | Authorization: Bearer { OAuth access token } Content-Type: application/json | |
| Payload | [ {"name":"<property name>propperty1","value":[<array of values>"value1","value2"]} ] | |
| Description | Add the array of properties for the given resource | |
| Response | TypeJSON |
Update Properties of a Given Resource
| Attributes | Values |
|---|---|
HTTP Method | PUT |
| Request URI | /property?path={ resource path }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } Content-Type: application/json |
| Payload | [ {"name":"<property name>","value":[<array of updated values>] }] |
| Description | Update the respective properties with the newly passed array of properties |
| Response Type | JSON |
| 204 No Content | |
| Response Type | application/json |
Delete a Property of a Given Resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | /property?path={ resource path }&name={property name}&user={ user name} |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Description | Deletes the specified property from the given resource |
| Response | HTTP 204 No Content |
| Response TypeJSON | application/json |