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 or editurls is true in the advanced group configuration).

The parameter folder=inherit means it uses the value set by the URI owner. If no value has been set by the URI owner, folder will default to false.

Note

When an external URI is created the ancestor folder URIs for that URI will be created automatically (this is to allow hierarchical browsing) e.g. for URL http://example.com/acme/test/my.html the following folder external URIs will be created:

  • http://example.com/acme/test
  • http://example.com/acme

So they don't appear in search results or flat browsing these folders are set as archived. If this service is later used to create these URIs they will be unarchived but the folder parameter will be ignored because folder=false would interfere with hierarchical browsing.

Parameters

NameDescriptionRequiredTypeDefault value
urlthe URLyesurl
descriptionthe descriptionnostring
folderif this URI is a folder (ignored if URI already exists - SEE NOTE ABOVE)[true|false|inherit]nostringinherit
labelsthe labels (comma-separated list)nostring
mediatypethe mediatype (URI owner only)nostring
notifyif the creation should notify the group [normal|announce|silent]nostringsilent
sizethe size in bytes (URI owner only)nolong
titlethe titlenostring

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