Workflow Executions API (workflowexecutions:v1)

2023-09-08

2 new methods

Additions

    Methods
  • workflowexecutions.projects.locations.workflows.executions.callbacks.list

      HTTP Method : GET

      Parameters :

        pageSize

          Type : integer

          Format : int32

          Location : query

          Description : Maximum number of callbacks to return per call. The default value is 100 and is also the maximum value.

        pageToken

          Type : string

          Location : query

          Description : A page token, received from a previous `ListCallbacks` call. Provide this to retrieve the subsequent page. Note that pagination is applied to dynamic data. The list of callbacks returned can change between page requests if callbacks are created or deleted.

        parent

          Location : path

          Description : Required. Name of the execution for which the callbacks should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$

      Path : v1/{+parent}/callbacks

      Parameter Order : parent

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}/callbacks

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Returns a list of active callbacks which belong to the execution with the given name. The returned callbacks are ordered by callback ID. first).

  • workflowexecutions.projects.locations.workflows.executions.exportData

      HTTP Method : GET

      Description : Returns all metadata stored about an execution, excluding most data that is already accessible via other API methods.

      Parameter Order : name

      Path : v1/{+name}:exportData

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:exportData

      Parameters :

        name

          Description : Required. Name of the execution to be data exported. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

          Pattern : ^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$

          Type : string

          Location : path

          Required : Yes

      Scopes : https://www.googleapis.com/auth/cloud-platform