List executions in Dynatrace with the Automation API, using filters such as workflow, state, trigger, user, and time range.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/automation/v1/executions |
You can filter the execution list with parameters such as workflow, state, trigger, user, parentExecution, parentWorkflow, schedule, startedAtgte, startedAtlte, and search, plus paging and ordering options. Dynatrace returns executions from the Automation API, excluding draft and simple workflow executions.
To execute this request, you need a platform token or OAuth access token with automation:workflows:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin | query | Optional |
| limit | integer | Number of results to return per page. | query | Optional |
| offset | integer | The initial index from which to return the results. | query | Optional |
| ordering | string | Which field to use when ordering the results. | query | Optional |
| parentExecution | string | - | query | Optional |
| parentWorkflow | string | - | query | Optional |
| schedule | string[] | Multiple values may be separated by commas. | query | Optional |
| search | string | A search term. | query | Optional |
| startedAt__gte | string | - | query | Optional |
| startedAt__lte | string | - | query | Optional |
| state | string[] | Multiple values may be separated by commas. | query | Optional |
| subworkflowOfTask | string | Filter executions by | query | Optional |
| trigger | string | - | query | Optional |
| triggerType | string | - | query | Optional |
| user | string[] | Multiple values may be separated by commas. | query | Optional |
| workflow | string[] | Multiple values may be separated by commas. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Paginated | - |
| 4XX | Error | - |
PaginatedExecutionList object| Element | Type | Description |
|---|---|---|
| count | integer | - |
| results | Execution[] | - |
Execution object| Element | Type | Description |
|---|---|---|
| id | string | - |
| workflow | string | Executed Workflow |
| state | Execution | -The element can hold these values
|
| stateInfo | string | - |
| input | object | - |
| providedInput | object | - |
| params | object | - |
| startedAt | string | - |
| endedAt | string | - |
| runtime | integer | Calculate the runtime of an execution in seconds. If the execution is not ended, runtime is calculated until now. |
| trigger | string | - |
| schedule | string | - |
| eventTrigger | string | - |
| user | string | - |
| actor | string | - |
| title | string | - |
| result | - | - |
| triggerType | Trigger | - |
| workflowVersion | integer | - |
| workflowType | Workflow | - |
| triggerTypeDetail | Trigger | - |
| parentExecution | string | - |
| parentTaskName | string | Parent task execution's name (subworkflows only) |
| rootExecution | string | - |
| rootWorkflow | string | - |
| isDraft | boolean | - |
ExecutionState objectTriggerType objectWorkflowType objectRepresents a Workflow type.
TriggerTypeDetail objectTriggerSubTypeDetail object| Element | Type | Description |
|---|---|---|
| subType | Trigger | - |
TriggerWorkflowDetail object| Element | Type | Description |
|---|---|---|
| workflowTitle | string | - |
| isTaskTest | boolean | - |
TriggerManualDetail object| Element | Type | Description |
|---|---|---|
| userId | string | - |
TriggerSubType objectErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| message | string | - |
| code | integer | - |
| details | Error | - |
ErrorDetails object| Element | Type | Description |
|---|---|---|
| errorCode | string | - |
| errorRef | string | - |
{"count": 123,"results": [{"id": "string","workflow": "string","state": "CANCELLED","stateInfo": "string","input": {},"providedInput": {},"params": {},"startedAt": "string","endedAt": "string","runtime": 1,"trigger": "string","schedule": "string","eventTrigger": "string","user": "string","actor": "string","title": "string","result": {},"triggerType": "Manual","workflowVersion": 1,"workflowType": "STANDARD","triggerTypeDetail": {"subType": "CUSTOM"},"parentExecution": "string","parentTaskName": "string","rootExecution": "string","rootWorkflow": "string","isDraft": true}]}
{"error": {"message": "string","code": 1,"details": {"errorCode": "string","errorRef": "string"}}}