Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

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

Parameter 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.

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"

{  
   "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

List

Parameter

Description

Parameter 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.

queryString
value

required

The value of the new property.

queryList
type

optional, default is String

The PropertyType to be added.

queryString
multiple

optional, default is false

Indicates if the property should be a multivalue property.

queryboolean

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

Parameter 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.

queryString
value

required

The value of the new property.

queryList
type

optional, default is String

The PropertyType to be added.

queryString
multiple

optional,  default is false

Indicates if the property should be a multivalue property.

queryboolean

DELETE

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

Request URL

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

Parameters

Parameter

Description

Parameter 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.

(warning) 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
(info) Tip: Use the -i option with cURL to show the HTTP response headers.