list host externaluris
/hosts/{host}/externaluris [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9900 | 5.9900 | xml, json |
Description
Load all the external URIs for a specified host in the group specified in the request.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| archived | Include archived URIs | no | boolean | false |
| archivedfolders | Include archived folder URIs | no | boolean | false |
| 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 host, can be children, descendants | no | enum | children |
| type | The type of URIs to return, can be folder | no | string |
Permission
This service is restricted to guest and higher.
Response
The URI for the host are listed in as <uri> elements wrapped in a <uris> element:
<uris>
<uri id="[id]" path="[crole]" ...>
<!-- All URI's attribute are included -->
<displaytitle type="text/plain">[content of version]</displaytitle>
</uri>
...
</uris>
Error Handling
No specific errors expected for this service.