Workflow Runs - List

Gets a list of workflow runs.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs?api-version=2016-06-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs?api-version=2016-06-01&$top={$top}&$filter={$filter}

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The resource group name.

subscriptionId
path True
  • string

The subscription id.

workflowName
path True
  • string

The workflow name.

api-version
query True
  • string

The API version.

$filter
query
  • string

The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.

$top
query
  • integer
int32

The number of items to be included in the result.

Responses

Name Type Description
200 OK

OK

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List workflow runs

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs?api-version=2016-06-01

Sample Response

{
  "value": [
    {
      "properties": {
        "waitEndTime": "2018-08-10T20:16:32.044238Z",
        "startTime": "2018-08-10T20:16:32.044238Z",
        "endTime": "2018-08-10T20:16:32.5779999Z",
        "status": "Succeeded",
        "correlation": {
          "clientTrackingId": "08586676746934337772206998657CU22"
        },
        "workflow": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/versions/08586676754160363885",
          "name": "08586676754160363885",
          "type": "Microsoft.Logic/workflows/versions"
        },
        "trigger": {
          "name": "Recurrence",
          "startTime": "2018-08-10T20:16:32.0387927Z",
          "endTime": "2018-08-10T20:16:32.0387927Z",
          "scheduledTime": "2018-08-10T20:16:31.6344174Z",
          "correlation": {
            "clientTrackingId": "08586676746934337772206998657CU22"
          },
          "code": "OK",
          "status": "Succeeded"
        },
        "outputs": {}
      },
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586676746934337772206998657CU22",
      "name": "08586676746934337772206998657CU22",
      "type": "Microsoft.Logic/workflows/runs"
    }
  ]
}

Definitions

ContentHash

The content hash.

ContentLink

The content link.

Correlation

The correlation property.

Object
ParameterType
ResourceReference

The resource reference.

WorkflowOutputParameter

The workflow output parameter.

WorkflowRun

The workflow run.

WorkflowRunListResult

The list of workflow runs.

WorkflowRunTrigger

The workflow run trigger.

WorkflowStatus

ContentHash

The content hash.

Name Type Description
algorithm
  • string

The algorithm of the content hash.

value
  • string

The value of the content hash.

The content link.

Name Type Description
contentHash

The content hash.

contentSize
  • integer

The content size.

contentVersion
  • string

The content version.

metadata

The metadata.

uri
  • string

The content link URI.

Correlation

The correlation property.

Name Type Description
clientTrackingId
  • string

The client tracking id.

Object

ParameterType

Name Type Description
Array
  • string
Bool
  • string
Float
  • string
Int
  • string
NotSpecified
  • string
Object
  • string
SecureObject
  • string
SecureString
  • string
String
  • string

ResourceReference

The resource reference.

Name Type Description
id
  • string

The resource id.

name
  • string

Gets the resource name.

type
  • string

Gets the resource type.

WorkflowOutputParameter

The workflow output parameter.

Name Type Description
description
  • string

The description.

error

Gets the error.

metadata

The metadata.

type

The type.

value

The value.

WorkflowRun

The workflow run.

Name Type Description
id
  • string

The resource id.

name
  • string

Gets the workflow run name.

properties.code
  • string

Gets the code.

properties.correlation

The run correlation.

properties.correlationId
  • string

Gets the correlation id.

properties.endTime
  • string

Gets the end time.

properties.error

Gets the error.

properties.outputs

Gets the outputs.

properties.response

Gets the response of the flow run.

properties.startTime
  • string

Gets the start time.

properties.status

Gets the status.

properties.trigger

Gets the fired trigger.

properties.waitEndTime
  • string

Gets the wait end time.

properties.workflow

Gets the reference to workflow version.

type
  • string

Gets the workflow run type.

WorkflowRunListResult

The list of workflow runs.

Name Type Description
nextLink
  • string

The URL to get the next set of results.

value

A list of workflow runs.

WorkflowRunTrigger

The workflow run trigger.

Name Type Description
code
  • string

Gets the code.

correlation

The run correlation.

endTime
  • string

Gets the end time.

error

Gets the error.

inputs

Gets the inputs.

inputsLink

Gets the link to inputs.

name
  • string

Gets the name.

outputs

Gets the outputs.

outputsLink

Gets the link to outputs.

scheduledTime
  • string

Gets the scheduled time.

startTime
  • string

Gets the start time.

status

Gets the status.

trackedProperties

Gets the tracked properties.

trackingId
  • string

Gets the tracking id.

WorkflowStatus

Name Type Description
Aborted
  • string
Cancelled
  • string
Failed
  • string
Faulted
  • string
Ignored
  • string
NotSpecified
  • string
Paused
  • string
Running
  • string
Skipped
  • string
Succeeded
  • string
Suspended
  • string
TimedOut
  • string
Waiting
  • string