Workflow Trigger Histories - Get

Reference

Service:: App Service

API Version:: 2023-12-01

Gets a workflow trigger history.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
historyName	path	True	string	The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.
name	path	True	string	Site name.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
triggerName	path	True	string	The workflow trigger name.
workflowName	path	True	string	The workflow name.
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	WorkflowTriggerHistory	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 workflow trigger history

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "properties": {
    "startTime": "2018-08-10T20:16:32.0387927Z",
    "endTime": "2018-08-10T20:16:32.2987996Z",
    "scheduledTime": "2018-08-10T20:16:31.6344174Z",
    "status": "Succeeded",
    "code": "OK",
    "correlation": {
      "clientTrackingId": "08586676746934337772206998657CU22"
    },
    "fired": true,
    "run": {
      "name": "08586676746934337772206998657CU22",
      "id": "/workflows/testWorkflowName/runs/08586676746934337772206998657CU22",
      "type": "/workflows/runs"
    }
  },
  "id": "/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22",
  "name": "08586676746934337772206998657CU22",
  "type": "/workflows/triggers/histories"
}

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
ResourceReference	The resource reference.
WorkflowStatus	The workflow status.
WorkflowTriggerHistory	The workflow trigger history.

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	ContentHash	The content hash.
contentSize	integer	The content size.
contentVersion	string	The content version.
metadata	Object	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	ErrorProperties	The error properties.

Object

ResourceReference

The resource reference.

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

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

WorkflowTriggerHistory

The workflow trigger history.

Name	Type	Description
id	string	The resource id.
name	string	Gets the workflow trigger history name.
properties.code	string	Gets the code.
properties.correlation	Correlation	The run correlation.
properties.endTime	string	Gets the end time.
properties.error	Object	Gets the error.
properties.fired	boolean	The value indicating whether trigger was fired.
properties.inputsLink	ContentLink	Gets the link to input parameters.
properties.outputsLink	ContentLink	Gets the link to output parameters.
properties.run	ResourceReference	Gets the reference to workflow run.
properties.scheduledTime	string	The scheduled time.
properties.startTime	string	Gets the start time.
properties.status	WorkflowStatus	Gets the status.
properties.trackingId	string	Gets the tracking id.
type	string	Gets the workflow trigger history type.

Share via