Workflow Runs - Get

Service:

Logic Apps

API Version:

2019-05-01

Gets a workflow run.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}?api-version=2019-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The resource group name.
runName	path	True	string	The workflow run name.
subscriptionId	path	True	string	The subscription id.
workflowName	path	True	string	The workflow name.
api-version	query	True	string	The API version.

Responses

Name	Type	Description
200 OK	WorkflowRun	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

Get a run for a workflow

Sample request

HTTP

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

Sample response

Status code:

200

{
  "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

Name	Description
ContentHash	The content hash.
ContentLink	The content link.
Correlation	The correlation property.
ErrorProperties	Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
ErrorResponse	Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
Object
ParameterType	The parameter type.
ResourceReference	The resource reference.
WorkflowOutputParameter	The workflow output parameter.
WorkflowRun	The workflow run.
WorkflowRunTrigger	The workflow run trigger.
WorkflowStatus	The workflow status.

ContentHash

Object

The content hash.

Name	Type	Description
algorithm	string	The algorithm of the content hash.
value	string	The value of the content hash.

ContentLink

Object

The content link.

Name	Type	Description
contentHash	ContentHash	The content hash.
contentSize	integer (int64)	The content size.
contentVersion	string	The content version.
metadata	Object	The metadata.
uri	string	The content link URI.

Correlation

Object

The correlation property.

Name	Type	Description
clientTrackingId	string	The client tracking id.

ErrorProperties

Object

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Name	Type	Description
error	ErrorProperties	The error properties.

Object

Object

ParameterType

Enumeration

The parameter type.

Value	Description
NotSpecified
String
SecureString
Int
Float
Bool
Array
Object
SecureObject

ResourceReference

Object

The resource reference.

Name	Type	Description
id	string	The resource id.
name	string	Gets the resource name.
type	string	Gets the resource type.

WorkflowOutputParameter

Object

The workflow output parameter.

Name	Type	Description
description	string	The description.
error	Object	Gets the error.
metadata	Object	The metadata.
type	ParameterType	The type.
value	Object	The value.

WorkflowRun

Object

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	Correlation	The run correlation.
properties.correlationId	string	Gets the correlation id.
properties.endTime	string (date-time)	Gets the end time.
properties.error	Object	Gets the error.
properties.outputs	<string,  WorkflowOutputParameter>	Gets the outputs.
properties.response	WorkflowRunTrigger	Gets the response of the flow run.
properties.startTime	string (date-time)	Gets the start time.
properties.status	WorkflowStatus	Gets the status.
properties.trigger	WorkflowRunTrigger	Gets the fired trigger.
properties.waitEndTime	string (date-time)	Gets the wait end time.
properties.workflow	ResourceReference	Gets the reference to workflow version.
type	string	Gets the workflow run type.

WorkflowRunTrigger

Object

The workflow run trigger.

Name	Type	Description
code	string	Gets the code.
correlation	Correlation	The run correlation.
endTime	string (date-time)	Gets the end time.
error	Object	Gets the error.
inputs	Object	Gets the inputs.
inputsLink	ContentLink	Gets the link to inputs.
name	string	Gets the name.
outputs	Object	Gets the outputs.
outputsLink	ContentLink	Gets the link to outputs.
scheduledTime	string (date-time)	Gets the scheduled time.
startTime	string (date-time)	Gets the start time.
status	WorkflowStatus	Gets the status.
trackedProperties	Object	Gets the tracked properties.
trackingId	string	Gets the tracking id.

WorkflowStatus

Enumeration

The workflow status.

Value	Description
NotSpecified
Paused
Running
Waiting
Succeeded
Skipped
Suspended
Cancelled
Failed
Faulted
TimedOut
Aborted
Ignored