Get subnodes
GET {{baseUrl}}/v2/nodes/:id/nodes?where_type=in laboris magna&where_type=in&where_name=aliquip aute&where_facet=aliquip aute&where_status=in laboris magna&where_status=in&actions=aliquip aute&sort=aliquip aute&page=-11141396&limit=-11141396&show_hidden=true&fields=aliquip aute&expand=aliquip aute&metadata=irure labore Duis dolor ea&state=irure labore Duis dolor ea&suppress_response_codes=irure labore Duis dolor ea
Browses the node, returning info on its child nodes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
where_type | string | Filter on node type. <ul><li>-1 : get all containers</li><li>-2 : get all searchable objects</li><li>-3 : get all non-containers</li></ul>Example to get all non-containers<br><code>?where_type=-3</code> | |
where_type | string | Filter on node type. <ul><li>-1 : get all containers</li><li>-2 : get all searchable objects</li><li>-3 : get all non-containers</li></ul>Example to get all non-containers<br><code>?where_type=-3</code> | |
where_name | string | Filter on node name<br><br>Example to filter on 'abc' name<br><code>?where_name=abc</code> | |
where_facet | string | Filter on facet values. Can be specified multiple times in the query string using the '&' separator (?where_facet=....&where_facet=...)<br><br>Example to apply the Content Type facet with ID 2095, for documents (144), folders (0) and all containers (-1)<br><code>?where_facet=2095:144 | |
where_status | string | Filter on status of the node. | |
where_status | string | Filter on status of the node. | |
actions | string | Retrieve actions for the node. This is similar to 'commands' for v1 (E.g. actions=delete&actions=open). Note: For best performance minimize the number of actions requested.<br><br>Example to get the delete and open actions<br><code>?actions=delete&actions=open</code> | |
sort | string | Order by named column. Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.<br><br>Example to sort by name (ascending by default)<br><code>?sort=name</code><br><br>Sort by name descending<br><code>?sort=desc_name</code> | |
page | number | Page number<br><br>Example to get page 2<br><code>?page=2</code> | |
limit | number | Page size<br><br>Example to get a page size of 5 results<br><code>?limit=5</code> | |
show_hidden | boolean | Show hidden objects (default False)<br><br>Example to show hidden objects<br><code>?show_hidden=true</code> | |
fields | string | The 'fields' parameter can be used to filter the results even further, if necessary.<br><br>Show the 'properties' field (which contains node information such as name, description, parent_id, etc.)<br><code>?fields=properties</code><br><br>Show the 'properties' and 'categories' fields (node and category information, respectively)<br><code>?fields=properties&fields=categories</code><br><br>Show the 'properties' and 'categories' fields (node and category information, respectively) but only the parent_id and description from 'properties'<br><code>?fields=properties{parent_id,description}&fields=categories</code><br><br>Show the 'versions' field (version information) but only the latest version<br><code>?fields=versions.element(0)</code><br><br>Show the 'permissions' field (node permissions) but only the first 5 permissions (includes Default Access and ACLs)<br><code>?fields=permissions.limit(5)</code> | |
expand | string | Resolve individual fields<br><br>Expand the id and parent_id of 'properties' (resolving the id to extra node information, and resolving the parent_id to extra node information about the parent)<br><code>?expand=properties{id,parent_id}</code> | |
metadata | string | Returns metadata (data type, field length, min/max values, etc.) about data, which will be returned under results.metadata / metadata_map / metadata_order. This is an empty parameter, thus no value is required (e.g. ?metadata).<br><br>Example to get metadata<br><code>?metadata</code> | |
state | string | Returns the metadata state token for data (used for edit conflict resolution), which will be returned under results.state. This is an empty parameter, thus no value is required (e.g. ?state).<br><br>Example to get the metadata state token<br><code>?state</code> | |
suppress_response_codes | string | Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).<br><br>NOTE: This parameter does not require a value, so it should be specified as <ul><li><b>[Query String]:</b><code>?suppress_response_codes</code></li><li><b>[Form Body (where the value is an empty string)]</b>: <code>suppress_response_codes = </code></li></ul> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"collection":[{"paging":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"sorting":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"paging":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"sorting":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"links":[{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"results":[{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]}