Get summary of action history for a document

get/documents/{objectTypeName}/{documentId}/actions

Gets a summary of action history for a document. 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 document. 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 document, providing an exhaustive list of all possible filter options.

Request Samples

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      "actionId": "string",
24      "action": "string",
25      "actionType": "string",
26      "objectType": "string",
27      "objectId": "string",
28      "objectVersion": "string",
29      "createdBy": "string",
30      "createdAt": "2019-08-24T14:15:22Z",
31      "links": [
32        {
33          "method": "string",
34          "rel": "string",
35          "uri": "string",
36          "href": "string",
37          "title": "string",
38          "type": "string",
39          "itemType": "string",
40          "responseType": "string",
41          "responseItemType": "string"
42        }
43      ],
44      "version": 0,
45      "localizedMessage": "string"
46    }
47  ]
48}

Path Parameters

Name	Type	Required	Description
documentId	string	true	The ID of the document.
objectTypeName	string	true	The object type of the document.

Query Parameters

Name	Type	Required	Description
actionType	string	false	The filter criteria for the request. The Basic Selection filter syntax for the 'actionType' field is supported. For example: '?actionType=DOCUMENT_EDIT\|COMMENT_CREATE' would return only DOCUMENT_EDIT or COMMENT_CREATE 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

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	If set to 'application/vnd.sas.investigate.action.type', the 'available action types' is returned.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	Action history was not available for the specified document.	Schema
404	Not Found	The specified document was not found.	Schema