Nodes REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
Nodes
Provides sub nodes and their data given a node.
Applicable to: JCR parent nodes.
GET
Returns an array of sub nodes.
Requires that the caller is authorized to READ the node.
The caller must also be authorized to MANAGE_USERS on the sv:site to get nodes for any of these types:
- sv:adminPrincipalRepository
- sv:directory
- sv:directoryRepository
- sv:externalPrincipalRepository
- sv:globalVirtualGroup
- sv:principalRepository
- sv:simpleUser
- sv:systemGroup
- sv:systemUser
- sv:user
- sv:userGroup
- sv:userContainer
- sv:virtualGroup
- sv:virtualGroupRepository
The caller must also be authorized to MANAGE_USERS or MANAGE_USER_IDENTITIES on the sv:site to get nodes for type:
- sv:userIdentity
| Name | Type | Default | Description | Since |
|---|---|---|---|---|
| includes | array |
An array of node types to include in the result | ||
| excludes | array |
An array of node types to exclude from the result | ||
| properties | array |
An array of sub node properties to include. ["*"] returns all properties | 4.5 | |
| skip | number |
0 | Skips leading number of hits | 4.5 |
| limit | number |
100 000 | Limits number of hits to return | 4.5 |
Example input
{
"includes": ["sv:page", "sv:folder"],
"properties": ["creationDate", "template"],
"limit": 2
}
Example response
[
{
"id": "4.356a20e51619f3c5a1a1b8",
"type": "sv:page",
"name": "About",
"path": "/demo/Page Repository/Site Page/About",
"properties": {
"creationDate": 1369145417795,
"template": "91.356a20e51619f3c5a1a193"
}
},
{
"id": "19.356a20e51619f3c5a1a1b2",
"type": "sv:folder",
"name": "Other",
"path": "/demo/Page Repository/Site Page/Other",
"properties": {
"creationDate": 1369151012936
}
}
]
Did you find the content on this page useful?