Skip to main content

 Web service API

How to use PageSeeder's Web service API

archive externaluri

/members/{member}/groups/{group}/externaluris/{uri}/archive [POST]

com.pageseeder.uri.ArchiveExternalURI

Description

Archive an existing external URI.

Parameters

NameDescriptionRequiredTypeDefault value
descendantsIf the descendant external URIs are also archivednobooleanfalse

 

Permission

This service requires contributor or higher.

Response

The output has the following format:

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

Error Handling

No specific errors expected for this service.

Created on , last edited on