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 |
| required The name of the workspace. |
|
|
| optional, default is The absolute path to the property within the workspace. |
|
|
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"
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 |
| required The name of the workspace. |
|
|
| optional, default is The absolute path to the node within the workspace where the new property should be added. |
|
|
name | required The name of the new property. | query | String |
value | required The value of the new property. | query | List |
type | optional, default is The PropertyType to be added. | query | String |
multiple | optional, default is 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 | Parameter type | Data type |
| required The name of the workspace. |
|
|
| optional, default is The absolute path to the node within the workspace where the new property should be added. |
|
|
name | required The name of the new property. | query | String |
value | required The value of the new property. | query | List |
type | optional, default is The PropertyType to be added. | query |
|
multiple | optional, default is 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 | Parameter type | Data type |
| required The name of the workspace. |
|
|
| optional, default is The path of the property which you want to delete.
|
|
|
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
-i
option with cURL to show the HTTP response headers.