Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributesValues

HTTP Method                

GET
Request URI/properties?path={ resource path }&start={ start page }&size={ number of records }
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
DescriptionThis retrieves all the properties posted on the specific resource with a specified start page and size.
ResponseHTTP 200 OK
Response TypeJSONapplication/json

Get a Property of a Given Resource

AttributesValues

HTTP Method                

GET
Request URI/property?path={ resource path }&name={ property name }
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
DescriptionThis retrieves the specific property associated with the given property name.
ResponseHTTP 200 OK
Response TypeJSONapplication/json

Add Properties to a Resource

AttributesValues

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"]} ]     
DescriptionAdd the array of properties for the given resource
Response204 No Content
Response TypeJSONapplication/json

Update Properties of a Given Resource

AttributesValues

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"]} ]
DescriptionUpdate the respective properties with the newly passed array of properties
ResponseHTTP 204 No Content
Response TypeJSONapplication/json

Delete a Property of a Given Resource

AttributesValues

HTTP Method                

DELETE
Request URI/property?path={ resource path }&name={property name}
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
DescriptionDeletes the specified property from the given resource
ResponseHTTP 204 No Content
Response TypeJSONapplication/json