Web service API

How to use PageSeeder's Web service API

get uri forurl

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

com.pageseeder.uri.GetURIWithURL

Description

Specify a URL in the request to retrieve information about a single URI.

This service does not return content, it returns key information about a URI such as media type, identifiers, type and more.

Use this service when a URL is known, but an identifier or permalink is required.

Parameters

NameDescriptionRequiredTypeDefault value
urlThe url to look for.nourl

Permission

Permissions requirements to be updated.

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 service.

Created on , last edited on