Get summary of version history for a link

get/links/@item/versions
Internal-Use Only

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  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/svi-datahub/links/@item/versions?start=0&limit=40",
7      "uri": "/svi-datahub/links/@item/versions?start=0&limit=40",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.investigation.version.summary+json"
10    },
11    {
12      "method": "GET",
13      "rel": "collection",
14      "href": "/svi-datahub/links/@item/versions",
15      "uri": "/svi-datahub/links/@item/versions",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.investigation.version.summary+json"
18    }
19  ],
20  "name": "versions",
21  "accept": "application/json application/vnd.sas.collection+json",
22  "count": 1,
23  "items": [
24    {
25      "typeName": "intel_report__witnessed_by",
26      "id": "witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
27      "version": "2",
28      "operation": "update",
29      "createdBy": "videmo",
30      "createdAt": "2023-06-29T22:17:51.061Z"
31    }
32  ],
33  "version": 2
34}

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
200OKThe request succeeded. Schema
400Bad RequestVersion history was not available for the specified link. Schema
404Not FoundThe specified link was not found. Schema