Workflow Executions API
Execute workflows created with Workflows API.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Execute workflows created with Workflows API.
Endpoints 9
projects.locations.workflows
- POSTTriggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification.
/v1/:workflow:triggerPubsubExecutionTriggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification.
projects.locations.workflows.executions
- POSTCancels an execution of the given name.
/v1/:name:cancelCancels an execution of the given name. - GETReturns a list of executions which belong to the workflow with the given name
/v1/:parent/executions?filter=string&orderBy=string&pageSize=0&pageToken=string&view=EXECUTION_VIEW_UNSPECIFIEDReturns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions… - POSTCreates a new execution using the latest revision of the given workflow
/v1/:parent/executionsCreates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow. - POSTDeletes all step entries for an execution.
/v1/:name:deleteExecutionHistoryDeletes all step entries for an execution. - GETReturns all metadata stored about an execution, excluding most data that is already accessible using other API methods.
/v1/:name:exportDataReturns all metadata stored about an execution, excluding most data that is already accessible using other API methods.
projects.locations.workflows.executions.stepEntries
- GETGets a step entry.
/v1/:name?view=EXECUTION_ENTRY_VIEW_UNSPECIFIEDGets a step entry. - GETLists step entries for the corresponding workflow execution
/v1/:parent/stepEntries?filter=string&orderBy=string&pageSize=0&pageToken=string&skip=0&view=EXECUTION_ENTRY_VIEW_UNSPECIFIEDLists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.
projects.locations.workflows.executions.callbacks
- GETReturns a list of active callbacks that belong to the execution with the given name
/v1/:parent/callbacks?pageSize=0&pageToken=stringReturns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.
API details
- Base URL
https://workflowexecutions.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 9 operations on 8 pathsGET 5POST 4
- Main resources
- projects.locations.workflows.executions 5projects.locations.workflows.executions.stepEntries 2projects.locations.workflows 1projects.locations.workflows.executions.callbacks 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Workflow Executions API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Workflow Executions API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification.” (POST /v1/:workflow:triggerPubsubExecution), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Workflow Executions API?
Execute workflows created with Workflows API. It is listed under Developer tools and has 9 endpoints.
Who publishes the Workflow Executions API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Workflow Executions API?
Requests go to https://workflowexecutions.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Workflow Executions API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Workflow Executions API have?
9 operations on 8 paths (5 GET, 4 POST). The largest groups are projects.locations.workflows.executions, projects.locations.workflows.executions.stepEntries, projects.locations.workflows, projects.locations.workflows.executions.callbacks.
Is forking the Workflow Executions API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.