Web service API

How to use PageSeeder's Web service API

create externaluri

/members/{member}/groups/{group}/externaluris [POST]

com.pageseeder.uri.CreateExternalURI

Description

Create an external URI

Some parameters can only be used if the group on the request is the URI owner (i.e. the group has a groupfolder which covers the url specified).

The parameter folder=inherit means it uses the value set by the URI owner.

Parameters

NameDescriptionRequiredTypeDefault value
url the URL yes url
description the description no string
folder if this URI is a folder [true|false|inherit] no string inherit
labels the labels (comma-separated list) no string
mediatype the mediatype - URI owner only no string
notify if the creation should notify the group [normal|announce|silent] no string silent
size the size - URI owner only (positive long) no long
title the title no string

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<uri-creation>
   <uri id="[id]"
        path="[path]" ...>
      <displaytitle>[title]</displaytitle>
      ...
   </uri>
</uri-creation>

Error handling

No specific errors expected for this service.

Created on , last edited on