Skip to main content

 Web service API

How to use PageSeeder's Web service API

create externaluri

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

com.pageseeder.uri.CreateExternalURI

Description

This service is deprecated as of PageSeeder v5.9900 use Service: /members/{member}/externaluris [POST] instead.

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

Name Description Required Type Default value
description the description no string
labels the labels (comma-separated list) no string
mediatype the mediatype - URI owner only no string
notify
notify-async
size the size - URI owner only (positive long) no string
title the title no string
url the URL yes 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 generator.

Created on , last edited on