Skip to main content

 Services

Web services from /about to /webhooks

get uri

/members/{member}/uris/{uri} [GET]

com.pageseeder.uri.GetURI

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

NameDescriptionRequiredTypeDefault
sharingWhether to include sharing informationnobooleanfalse

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

CodeCause / Description
0x0202The Group was not found.
0x0208The URI was not found.
Created on , last edited on