Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
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.
Returns a string representation of a property from the specified workspace and path.
/.rest/properties/v1/{workspace}/{path}
Parameter | Description | Parameter type | Data type |
| required The name of the workspace. |
|
|
| optional, default is The absolute path to the property within the workspace. |
|
|
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"
Adds a new property to a node at the specified workspace and path.
/.rest/properties/v1/{workspace}/{path}
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 |
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.
/.rest/properties/v1/{workspace}/{path}
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 |
Deletes a property of a node at the specified workspace and path.
/.rest/properties/v1/{workspace}/{path}
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.
|
|
|
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.