Properties endpoint API

This page describes the properties endpoint, which can be used to access and manipulate JCR properties.

Everything you can do with the properties endpoint can also be done with the nodes endpoint. We recommend using the nodes endpoint instead.

GET

Returns a string representation of a property from the specified workspace and path.

Request URL

/.rest/properties/v1/{workspace}/{path}

Parameters

Parameter Description Type Data Type

workspace

required

The name of the workspace.

path

String

path

optional, default is /

The absolute path to the property within the workspace.

path

String

Example

Read the keywords property of the travel site from the website workspace.

Get JSON Get XML

curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/properties/v1/website/travel/keywords' \
-u superuser:superuser
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/properties/v1/website/travel/keywords' \
-u superuser:superuser -H "Accept: application/xml"

Get JSON Get XML

{
   "name":"keywords",
   "type":"String",
   "multiple":false,
   "values":[
      "Magnolia CMS, Open Source CMS, Content management, Demonstration project, Demo project, Demo, Online demo, Website builder"
   ]
}
<property>
   <multiple>false</multiple>
   <name>keywords</name>
   <type>String</type>
   <values>
      <value>Magnolia CMS, Open Source CMS, Content management, Demonstration project, Demo project, Demo, Online demo, Website builder</value>
   </values>
</property>

PUT

Adds a new property to a node at the specified workspace and path.

Request URL

/.rest/properties/v1/{workspace}/{path}

Parameters

Parameter Description Type Data Type

workspace

required

The name of the workspace.

path

String

path

optional, default is /

The absolute path to the node within the workspace where the new property should be added.

path

String

name

required

The name of the new property.

query

String

value

required

The value of the new property.

query

List

type

optional, default is String

The PropertyType to be added.

query

String

multiple

optional, default is false

Indicates if the property should be a multivalue property.

query

boolean

POST

Updates an existing property of a node at the specified workspace and path.

The method is only changing the properties passed with the response body. Other existing properties and subnodes are not affected.

Request URL

/.rest/properties/v1/{workspace}/{path}

Parameters

Parameter Description Type Data Type

workspace

required

The name of the workspace.

path

String

path

optional, default is /

The absolute path to the node within the workspace where the new property should be added.

path

String

name

required

The name of the new property.

query

String

value

required

The value of the new property.

query

List

type

optional, default is String

The PropertyType to be added.

query

String\

multiple

optional, default is false

Indicates if the property should be a multivalue property.

query

boolean

DELETE

Deletes a property of a node at the specified workspace and path.

Request URL

/.rest/properties/v1/{workspace}/{path}

Parameters

Parameter Description Type Data Type

workspace

required

The name of the workspace.

path

String

path

optional, default is /

The path of the property which you want to delete.

Always provide a path. If default / is used, this will return a 404, property not found.

path

String

Example

Delete the keywords property of the travel site in the website workspace.

curl -X DELETE -i http://localhost:8080/magnoliaAuthor/.rest/properties/v1/website/travel/keywords \
--user superuser:superuser
Tip: Use the -i option with cURL to show the HTTP response headers.
Feedback