Skip to main content

 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 label values, use empty string to clear the existing labelsno labels
nameThe new name. If the URI is a folder, a thread is 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

This service requires contributor or higher.

Response

The output has the following format:

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

Error Handling

CodeCause / Description
0x1209If the document ID already exists
0x120AIf the document ID contains invalid characters
Created on , last edited on