Workflow Run Actions - List

Gets a list of workflow run actions.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions?api-version=2023-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions?api-version=2023-12-01&$top={$top}&$filter={$filter}

URI Parameters

Name In Required Type Description
name
path True

string

Site name.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

runName
path True

string

The workflow run name.

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

workflowName
path True

string

The workflow name.

api-version
query True

string

API Version

$filter
query

string

The filter to apply on the operation. Options for filters include: Status.

$top
query

integer

int32

The number of items to be included in the result.

Responses

Name Type Description
200 OK

WorkflowRunActionListResult

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

List a workflow run actions

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/actions?api-version=2023-12-01

Sample Response

{
  "value": [
    {
      "properties": {
        "inputsLink": {
          "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionInputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dJ6F00000aaaabbbbccccddddeeeeffff78co",
          "contentSize": 138
        },
        "outputsLink": {
          "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionOutputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=fIIgF00000aaaabbbbccccddddeeeeffffWRU0",
          "contentSize": 15660
        },
        "startTime": "2018-08-10T20:16:32.305236Z",
        "endTime": "2018-08-10T20:16:32.5450625Z",
        "correlation": {
          "actionTrackingId": "56063357-45dd-4278-9be5-8220ce0cc9ca",
          "clientTrackingId": "08586676746934337772206998657CU22"
        },
        "status": "Succeeded",
        "code": "OK"
      },
      "id": "/workflows/test-workflow/runs/08586676746934337772206998657CU22/actions/HTTP",
      "name": "HTTP",
      "type": "/workflows/runs/actions"
    }
  ]
}

Definitions

Name Description
ContentHash

The content hash.

ContentLink

The content link.

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
RetryHistory

The retry history.

RunActionCorrelation

The workflow run action correlation properties.

WorkflowRunAction

The workflow run action.

WorkflowRunActionListResult

The list of workflow run actions.

WorkflowStatus

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.

The content link.

Name Type Description
contentHash

ContentHash

The content hash.

contentSize

integer

The content size.

contentVersion

string

The content version.

metadata

Object

The metadata.

uri

string

The content link URI.

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

ErrorProperties

The error properties.

Object

RetryHistory

The retry history.

Name Type Description
clientRequestId

string

Gets the client request Id.

code

string

Gets the status code.

endTime

string

Gets the end time.

error

ErrorResponse

Gets the error response.

serviceRequestId

string

Gets the service request Id.

startTime

string

Gets the start time.

RunActionCorrelation

The workflow run action correlation properties.

Name Type Description
actionTrackingId

string

The action tracking identifier.

clientKeywords

string[]

The client keywords.

clientTrackingId

string

The client tracking identifier.

WorkflowRunAction

The workflow run action.

Name Type Description
id

string

The resource id.

name

string

Gets the workflow run action name.

properties.code

string

Gets the code.

properties.correlation

RunActionCorrelation

The correlation properties.

properties.endTime

string

Gets the end time.

properties.error

Object

Gets the error.

properties.inputsLink

ContentLink

Gets the link to inputs.

properties.outputsLink

ContentLink

Gets the link to outputs.

properties.retryHistory

RetryHistory[]

Gets the retry histories.

properties.startTime

string

Gets the start time.

properties.status

WorkflowStatus

Gets the status.

properties.trackedProperties

Object

Gets the tracked properties.

properties.trackingId

string

Gets the tracking id.

type

string

Gets the workflow run action type.

WorkflowRunActionListResult

The list of workflow run actions.

Name Type Description
nextLink

string

The URL to get the next set of results.

value

WorkflowRunAction[]

A list of workflow run actions.

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