Skip to main content

 Web service API

How to use PageSeeder's Web service API

get uri forurl group

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

com.pageseeder.uri.GetURIWithURL

Description

Load the URI in a group specified by the url parameter.

Parameters

Name Description Required Type Default value
url the url to look for yes url

Permission

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

Response

If found, the corresponding URI is returned as a single <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 generator.

Created on , last edited on