Web service API

How to use PageSeeder's Web service API

create uri xref

/members/{member}/groups/{group}/uris/{uri}/xrefs [POST]

com.pageseeder.xref.CreateXRef

Description

Create a new XRef.

Adds an XRef from the current URI to a target URI specified by the parameter targeturi. The XRef will link the two URIs at their fragment named "default". The XML output follows the PSML standard.

Parameters

NameDescriptionRequiredTypeDefault value
targeturi The target uri id yes long
display The display type, allowed values are 'manual', 'document', 'document+fragment', 'document+manual' no enum document
labels Comma-separated list of labels no string
title The title of the xref no string

Permission

Undocumented permissions requirements.

Response

<xref-creation>
   <xref id="123"
         title="[name]"
         uriid="[target uriid]" ...>
     [content]
   </xref>
 </xref-creation>
 

Error Handling

No specific errors expected for this service.

Created on , last edited on