Get summary of version history for a link

get/links/@item/versions

Gets a summary of version history for a link. Version summaries contain a link to fetch the full version representation.

Request Samples

1

Response Samples

1{
2  "name": "string",
3  "start": 0,
4  "limit": 0,
5  "count": 0,
6  "accept": "string",
7  "links": [
8    {
9      "method": "string",
10      "rel": "string",
11      "uri": "string",
12      "href": "string",
13      "title": "string",
14      "type": "string",
15      "itemType": "string",
16      "responseType": "string",
17      "responseItemType": "string"
18    }
19  ],
20  "version": 0,
21  "items": [
22    {
23      "typeName": "string",
24      "id": "string",
25      "version": "string",
26      "displayLabel": "string",
27      "operation": "string",
28      "createdBy": "string",
29      "createdAt": "2019-08-24T14:15:22Z",
30      "links": [
31        {
32          "method": "string",
33          "rel": "string",
34          "uri": "string",
35          "href": "string",
36          "title": "string",
37          "type": "string",
38          "itemType": "string",
39          "responseType": "string",
40          "responseItemType": "string"
41        }
42      ]
43    }
44  ]
45}

Query Parameters

NameTypeRequiredDescription
includeDisplayLabel
boolean
false

Specifies whether to include the display label for the link.

Default:
false
limit
integer
false

The maximum number of items to return in a page of results.

Default:
40
start
integer
false

The start index. This is used for paging.

Default:
0
_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

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

Version history was not available for the specified link.

Schema
404Not Found

The specified link was not found.

Schema