Web service API

How to use PageSeeder's Web service API

get uri xrefs

/uris/{uri}/xrefs [GET]

This service is obsolete since version 5.4000

Description

Load all XRefs for a URI

This item is obsolete!

This Service is now obsolete and has been removed from PageSeeder 5.4+. Invoking this Service will cause an HTTP error 404.

Returns all XRefs from the given URI.

The following parameters are accepted:

  • includeTypes – a comma-separated list of types of XRefs to includes (optional, all XRefs are included if not specified)
  • ps-release – a release to load for the main document (optional, current release is loaded if not specified)
  • ps-releaseStatus – the status of a release to load for the main document (optional, current release is loaded if not specified)

Parameters

NameDescriptionRequiredTypeDefault value
include-types A comma-separated list of types of xrefs to includes (optional, all xrefs are included if not specified) no strings All types
ps-release A release to load for the main document (optional, current release is loaded if not specified) no string Current
ps-releaseStatus The status of a release to load for the main document (optional, current release is loaded if not specified) no  string Current status

Permission

Undocumented permissions requirements.

Response

Format is as follows:

<uri>
   <!-- All URI details -->
   <id>[id]</id>
   <path>[path</path>
    ...
   <!-- XRefs found -->
   <xrefs>
      <xref title="[title]" display="[display]" uriid="[target ID]" ..... />
      <xref title="[title]" display="[display]" uriid="[target ID]" ..... />
      ...
   </xrefs>
   <!-- Reverse XRefs found, if required -->
   <reversexrefs>
      <xref title="[title]" display="[display]" uriid="[target ID]" ..... />
       ...
   </reversexrefs>
</uri>

Error handling

No specific errors expected for this generator.

Created on , last edited on