list uri uris forurl
/groups/{group}/uris/forurl/uris [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.6900 | 6.0000 | xml, json |
Description
List all the URIs with a particular relationship to a specified URI.
This services will not work for external URIs.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| url | The URL for URI | yes | url | |
| exclude | Exclude URIs under this folder path relative to URI (e.g. archive) | no | string | |
| page | The page to load | no | integer | 1 |
| pagesize | The number of results per page | no | integer | 200 |
| relationship | The relationship of returned URIs to specified URL, can be children, descendants, ancestors, ancestors-siblings or siblings | no | enum | children |
| type | The type of URIs to return, can be document, folder or all | no | enum | all |
If relationship=ancestors-siblings then ancestors and siblings of the the URI are returned including siblings of all the ancestors, and children of the URI.
If relationship=children or siblings then the URIs are ordered with folders returned first, then alphabetically on title and then alphabetically on path, otherwise they are ordered by path.
Permission
This service is restricted to guest and higher unless the group is accessible to public.
Response
This service returns each URI as a <uri> element:
<uris>
<uri id="[id]" path="[path]" ...>
<!-- All URI's attribute are included -->
<displaytitle>[title]</displaytitle>
</uri>
...
</uris>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1212 | When the supplied URL is missing or invalid. |