Application Integration API (integrations:v2)

Additions

Methods


• ▼ ▲ integrations.projects.locations.integrations.schedule

  HTTP Method : POST

  Path : v2/{+parent}:schedule

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

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule

  Description : Schedules an integration for execution.

  Parameter Order : parent

  Parameters :

  triggerId

  Type : string

  Location : query

  Description : Required. The API trigger id associated with the integration. An integration can have multiple trigger_id. This field is required to disambiguate which trigger should be invoked

  requestId

  Type : string

  Location : query

  Description : Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.

  parent

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  Location : path

  Type : string

  Description : Required. The integration resource name.

  scheduleTime

  Location : query

  Format : google-datetime

  Description : Optional. The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.

  Type : string

• ▼ ▲ integrations.projects.locations.integrations.generateIntegrationDocument

  Description : Generates documentation for an integration version.

  Path : v2/{+parent}:generateIntegrationDocument

  Parameter Order : parent

  Parameters :

  parent

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  Required : Yes

  Description : Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`

  HTTP Method : POST

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:generateIntegrationDocument

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

• ▼ ▲ integrations.projects.locations.integrations.generateIntegrationBranch

  Parameter Order : parent

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:generateIntegrationBranch

  Parameters :

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  Required : Yes

  Type : string

  Description : Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`

  Location : path

  Path : v2/{+parent}:generateIntegrationBranch

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

  HTTP Method : POST

  Description : Generates an integration branch.

• ▼ ▲ integrations.projects.locations.integrations.recommendTasks

  Parameter Order : parent

  Description : Recommends tasks to replace a selected task.

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

  HTTP Method : POST

  Path : v2/{+parent}:recommendTasks

  Parameters :

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  Description : Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`

  Required : Yes

  Type : string

  Location : path

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:recommendTasks

• ▼ ▲ integrations.projects.locations.integrations.generateJavascript

  Parameter Order : parent

  Parameters :

  parent

  Location : path

  Description : Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  Type : string

  Path : v2/{+parent}:generateJavascript

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

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:generateJavascript

  Description : Generates Javascript code for data mapping.

  HTTP Method : POST

• ▼ ▲ integrations.projects.locations.integrations.execute

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

  Parameters :

  parent

  Location : path

  Required : Yes

  Description : Required. The integration resource name.

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  triggerId

  Location : query

  Description : Required. The API trigger id associated with the integration. An integration can have multiple trigger_id. This field is required to disambiguate which trigger should be invoked.

  Type : string

  requestId

  Type : string

  Location : query

  Description : Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.

  Description : Executes integrations synchronously. The response is not returned until the requested execution is either fulfilled or experienced an error. Only one integration can be executed. Request format URL: https://integrations.googleapis.com/v2/projects/$PROJECT/locations/$LOCATION/integrations/$INTEGRATION_NAME:execute Request payload: (the entire payload is optional unless input variables need to be set.) {"variable1": "hello world", "variable2": 1, "variable3": {"my_json_key": "my json string value" }

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute

  HTTP Method : POST

  Parameter Order : parent

  Path : v2/{+parent}:execute

• ▼ ▲ integrations.projects.locations.integrations.executions.troubleshoot

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:troubleshoot

  HTTP Method : GET

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

  Parameters :

  name

  Location : path

  Type : string

  Description : Required. Execution resource name. Format: `projects/{project}/locations/{location}/integrations/{integration}/executions/{execution_id}`

  Required : Yes

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

  Description : View detailed explanation of why an integration execution failed, using LLM

  Path : v2/{+name}:troubleshoot

  Parameter Order : name

• ▼ ▲ integrations.projects.locations.integrations.executions.list

  HTTP Method : GET

  Path : v2/{+parent}/executions

  Description : Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

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

  Parameter Order : parent

  Parameters :

  filter

  Location : query

  Type : string

  Description : Optional. Standard filter field, we support filtering on following fields: integration_name: the name of the integration. create_time: the execution created time. update_time: the execution last update time. state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. All fields support for EQUALS, in additional: create_time and update_time support for LESS_THAN, GREATER_THAN Also supports operators like AND, OR, NOT For example: trigger_id=\"id1\" AND integration_name=\"testIntegration\"

  readMask

  Location : query

  Format : google-fieldmask

  Description : Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in execution info will be filled and returned.

  Type : string

  pageToken

  Type : string

  Location : query

  Description : Optional. The token returned in the previous response.

  parent

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$

  Type : string

  Location : path

  Description : Required. parent resource name of integration execution.

  pageSize

  Description : Optional. The size of entries in the response.

  Location : query

  Type : integer

  Format : int32

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions

• ▼ ▲ integrations.projects.locations.integrations.executions.taskExecutions.get

  Path : v2/{+name}

  HTTP Method : GET

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/taskExecutions/{taskExecutionsId}

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

  Description : Get a TaskExecution in the specified project.

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/taskExecutions/[^/]+$

  Location : path

  Type : string

  Description : Required. The TaskExecution to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/executions/{execution}/taskExecutions/{task_execution}

  Required : Yes

  Parameter Order : name

• ▼ ▲ integrations.projects.locations.generateIntegration

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

  Path : v2/{+parent}:generateIntegration

  Description : Generates an integration skeleton based on a natural language prompt.

  Parameters :

  parent

  Required : Yes

  Description : Required. The location in which the integration will be generated. Format: `projects/{project}/locations/{location}`

  Type : string

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

  Location : path

  HTTP Method : POST

  Parameter Order : parent

  Flat Path : v2/projects/{projectsId}/locations/{locationsId}:generateIntegration