list uri xrefs
/groups/{group}/uris/{uri}/xrefs [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9500 | 5.6900 | xml |
Description
Returns all xrefs from the given URI.
Does not return reverse xrefs for external URIs (URLs). Use list URI reversexrefs service instead.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| forward | Whether to include forward xrefs | no | boolean | true |
| includetypes | A comma-separated list of types of xrefs to include (none, embed,transclude) | no | integer | |
| page | The page to load | no | integer | 1 |
| pagesize | The number of results per page | no | integer | 1000 |
| publicationid | The ID of the publication for version parameter | no | publicationid | |
| reverse | Whether to include reverse xrefs | no | boolean | true |
| version | Version of the document | no | string | |
| versionid | Version id of the document | no | integer |
Permission
This service is restricted to guest and higher unless the group is accessible to public.
Response
Format is as follows (ordered by urititle then title):
<uri id=[id] ... >
<!-- URI details -->
<displaytitle>[displaytitle]</displaytitle>
...
<!-- Xrefs found -->
<xrefs>
<xref title="[title]"
urititle="[target URI title]"
uriid="[target ID]" ..... />
<xref title="[title]"
urititle="[target URI title]"
uriid="[target ID]" ..... />
...
</xrefs>
<!-- Reverse Xrefs found, if required -->
<reversexrefs>
<reversexref title="[title]"
urititle="[source URI title]"
uriid="[source ID]" ..... />
...
</reversexrefs>
</uri>
Error Handling
No specific errors expected for this service.