Get the history for any number of process instances

get/processes/history
Internal-Use Only

Retrieves the history for any number of process instances. The returned items are of type application/vnd.sas.investigation.workflow.historical.workflow.task+json.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/workflows/processes/history",
7      "uri": "/workflows/processes/history",
8      "type": "application/vnd.sas.collection"
9    }
10  ],
11  "name": "workflowProcessHistory",
12  "accept": "application/vnd.sas.investigation.workflow.historical.workflow.task",
13  "start": 0,
14  "count": 443,
15  "items": [
16    {
17      "version": 1,
18      "entityId": 100514,
19      "entityName": "person",
20      "entityLabel": "Person",
21      "workflowDefinitionId": "person_workflow:2:877ed08b-2bc4-11e9-b00f-f4939fed3251",
22      "workflowName": "person_workflow",
23      "workflowLabel": "Person Workflow",
24      "workflowLabelResource": "svi.workflow.person.1549633087059.label.txt",
25      "workflowDescriptionResource": "svi.workflow.person.1549633087059.description.txt",
26      "workflowVersion": 2,
27      "entityInstanceId": "85490a37-e537-4352-90b1-8eb26906fa48",
28      "entityInstanceLabel": "ll ll",
29      "id": "036cbc80-2bc5-11e9-b00f-f4939fed3251",
30      "name": "User Task PG2 All PP",
31      "definitionId": "UserTask1549632873900",
32      "processInstanceId": "036c9560-2bc5-11e9-b00f-f4939fed3251",
33      "participants": [
34        {
35          "id": "sviusrs",
36          "type": "GROUP",
37          "name": "Visual Investigator Users"
38        }
39      ],
40      "duration": 0,
41      "startedAt": "2019-02-08T17:14:37.752Z"
42    }
43  ],
44  "limit": 100,
45  "version": 2
46}

Query Parameters

NameTypeRequiredDescription
endAt
integer<int64>
false

Filters based on this end timestamp.

fields
string
false

The comma-separated list of resource members to return in the collection.

filter
string
false

Filters the collection using prefix function syntax using selected resource members.

limit
integer<int32>
false

The number of items that were requested for the collection.

Default:
10
removeCancelledProcesses
boolean
false

Do not include history data for those processes that were canceled.

Default:
false
sortBy
string
false

The sorting preference for selected resource members in the returned collection.

Default:
id:ascending
start
integer<int64>
false

The zero-based index of the first item in the collection.

Default:
0
startAt
integer<int64>
false

Filters based on this start timestamp.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema