Skip to main content

 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

This service is deprecated, use Service: /members/{member}/groups/{group}/uris/{uri}/metadata [PUT] instead and add xref to a <property datatype="xref">.

Create a new XRef.

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

Parameters

NameDescriptionRequiredTypeDefault value
targeturiThe target uri idyeslong
displayThe display type, allowed values are manual, document, document+fragment, document+manualnoenumdocument
labelsComma-separated list of labelsnostring
titleThe title of the xrefnostring

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