Web service API

How to use PageSeeder's Web service API

uri

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

com.pageseeder.uri.SaveURIProperties

Description

Sets the URI Properties

Saves the core properties of a URI.

Only the parameters which are specified are taken into account.

Parameters

NameDescriptionRequiredTypeDefault value
descriptionThe new descriptionnostring
documentidThe new document IDnostring
labelsA comma-separated list of labels, use empty string to clear the existing labels.no labels
nameThe new name, if the URI is a folder, a thread will be launchednostring
publicationidThe new publication ID (makes this URI the root document of the publication)nopublicationid
publicationtypeThe type of the publication (requires publicationid)nopublicationtype
titleThe new titlenostring

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

CodeCause / Description
0x1209 If the document ID already exists
0x120A If the document ID contains invalid characters

Created on , last edited on