Properties with REST API

This section explains the following REST operations regarding the property of resources which have been secured with Basic Auth.

The following terms explain the meaning of the 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 eg: [ {"name":"Name","value":["Ajith","Eranda"]} ]
start	Start page number
size	Number of tags to be fetched
user	Username of the user

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.

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

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

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