Skip to main content

 Web service API

How to use PageSeeder's Web service API

get uri

/groups/{group}/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 /groups/{group}/uris/forurl

Parameters

No parameters required.

Permission

This service is restricted to guest and higher unless the group is accessible to public.

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>]
</uri>

Error Handling

No specific errors expected for this service.

Created on , last edited on