Web service API

How to use PageSeeder's Web service API

list uri xrefs

/groups/{group}/uris/{uri}/xrefs [GET]



Load a URI's XRefs.

Returns all XRefs from the given URI.


NameDescriptionRequiredTypeDefault value
forwardWhether to include forward XRefs.nobooleantrue
includetypesA comma-separated list of types of xrefs to include (none, embed,transclude)nointeger
pageThe page to load.nointeger1
pagesizeThe number of results per page.nointeger1000
reverseWhether to include reverse XRefs.nobooleantrue
versionVersion of the document.nostring
versionidVersion id of the document.nointeger


Permissions requirements to be updated.


Format is as follows (ordered by urititle then title):

<uri id=[id] ... >
    <!-- URI details -->
    <!-- XRefs found -->
        <xref title="[title]"
              urititle="[target URI title]"
              uriid="[target ID]" ..... />
        <xref title="[title]"
              urititle="[target URI title]"
              uriid="[target ID]" ..... />
    <!-- Reverse XRefs found, if required -->
        <reversexref title="[title]"
                     urititle="[source URI title]"
                     uriid="[source ID]" ..... />

Error Handling

No specific errors expected for this service.

Created on , last edited on