swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector WorkflowTriggers API schemes: - https tags: - name: WorkflowTriggers paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersList description: Gets a list of workflow triggers. x-ms-examples: List workflow triggers: $ref: ./examples/WorkflowTriggers_List.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - $ref: '#/parameters/api-version' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 - name: $filter description: The filter to apply on the operation. in: query required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerListResult' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/WorkflowTriggerFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName} : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersGet description: Gets a workflow trigger. x-ms-examples: Get a workflow trigger: $ref: ./examples/WorkflowTriggers_Get.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTrigger' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers Triggername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/reset : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersReset description: Resets a workflow trigger. x-ms-examples: Reset trigger: $ref: ./examples/WorkflowTriggers_Reset.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: OK summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers Triggername Reset ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersRun description: Runs a workflow trigger. x-ms-examples: Run a workflow trigger: $ref: ./examples/WorkflowTriggers_Run.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/api-version' responses: default: description: All status codes are acceptable. schema: $ref: '#/definitions/Object' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers Triggername Run ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/schemas/json : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersGetschemajson description: Get the trigger schema as JSON. x-ms-examples: Get trigger schema: $ref: ./examples/WorkflowTriggers_GetSchemaJson.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/JsonSchema' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers Triggername Schemas Json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/setState : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersSetstate description: Sets the state of a workflow trigger. x-ms-examples: Set trigger state: $ref: ./examples/WorkflowTriggers_SetState.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - name: setState description: The workflow trigger state. in: body required: true schema: $ref: '#/definitions/SetTriggerStateActionDefinition' - $ref: '#/parameters/api-version' responses: '200': description: OK summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers Triggername Setstate ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersListcallbackurl description: Get the callback URL for a workflow trigger. x-ms-examples: Get the callback URL for a trigger: $ref: ./examples/WorkflowTriggers_ListCallbackUrl.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerCallbackUrl' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Triggers Triggername Listcallbackurl ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowversiontriggersListcallbackurl description: Get the callback url for a trigger of a workflow version. x-ms-examples: Get the callback url for a trigger of a workflow version: $ref: ./examples/WorkflowVersionTriggers_ListCallbackUrl.json parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName description: The resource group name. in: path required: true type: string - name: workflowName description: The workflow name. in: path required: true type: string - name: versionId description: The workflow versionId. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - name: parameters description: The callback URL parameters. in: body required: false schema: $ref: '#/definitions/GetCallbackUrlParameters' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerCallbackUrl' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Versions Versionid Triggers Triggername Listcallbackurl ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersList description: Gets a list of workflow triggers. x-ms-examples: List workflow triggers: $ref: ./examples/WorkflowTriggers_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 - name: $filter description: The filter to apply on the operation. in: query required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/WorkflowTriggerFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName} : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersGet description: Gets a workflow trigger. x-ms-examples: Get a workflow trigger: $ref: ./examples/WorkflowTriggers_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTrigger' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersListcallbackurl description: Get the callback URL for a workflow trigger. x-ms-examples: Get the callback URL for a trigger: $ref: ./examples/WorkflowTriggers_ListCallbackUrl.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerCallbackUrl' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Listcallbackurl ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/run : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersRun description: Runs a workflow trigger. x-ms-examples: Run a workflow trigger: $ref: ./examples/WorkflowTriggers_Run.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the trigger run failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Run ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersGetschemajson description: Get the trigger schema as JSON. x-ms-examples: Get trigger schema: $ref: ./examples/WorkflowTriggers_GetSchemaJson.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/JsonSchema' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Schemas Json definitions: WorkflowTriggerRecurrence: type: object properties: frequency: $ref: '#/definitions/RecurrenceFrequency' description: The frequency. interval: type: integer format: int32 description: The interval. startTime: type: string description: The start time. endTime: type: string description: The end time. timeZone: type: string description: The time zone. schedule: $ref: '#/definitions/RecurrenceSchedule' description: The recurrence schedule. description: The workflow trigger recurrence. WorkflowStatus: type: string enum: - NotSpecified - Paused - Running - Waiting - Succeeded - Skipped - Suspended - Cancelled - Failed - Faulted - TimedOut - Aborted - Ignored x-ms-enum: name: WorkflowStatus modelAsString: true JsonSchema: type: object description: The JSON schema. properties: title: type: string description: The JSON title. content: type: string description: The JSON content. GetCallbackUrlParameters: type: object properties: notAfter: type: string format: date-time description: The expiry time. keyType: $ref: '#/definitions/KeyType' description: The key type. description: The callback url parameters. WorkflowTrigger: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowTriggerProperties' description: The workflow trigger properties. name: type: string readOnly: true description: Gets the workflow trigger name. type: type: string readOnly: true description: Gets the workflow trigger type. description: The workflow trigger. allOf: - $ref: '#/definitions/SubResource' WorkflowTriggerProvisioningState: type: string enum: - NotSpecified - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Moving - Updating - Registering - Registered - Unregistering - Unregistered - Completed x-ms-enum: name: WorkflowTriggerProvisioningState modelAsString: true WorkflowTriggerCallbackUrl: type: object properties: value: type: string readOnly: true description: Gets the workflow trigger callback URL. method: type: string readOnly: true description: Gets the workflow trigger callback URL HTTP method. basePath: type: string readOnly: true description: Gets the workflow trigger callback URL base path. relativePath: type: string readOnly: true description: Gets the workflow trigger callback URL relative path. relativePathParameters: type: array items: type: string description: Gets the workflow trigger callback URL relative path parameters. queries: $ref: '#/definitions/WorkflowTriggerListCallbackUrlQueries' description: Gets the workflow trigger callback URL query parameters. description: The workflow trigger callback URL. RecurrenceSchedule: type: object properties: minutes: type: array items: type: integer format: int32 description: The minutes. hours: type: array items: type: integer format: int32 description: The hours. weekDays: type: array items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday x-ms-enum: name: DaysOfWeek modelAsString: false description: The days of the week. monthDays: type: array items: type: integer format: int32 description: The month days. monthlyOccurrences: type: array items: $ref: '#/definitions/RecurrenceScheduleOccurrence' description: The monthly occurrences. description: The recurrence schedule. WorkflowTriggerListResult: type: object properties: value: type: array items: $ref: '#/definitions/WorkflowTrigger' description: A list of workflow triggers. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow triggers. DayOfWeek: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday x-ms-enum: name: DayOfWeek modelAsString: false RecurrenceScheduleOccurrence: type: object properties: day: $ref: '#/definitions/DayOfWeek' description: The day of the week. occurrence: type: integer format: int32 description: The occurrence. description: The recurrence schedule occurrence. WorkflowTriggerProperties: type: object properties: provisioningState: $ref: '#/definitions/WorkflowTriggerProvisioningState' readOnly: true description: Gets the provisioning state. createdTime: type: string format: date-time readOnly: true description: Gets the created time. changedTime: type: string format: date-time readOnly: true description: Gets the changed time. state: $ref: '#/definitions/WorkflowState' readOnly: true description: Gets the state. status: $ref: '#/definitions/WorkflowStatus' readOnly: true description: Gets the status. lastExecutionTime: type: string format: date-time readOnly: true description: Gets the last execution time. nextExecutionTime: type: string format: date-time readOnly: true description: Gets the next execution time. recurrence: $ref: '#/definitions/WorkflowTriggerRecurrence' readOnly: true description: Gets the workflow trigger recurrence. workflow: $ref: '#/definitions/ResourceReference' readOnly: true description: Gets the reference to workflow. description: The workflow trigger properties. SubResource: properties: id: type: string readOnly: true description: The resource id. x-ms-azure-resource: true description: The sub resource type. WorkflowState: type: string enum: - NotSpecified - Completed - Enabled - Disabled - Deleted - Suspended x-ms-enum: name: WorkflowState modelAsString: true RecurrenceFrequency: type: string enum: - NotSpecified - Second - Minute - Hour - Day - Week - Month - Year x-ms-enum: name: RecurrenceFrequency modelAsString: true ErrorProperties: description: Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message. type: object properties: code: description: Error code. type: string message: description: Error message indicating why the operation failed. type: string ResourceReference: type: object properties: id: type: string description: The resource id. name: type: string readOnly: true description: Gets the resource name. type: type: string readOnly: true description: Gets the resource type. description: The resource reference. WorkflowTriggerListCallbackUrlQueries: type: object properties: api-version: type: string description: The api version. sp: type: string description: The SAS permissions. sv: type: string description: The SAS version. sig: type: string description: The SAS signature. se: type: string description: The SAS timestamp. description: Gets the workflow trigger callback URL query parameters. ErrorResponse: description: Error response indicates Logic service is not able to process the incoming request. The error property contains the error details. type: object properties: error: $ref: '#/definitions/ErrorProperties' description: The error properties. SetTriggerStateActionDefinition: type: object additionalProperties: false required: - source properties: source: $ref: '#/definitions/WorkflowTrigger' KeyType: type: string enum: - NotSpecified - Primary - Secondary x-ms-enum: name: KeyType modelAsString: true Object: type: object properties: {} parameters: resourceGroupNameParameter: name: resourceGroupName in: path description: Name of the resource group to which the resource belongs. required: true type: string maxLength: 90 minLength: 1 pattern: ^[-\w\._\(\)]+[^\.]$ x-ms-parameter-location: method api-version: name: api-version description: The API version. in: query required: true type: string subscriptionId: name: subscriptionId description: The subscription id. in: path required: true type: string apiVersionParameter: name: api-version in: query description: API Version required: true type: string x-ms-parameter-location: client subscriptionIdParameter: name: subscriptionId in: path description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). required: true type: string x-ms-parameter-location: client siteNameParameter: name: name in: path description: Site name. required: true type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'