Workflow Runs - Get
Gets a workflow run.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}?api-version=2023-12-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Site name. |
resource
|
path | True |
string |
Name of the resource group to which the resource belongs. Regex pattern: |
run
|
path | True |
string |
The workflow run name. |
subscription
|
path | True |
string |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
workflow
|
path | True |
string |
The workflow name. |
api-version
|
query | True |
string |
API Version |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/test-workflow/runs/08586676746934337772206998657CU22?api-version=2023-12-01
Sample Response
{
"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": "/workflows/test-workflow/versions/08586676754160363885",
"name": "08586676754160363885",
"type": "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": "/workflows/test-workflow/runs/08586676746934337772206998657CU22",
"name": "08586676746934337772206998657CU22",
"type": "workflows/runs"
}
Definitions
Name | Description |
---|---|
Content |
The content hash. |
Content |
The content link. |
Correlation |
The correlation property. |
Error |
Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message. |
Error |
Error response indicates Logic service is not able to process the incoming request. The error property contains the error details. |
Object | |
Parameter |
The parameter type. |
Resource |
The resource reference. |
Workflow |
The workflow output parameter. |
Workflow |
The workflow run. |
Workflow |
The workflow run trigger. |
Workflow |
The workflow status. |
ContentHash
The content hash.
Name | Type | Description |
---|---|---|
algorithm |
string |
The algorithm of the content hash. |
value |
string |
The value of the content hash. |
ContentLink
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. |
ErrorProperties
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
Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
Name | Type | Description |
---|---|---|
error |
The error properties. |
Object
ParameterType
The parameter type.
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 |
<string,
Workflow |
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. |
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
The workflow status.
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 |