Web service API

How to use PageSeeder's Web service API

get uri

/groups/{group}/uris/{uri} [GET]

com.pageseeder.uri.GetURI

Description

Load a single URI object based on it ID.

This service does not return the actual URI content, it is designed instead to return useful information about the URI such as its media type, location, identifiers, type, etc...

Use this service when you have the ID of a document or URL but need to know its location. If you have a document's location or a URL, but need its ID, use this service instead /groups/{group}/uris/forurl

Parameters

No parameters required.

Permission

Undocumented permissions requirements.

Response

If a matching URI is found, this service will return 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" shareedits="true" sharexrefs="true" addcomments="true" default="true">
         <group name="my-group1".../>
       </share>
       <share editable="true" shareedits="true" sharexrefs="true" addcomments="false">
         <group name="my-group2" .../>
       </share>
       <share editable="false" addcomments="true">
         <group name="my-group3" .../>
       </share>
     </sharing>]
</uri>

Error handling

No specific errors expected for this service.

Created on , last edited on