Workflow Trigger Histories - List

Service:

Logic Apps

API Version:

2019-05-01

Gets a list of workflow trigger histories.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories?api-version=2019-05-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.
triggerName	path	True	string	The workflow trigger name.
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	WorkflowTriggerHistoryListResult	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 trigger history

Sample request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflowName/triggers/testTriggerName/histories?api-version=2019-05-01

Sample response

Status code:

200

{
  "value": [
    {
      "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": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflowName/runs/08586676746934337772206998657CU22",
          "type": "Microsoft.Logic/workflows/runs"
        }
      },
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22",
      "name": "08586676746934337772206998657CU22",
      "type": "Microsoft.Logic/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.
WorkflowTriggerHistoryListResult	The list of workflow trigger histories.

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

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.

WorkflowStatus

Enumeration

The workflow status.

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

WorkflowTriggerHistory

Object

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 (date-time)	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 (date-time)	The scheduled time.
properties.startTime	string (date-time)	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.

WorkflowTriggerHistoryListResult

Object

The list of workflow trigger histories.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	WorkflowTriggerHistory[]	A list of workflow trigger histories.