Web service API

How to use PageSeeder's Web service API

externaluri

/members/{member}/groups/{group}/externaluris/{uri} [PATCH]

com.pageseeder.uri.EditExternalURI

Description

Edit an existing 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 the URL of an external URI is modified the ancestor folder URIs 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 modify these URIs with folder=false the original URI will be INACCESSIBLE in hierarchical browsing.

Parameters

NameDescriptionRequiredTypeDefault value
descendant-groupscomma-separated list of group names or ids to add the descendant URIs tonostring
descriptionthe new descriptionnostring
folderif this URI is a folder (use with caution - SEE NOTE ABOVE)[true|false|inherit]nostring
groupscomma-separated list of group names or ids to add the URI tonostring
labelsthe new labels (comma-separated list)nostring
mediatypethe new mediatype (URI owner only)nostring
notifyif the change should notify the group [normal|announce|silent]nostringsilent
sizethe new size in bytes (URI owner only)nolong
titlethe new titlenostring
urlthe new URLnostring

Permission

Undocumented permissions requirements.

Response

The output has the following format:

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

Error Handling

No specific errors expected for this service.

Created on , last edited on