...
Attributes | Values |
---|---|
HTTP Method | GET |
Request URI | /properties?path={ resource path }&start={ start page }&size={ number of records } |
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 } |
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 | PUT |
Request URI | /property?path={ resource path } |
HTTP Request Headers | Authorization: Bearer { OAuth access token } Content-Type: application/json |
Payload | [ {"name":"propperty1","value":["value1","value2"]} ] |
Description | Add the array of properties for the given resource |
Response | 204 No Content |
Response TypeJSON | application/json |
Update Properties of a Given Resource
Attributes | Values |
---|---|
HTTP Method | POST |
Request URI | /property?path={ resource path } |
HTTP Request Header | Authorization: Bearer { OAuth access token } Content-Type: application/json |
Payload | [ {"name":"propperty1","value":["value3","value4"]} ] |
Description | Update the respective properties with the newly passed array of properties |
Response | HTTP 204 No Content |
Response TypeJSON | application/json |
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: Bearer { OAuth access token } |
Description | Deletes the specified property from the given resource |
Response | HTTP 204 No Content |
Response TypeJSON | application/json |