Workflow Trigger Histories - List

Service:

Logic Apps

API Version:

2016-06-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=2016-06-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories?api-version=2016-06-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

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=2016-06-01

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "startTime": "2018-08-10T20:16:32.0387927Z",
        "endTime": "2018-08-10T20:16:32.2987996Z",
        "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.
Object
ResourceReference	The resource reference.
WorkflowStatus
WorkflowTriggerHistory	The workflow trigger history.
WorkflowTriggerHistoryListResult	The list of workflow trigger histories.

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.

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

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	Gets a 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.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.

WorkflowTriggerHistoryListResult

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.