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.

Parameters

NameDescriptionRequiredTypeDefault value
descendant-groups comma-separated list of group names or ids to add the descendant URIs to no string
description the new description no string
folder if this URI is a folder [true|false|inherit] no string
groups comma-separated list of group names or ids to add the URI to no string
labels the new labels (comma-separated list) no string
mediatype the new mediatype no string
notify if the change should notify the group [normal|announce|silent] no string silent
size the new size (positive integer) no string
title the new title no string
url the new URL no string

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