Method: projects.locations.products.integrations.schedule

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

HTTP request

POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/products/*/integrations/*}:schedule

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The integration resource name.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "triggerId": string,
  "scheduleTime": string,
  "requestId": string,
  "inputParameters": {
    string: {
      object (ValueType)
    },
    ...
  }
}
Fields
triggerId

string

Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(triggerId)
scheduleTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
requestId

string

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

map (key: string, value: object (ValueType))

Optional. Input parameters used by integration execution.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response body

If successful, the response body contains an instance of ScheduleIntegrationsResponse.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

  • integrations.apigeeIntegrations.invoke
  • integrations.integrations.invoke
  • integrations.securityIntegrations.invoke

For more information, see the IAM documentation.