Skip to main content

 Web service API

How to use PageSeeder's Web service API

externaluri

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

com.pageseeder.uri.EditExternalURI

Description

Edit an external URI (aka URL). The URI and it's properties are available to all members on the server.

Parameters

NameDescriptionRequiredTypeDefault value
urlThe URLnourl
descriptionThe descriptionnostring
labelsA comma-separated list of label valuesnostring
mediatypeThe mediatypenostring
sizeThe size in bytesnolong
titleThe titlenostring
type
The URL typenostring

Permission

This service requires contributor or higher in a group with edit all URLs permission.

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