Get summary of action history for a link

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

Gets a summary of action history for a link. Action history summaries contain a link to fetch the full representation. The 'Accept-Item' request header can be used to fetch the 'available action types' for this link. If the 'Accept-Item' header is set to "application/vnd.sas.investigate.action.type", this endpoint returns a collection of action types. This collection represents all of the action types that exist historically for the specified link, providing an exhaustive list of all possible filter options.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/svi-datahub/links/@item/actions?_id=witnessed_by%7C_%7Cintel_report%7C_%7Cperson%7C_%7Ce5343e0e-3d68-11e8-b467-0ed5f89f718b&start=0&limit=10",
7      "uri": "/svi-datahub/links/@item/actions?_id=witnessed_by%7C_%7Cintel_report%7C_%7Cperson%7C_%7Ce5343e0e-3d68-11e8-b467-0ed5f89f718b&start=0&limit=10",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.investigate.action.summary"
10    },
11    {
12      "method": "GET",
13      "rel": "collection",
14      "href": "/svi-datahub/links/@item/actions?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
15      "uri": "/svi-datahub/links/@item/actions?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.investigate.action.summary"
18    },
19    {
20      "method": "GET",
21      "rel": "up",
22      "href": "/svi-datahub/links/@item?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
23      "uri": "/svi-datahub/links/@item?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
24      "type": "application/vnd.sas.investigate.action.summary"
25    },
26    {
27      "method": "GET",
28      "rel": "availableActionTypes",
29      "href": "/svi-datahub/links/@item/actions?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
30      "uri": "/svi-datahub/links/@item/actions?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
31      "type": "application/vnd.sas.collection",
32      "itemType": "application/vnd.sas.investigate.action.type"
33    }
34  ],
35  "name": "actions",
36  "start": 0,
37  "count": 1,
38  "items": [
39    {
40      "actionId": "2",
41      "action": "Edited the relationship",
42      "actionType": "RELATIONSHIP_EDIT",
43      "objectType": "Witnessed by",
44      "objectId": "witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
45      "objectVersion": "2",
46      "createdBy": "videmo",
47      "createdAt": "2023-06-29T22:17:51.061Z",
48      "links": [
49        {
50          "method": "GET",
51          "rel": "self",
52          "href": "/svi-datahub/links/@item/actions/2?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
53          "uri": "/svi-datahub/links/@item/actions/2?_id=witnessed_by|_|intel_report|_|person|_|e5343e0e-3d68-11e8-b467-0ed5f89f718b",
54          "type": "application/vnd.sas.investigate.action"
55        }
56      ],
57      "version": 1
58    }
59  ],
60  "limit": 10,
61  "version": 2
62}

Query Parameters

NameTypeRequiredDescription
actionType
string
false

The filter criteria for the request. The Basic Selection filter syntax for the 'actionType' field is supported. For example: '?actionType=RELATIONSHIP_EDIT' would return only RELATIONSHIP_EDIT actions.

limit
integer
false

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

Default:
10
sortBy
string
false

The sort criteria for the request. Only sorting by the 'createdAt' field descending or ascending is supported.

Default:
createdAt:descending
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}

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
false

If set to 'application/vnd.sas.investigate.action.type', the 'available action types' are returned.

Responses

StatusMeaningDescription
200OKThe request succeeded. Schema
400Bad RequestAction history was not available for the specified link. Schema
404Not FoundThe specified link was not found. Schema