Get a version from a links version history

get/links/@item/versions/{version}

Gets the full representation of a version from a links version history. The link to fetch the full representation is returned with version summaries.

Request Samples

Response Samples


1{
2  "typeName": "string",
3  "id": "string",
4  "version": "string",
5  "displayLabel": "string",
6  "operation": "string",
7  "createdBy": "string",
8  "createdAt": "2019-08-24T14:15:22Z",
9  "links": [
10    {
11      "method": "string",
12      "rel": "string",
13      "uri": "string",
14      "href": "string",
15      "title": "string",
16      "type": "string",
17      "itemType": "string",
18      "responseType": "string",
19      "responseItemType": "string"
20    }
21  ],
22  "values": [
23    {
24      "name": "string",
25      "label": "string",
26      "previousVersionValue": {},
27      "value": {},
28      "type": "string",
29      "valueChanged": true
30    }
31  ]
32}

Path Parameters

Name	Type	Required	Description
version	string	true	The version of the links history to fetch.

Query Parameters

Name	Type	Required	Description
changedOnly	boolean	false	Specifies whether to return only fields that have changed between the previous and requested link version. Default: false
includeDisplayLabel	boolean	false	Specifies whether to include the display label for the link in the version. Default: false
_id	string	true	The ID for an individual link. A link ID uses the following format: `${relationshipName}\|_\|${fromEntityTypeName}\|_\|${toEntityTypeName}\|_\|${fromEntityId}\|_\|${toEntityId}` where `\|_\|` is the delimiter between link ID components. Link ID component details: `relationshipName` - The relationship type name that defines the link. `fromEntityTypeName` - The entity type name of the starting point for the link. `fromEntityId` - The unique identifier of the entity that is the starting point for the link. `toEntityTypeName` - The entity type name of the destination point for the link. `toEntityId` - The unique identifier of the entity that is the destination point for the link. When submitting the request, the pipe character (`\|`) must be percent-encoded as `%7C`. See below for an example of the pipe character properly encoded: `${relationshipName}%7C_%7C${fromEntityTypeName}%7C_%7C${toEntityTypeName}%7C_%7C${fromEntityId}%7C_%7C${toEntityId}`

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	Version history was not available for the given link.	Schema
404	Not Found	The specified link or the requested version was not found.	Schema