get uri
/members/{member}/uris/{uri} [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9900 | 5.9900 | xml, json |
Description
Specify an ID to retrieve information about a single URI object.
This service does not return the content, it returns key information about the URI such as its media type, location, identifiers, type and more.
Use this service when the ID is known but the location is required.
If the location or URL is known, but the ID is required, use this service /members/{member}/uris/forurl
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| sharing | Whether to include sharing information | no | boolean | false |
Permission
This service is restricted to a member with access to the URI.
Response
If a matching URI is found, this service returns it as a <uri> element:
<uri id="[id]"
scheme="[scheme]"
host="[host]"
port="[port]"
path="[path]"
decodedpath="[decodedpath]"
external="[true|false]"
[archived="true"]
[folder="true"]
[docid="[docid]"]
[mediatype="[mediatype]"]
[documenttype="[documenttype]"]
[title="My Document"]
[created="[created]"]
[modified="[modified]"]>
<displaytitle>My Document</displaytitle>
[<description>This is my document</description>]
[<labels>mylabel1,mylabel2</labels>]
[<sharing hidden="2">
<share editable="true"
addcomments="true"
default="true">
<group name="my-group1" .../>
</share>
<share editable="true"
addcomments="false">
<group name="my-group2" .../>
</share>
<share editable="false"
addcomments="true">
<group name="my-group3" .../>
</share>
</sharing>]
</uri>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x0202 | The Group was not found. |
| 0x0208 | The URI was not found. |