Get history metrics summary for workflows

get/workflows/{workflowId}/processes/history/metrics
Internal-Use Only

Retrieves the history metrics summary for specific workflows. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/workflows/processes/history/metrics",
7      "uri": "/workflows/processes/history/metrics",
8      "type": "application/vnd.sas.collection"
9    }
10  ],
11  "name": "workflowProcessHistoryMetricSummary",
12  "accept": "application/vnd.sas.investigation.workflow.historical.metrics.summary",
13  "start": 0,
14  "count": 1,
15  "items": [
16    {
17      "version": 1,
18      "name": "Test_workflow",
19      "id": "Test_workflow",
20      "label": "Test Workflow",
21      "meanTimePerTask": 172249732.16896927,
22      "medianTimePerTask": 194848241.05517578,
23      "timeOnCompletedTasks": 0,
24      "timeOnUncompletedTasks": 1519759386926.812,
25      "meanTimePerTaskClaimTimeBasis": 172249732.16896927,
26      "medianTimePerTaskClaimTimeBasis": 194848241.05517578,
27      "timeOnCompletedTasksClaimTimeBasis": 1519759386926.812,
28      "timeOnUncompletedTasksClaimTimeBasis": 1519759386926.812,
29      "workflowVersions": [
30        {
31          "id": "Test_workflow:4:15297362-72bc-11ee-a8bf-0242ac11001f",
32          "version": 4
33        },
34        {
35          "id": "Test_workflow:3:2e6a0ee9-71d1-11ee-be64-0242ac11001f",
36          "version": 3
37        }
38      ]
39    }
40  ],
41  "limit": 1,
42  "version": 2
43}

Path Parameters

NameTypeRequiredDescription
workflowId
string
true

The ID of the workflow.

Query Parameters

NameTypeRequiredDescription
assignee
string
false

Filters on tasks worked on by this user.

containsTaskName
string
false

Filters for all task names that contain this value.

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.

includeCancelledTasks
boolean
false

Includes tasks whose processes were canceled.

Default:
false
includeUnclaimedTasks
boolean
false

Includes those tasks not currently assigned.

Default:
false
limit
integer<int32>
false

The number of items that were requested for the collection.

Default:
10
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.

taskDefinitionId
string
false

Filters on the specific task.

taskName
string
false

Filters on the task name.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
404Not FoundNo workflow exists at the requested path.Schema