2026-04-30
▼ ▲ integrations.projects.getClientmetadata
Path : v1/{+parent}/clientmetadata
Flat Path : v1/projects/{projectsId}/clientmetadata
HTTP Method : GET
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the metadata info for the requested client
▼ ▲ integrations.projects.locations.getClients
Path : v1/{+parent}/clients
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients
HTTP Method : GET
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the client configuration for the given project and location resource name
▼ ▲ integrations.projects.locations.generateOpenApiSpec
Path : v1/{+name}:generateOpenApiSpec
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:generateOpenApiSpec
HTTP Method : POST
Parameters :
name
Description : Required. Project and location from which the integrations should be fetched. Format: projects/{project}/location/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Generate OpenAPI spec for the requested integrations and api triggers
▼ ▲ integrations.projects.locations.appsScriptProjects.link
Path : v1/{+parent}/appsScriptProjects:link
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link
HTTP Method : POST
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Links a existing Apps Script project.
▼ ▲ integrations.projects.locations.appsScriptProjects.create
Path : v1/{+parent}/appsScriptProjects
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects
HTTP Method : POST
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an Apps Script project.
▼ ▲ integrations.projects.locations.clients.provision
Path : v1/{+parent}/clients:provision
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:provision
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.
▼ ▲ integrations.projects.locations.clients.provisionClientPostProcessor
Path : v1/{+parent}/clients:provisionClientPostProcessor
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:provisionClientPostProcessor
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Perform post provisioning steps after client is provisioned.
▼ ▲ integrations.projects.locations.clients.deprovision
Path : v1/{+parent}/clients:deprovision
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be deprovisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.
▼ ▲ integrations.projects.locations.clients.changeConfig
Path : v1/{+parent}/clients:changeConfig
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:changeConfig
HTTP Method : POST
Parameters :
parent
Description : Required. Required: Format - projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the client customer configuration for the given project and location resource name
▼ ▲ integrations.projects.locations.clients.switch
Path : v1/{+parent}/clients:switch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:switch
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update client from GMEK to CMEK
▼ ▲ integrations.projects.locations.clients.replace
Path : v1/{+parent}/clients:replace
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:replace
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update run-as service account for provisioned client
▼ ▲ integrations.projects.locations.clients.switchVariableMasking
Path : v1/{+parent}/clients:switchVariableMasking
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update variable masking for provisioned client
▼ ▲ integrations.projects.locations.clients.toggleHttp
Path : v1/{+parent}/clients:toggleHttp
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clients:toggleHttp
HTTP Method : POST
Parameters :
parent
Description : Required. Required: The ID of the GCP Project to be provisioned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enable/Disable http call for provisioned client
▼ ▲ integrations.projects.locations.products.cloudFunctions.create
Path : v1/{+parent}/cloudFunctions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions
HTTP Method : POST
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a cloud function project.
▼ ▲ integrations.projects.locations.products.certificates.list
Path : v1/{+parent}/certificates
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of Certificates.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the Certificate's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
▼ ▲ integrations.projects.locations.products.certificates.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
HTTP Method : GET
Parameters :
name
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a certificates in the specified project.
▼ ▲ integrations.projects.locations.products.certificates.create
Path : v1/{+parent}/certificates
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
▼ ▲ integrations.projects.locations.products.certificates.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Auto generated primary key
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
▼ ▲ integrations.projects.locations.products.certificates.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the Certificate.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a certificate
▼ ▲ integrations.projects.locations.products.authConfigs.create
Path : v1/{+parent}/authConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
clientCertificate.sslCertificate
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.passphrase
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
▼ ▲ integrations.projects.locations.products.authConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
clientCertificate.sslCertificate
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.passphrase
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
▼ ▲ integrations.projects.locations.products.authConfigs.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an auth config.
▼ ▲ integrations.projects.locations.products.authConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
▼ ▲ integrations.projects.locations.products.authConfigs.list
Path : v1/{+parent}/authConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of AuthConfigs.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
▼ ▲ integrations.projects.locations.products.integrations.execute
Path : v1/{+name}:execute
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute
HTTP Method : POST
Parameters :
name
Description : Required. The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
▼ ▲ integrations.projects.locations.products.integrations.schedule
Path : v1/{+name}:schedule
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule
HTTP Method : POST
Parameters :
name
Description : The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
▼ ▲ integrations.projects.locations.products.integrations.test
Path : v1/{+name}:test
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test
HTTP Method : POST
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Execute the integration in draft state
▼ ▲ integrations.projects.locations.products.integrations.list
Path : v1/{+parent}/integrations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations
HTTP Method : GET
Parameters :
parent
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The page size for the resquest.
Location : query
Type : integer
Format : int32
pageToken
Description : The page token for the resquest.
Location : query
Type : string
orderBy
Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
Location : query
Type : string
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the list of all integrations in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region".
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Location : query
Type : string
orderBy
Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last\_modified\_time", "created\_time", and "snapshot\_number". Ascending sort order for `name`.
Location : query
Type : string
fieldMask
Description : The field mask which specifies the particular data to be returned.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the list of all integration versions in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.create
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
newIntegration
Description : Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
Location : query
Type : boolean
createSampleIntegrations
Description : Optional. Optional. Indicates if sample workflow should be created.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a integration with a draft version in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a integration with a draft version in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a integration in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.publish
Path : v1/{+name}:publish
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish
HTTP Method : POST
Parameters :
name
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
▼ ▲ integrations.projects.locations.products.integrations.versions.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
▼ ▲ integrations.projects.locations.products.integrations.versions.upload
Path : v1/{+parent}/versions:upload
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload
HTTP Method : POST
Parameters :
parent
Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
▼ ▲ integrations.projects.locations.products.integrations.versions.download
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download
HTTP Method : GET
Parameters :
name
Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
fileFormat
Description : File format for download request.
Location : query
Type : string
Enum Descriptions :
Enum :
files
Description : Optional. Integration related file to download like Integration Json, Config variable, testcase etc.
Location : query
Repeated : Yes
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
▼ ▲ integrations.projects.locations.products.integrations.versions.takeoverEditLock
Path : v1/{+integrationVersion}:takeoverEditLock
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
HTTP Method : POST
Parameters :
integrationVersion
Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : integrationVersion
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
▼ ▲ integrations.projects.locations.products.integrations.versions.unpublish
Path : v1/{+name}:unpublish
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish
HTTP Method : POST
Parameters :
name
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
▼ ▲ integrations.projects.locations.products.integrations.executions.list
Path : v1/{+parent}/executions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name of the integration execution.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"
Location : query
Type : string
pageSize
Description : Optional. The size of entries in the response.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The token returned in the previous response.
Location : query
Type : string
orderBy
Description : Optional. The results would be returned in order you specified here. Currently supporting "create_time".
Location : query
Type : string
readMask
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 will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info
Location : query
Type : string
Format : google-fieldmask
filterParams.workflowName
Description : Workflow name.
Location : query
Type : string
filterParams.startTime
Description : Start timestamp.
Location : query
Type : string
Format : int64
filterParams.endTime
Description : End timestamp.
Location : query
Type : string
Format : int64
filterParams.eventStatuses
Description : List of possible event statuses.
Location : query
Repeated : Yes
Type : string
filterParams.taskStatuses
Description : List of possible task statuses.
Location : query
Deprecated : Yes
Repeated : Yes
Type : string
filterParams.customFilter
Description : Optional user-provided custom filter.
Location : query
Type : string
filterParams.executionId
Description : Execution id.
Location : query
Type : string
filterParams.parameterValue
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Location : query
Deprecated : Yes
Type : string
filterParams.parameterType
Description : Param type.
Location : query
Type : string
filterParams.parameterKey
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Location : query
Deprecated : Yes
Type : string
filterParams.parameterPairKey
Description : Param key in the key value pair filter.
Location : query
Type : string
filterParams.parameterPairValue
Description : Param value in the key value pair filter.
Location : query
Type : string
refreshAcl
Description : Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
Location : query
Type : boolean
truncateParams
Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
Location : query
Deprecated : Yes
Type : boolean
snapshotMetadataWithoutParams
Description : Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ integrations.projects.locations.products.integrations.executions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an execution in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.executions.download
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download
HTTP Method : GET
Parameters :
name
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Download the execution.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.resolve
Path : v1/{+name}:resolve
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
HTTP Method : POST
Parameters :
name
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.list
Path : v1/{+parent}/suspensions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
HTTP Method : GET
Parameters :
parent
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of entries in the response.
Location : query
Type : integer
Format : int32
pageToken
Description : Token to retrieve a specific page.
Location : query
Type : string
filter
Description : Standard filter field.
Location : query
Type : string
orderBy
Description : Field name to order by.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.lift
Path : v1/{+name}:lift
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
HTTP Method : POST
Parameters :
name
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : * Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
▼ ▲ integrations.projects.locations.products.sfdcInstances.create
Path : v1/{+parent}/sfdcInstances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
▼ ▲ integrations.projects.locations.products.sfdcInstances.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : PATCH
Parameters :
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
▼ ▲ integrations.projects.locations.products.sfdcInstances.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the SfdcInstance.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc instance.
▼ ▲ integrations.projects.locations.products.sfdcInstances.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name that is associated with the SfdcInstance.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.products.sfdcInstances.list
Path : v1/{+parent}/sfdcInstances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.create
Path : v1/{+parent}/sfdcChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : PATCH
Parameters :
name
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.list
Path : v1/{+parent}/sfdcChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of SfdcChannels.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
▼ ▲ integrations.projects.locations.cloudFunctions.create
Path : v1/{+parent}/cloudFunctions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions
HTTP Method : POST
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a cloud function project.
▼ ▲ integrations.projects.locations.certificates.list
Path : v1/{+parent}/certificates
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of Certificates.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the Certificate's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
▼ ▲ integrations.projects.locations.certificates.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
HTTP Method : GET
Parameters :
name
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a certificates in the specified project.
▼ ▲ integrations.projects.locations.certificates.create
Path : v1/{+parent}/certificates
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
▼ ▲ integrations.projects.locations.certificates.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Auto generated primary key
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
▼ ▲ integrations.projects.locations.certificates.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the Certificate.
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a certificate
▼ ▲ integrations.projects.locations.authConfigs.create
Path : v1/{+parent}/authConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
clientCertificate.sslCertificate
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.passphrase
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
▼ ▲ integrations.projects.locations.authConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
clientCertificate.sslCertificate
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
clientCertificate.passphrase
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
▼ ▲ integrations.projects.locations.authConfigs.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an auth config.
▼ ▲ integrations.projects.locations.authConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
▼ ▲ integrations.projects.locations.authConfigs.list
Path : v1/{+parent}/authConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authConfigs
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of AuthConfigs.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
▼ ▲ integrations.projects.locations.connections.list
Path : v1/{+parent}/connections
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method : GET
Parameters :
parent
Description : Required. Parent resource of the Connection, of the form: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Page token.
Location : query
Type : string
filter
Description : Filter.
Location : query
Type : string
orderBy
Description : Order by parameters.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Connections in a given project and location.
▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata
HTTP Method : GET
Parameters :
name
Description : Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the available entities and actions associated with a Connection.
▼ ▲ integrations.projects.locations.connections.runtimeEntitySchemas.list
Path : v1/{+parent}/runtimeEntitySchemas
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas
HTTP Method : GET
Parameters :
parent
Description : Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Page token.
Location : query
Type : string
filter
Description : Filter. Only the entity field with literal equality operator is supported.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
▼ ▲ integrations.projects.locations.connections.runtimeActionSchemas.list
Path : v1/{+parent}/runtimeActionSchemas
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas
HTTP Method : GET
Parameters :
parent
Description : Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Page token.
Location : query
Type : string
filter
Description : Filter. Only the action field with literal equality operator is supported.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
▼ ▲ integrations.projects.locations.integrations.execute
Path : v1/{+name}:execute
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute
HTTP Method : POST
Parameters :
name
Description : Required. The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
▼ ▲ integrations.projects.locations.integrations.schedule
Path : v1/{+name}:schedule
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule
HTTP Method : POST
Parameters :
name
Description : The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
▼ ▲ integrations.projects.locations.integrations.executeEvent
Path : v1/{+name}:executeEvent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent
HTTP Method : POST
Parameters :
name
Description : Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
triggerId
Description : Required. Id of the integration trigger config. The trigger_id is in the format: `integration_connector_trigger/projects/{gcp_project_id}/location/{location}/connections/{connection_name}/subscriptions/{subscription_name}`.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. Input data to integration is received in body in json format
▼ ▲ integrations.projects.locations.integrations.test
Path : v1/{+name}:test
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test
HTTP Method : POST
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Execute the integration in draft state
▼ ▲ integrations.projects.locations.integrations.list
Path : v1/{+parent}/integrations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations
HTTP Method : GET
Parameters :
parent
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The page size for the resquest.
Location : query
Type : integer
Format : int32
pageToken
Description : The page token for the resquest.
Location : query
Type : string
orderBy
Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
Location : query
Type : string
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the list of all integrations in the specified project.
▼ ▲ integrations.projects.locations.integrations.search
Path : v1/{+parent}/integrations:search
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations:search
HTTP Method : GET
Parameters :
parent
Description : Required. Project and location from which the integrations should be listed. Format: projects/*/locations/*/resources/integrations
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
query
Description : Required. The user query
Location : query
Type : string
filter
Description : Optional. The pre-filter to be applied to the search. This should follow the expressions defined in https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata. For example, "status:ANY("ACTIVE")" will return all the resources whose status contains the "ACTIVE".
Location : query
Type : string
pageSize
Description : Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 10 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `SearchIntegrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchIntegrations` must match the call that provided the page token.
Location : query
Type : string
enableNaturalLanguageQueryUnderstanding
Description : Optional. Whether to enable natural language query understanding.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches and returns the list of integrations in the specified project.
▼ ▲ integrations.projects.locations.integrations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The location resource of the request.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete the selected integration and all versions inside
▼ ▲ integrations.projects.locations.integrations.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region".
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
Location : query
Type : string
orderBy
Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last\_modified\_time", "created\_time", and "snapshot\_number". Ascending sort order for `name`.
Location : query
Type : string
fieldMask
Description : The field mask which specifies the particular data to be returned.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the list of all integration versions in the specified project.
▼ ▲ integrations.projects.locations.integrations.versions.create
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
newIntegration
Description : Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
Location : query
Type : boolean
createSampleIntegrations
Description : Optional. Optional. Indicates if sample workflow should be created.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a integration with a draft version in the specified project.
▼ ▲ integrations.projects.locations.integrations.versions.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a integration with a draft version in the specified project.
▼ ▲ integrations.projects.locations.integrations.versions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a integration in the specified project.
▼ ▲ integrations.projects.locations.integrations.versions.publish
Path : v1/{+name}:publish
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish
HTTP Method : POST
Parameters :
name
Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
▼ ▲ integrations.projects.locations.integrations.versions.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
▼ ▲ integrations.projects.locations.integrations.versions.upload
Path : v1/{+parent}/versions:upload
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload
HTTP Method : POST
Parameters :
parent
Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
▼ ▲ integrations.projects.locations.integrations.versions.download
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download
HTTP Method : GET
Parameters :
name
Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
fileFormat
Description : File format for download request.
Location : query
Type : string
Enum Descriptions :
Enum :
files
Description : Optional. Integration related file to download like Integration Json, Config variable, testcase etc.
Location : query
Repeated : Yes
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
▼ ▲ integrations.projects.locations.integrations.versions.downloadJsonPackage
Path : v1/{+name}:downloadJsonPackage
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage
HTTP Method : GET
Parameters :
name
Description : Required. Integration version name Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
files
Description : Optional. Integration related file to download like Integration Version, Config variable, testcase etc.
Location : query
Repeated : Yes
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads an Integration version package like IntegrationVersion,Integration Config etc. Retrieves the IntegrationVersion package for a given `integration_id` and returns the response as a JSON.
▼ ▲ integrations.projects.locations.integrations.versions.unpublish
Path : v1/{+name}:unpublish
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish
HTTP Method : POST
Parameters :
name
Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
▼ ▲ integrations.projects.locations.integrations.versions.test
Path : v1/{+name}:test
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:test
HTTP Method : POST
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Execute the integration in draft state
▼ ▲ integrations.projects.locations.integrations.versions.testCases.create
Path : v1/{+parent}/testCases
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this test case will be created. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
testCaseId
Description : Required. Required
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new test case
▼ ▲ integrations.projects.locations.integrations.versions.testCases.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}
HTTP Method : GET
Parameters :
name
Description : Required. The ID of the test case to retrieve
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a test case
▼ ▲ integrations.projects.locations.integrations.versions.testCases.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask specifying the fields in the above integration that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a test case
▼ ▲ integrations.projects.locations.integrations.versions.testCases.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. ID for the test case to be deleted
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a test case
▼ ▲ integrations.projects.locations.integrations.versions.testCases.list
Path : v1/{+parent}/testCases
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource where this TestCase was created.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time". Ascending sort order for "name".
Location : query
Type : string
readMask
Description : Optional. The mask which specifies fields that need to be returned in the TestCases's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all the test cases that satisfy the filters.
▼ ▲ integrations.projects.locations.integrations.versions.testCases.executeTest
Path : v1/{+testCaseName}:executeTest
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest
HTTP Method : POST
Parameters :
testCaseName
Description : Required. Test case resource name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : testCaseName
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes functional test
▼ ▲ integrations.projects.locations.integrations.versions.testCases.upload
Path : v1/{+parent}/testCases:upload
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload
HTTP Method : POST
Parameters :
parent
Description : Required. The test case to upload. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.
▼ ▲ integrations.projects.locations.integrations.versions.testCases.download
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download
HTTP Method : GET
Parameters :
name
Description : Required. The test case to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Location : path
Required : Yes
Type : string
fileFormat
Description : File format for download request.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.
▼ ▲ integrations.projects.locations.integrations.versions.testCases.takeoverEditLock
Path : v1/{+name}:takeoverEditLock
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock
HTTP Method : POST
Parameters :
name
Description : Required. The ID of test case to takeover edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Clear the lock fields and assign them to current user
▼ ▲ integrations.projects.locations.integrations.versions.testCases.execute
Path : v1/{+parent}/testCases:execute
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:execute
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource whose test cases are executed. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes all test cases in an integration version.
▼ ▲ integrations.projects.locations.integrations.executions.list
Path : v1/{+parent}/executions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name of the integration execution.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"
Location : query
Type : string
pageSize
Description : Optional. The size of entries in the response.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The token returned in the previous response.
Location : query
Type : string
orderBy
Description : Optional. The results would be returned in order you specified here. Currently supporting "create_time".
Location : query
Type : string
readMask
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 will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info
Location : query
Type : string
Format : google-fieldmask
filterParams.workflowName
Description : Workflow name.
Location : query
Type : string
filterParams.startTime
Description : Start timestamp.
Location : query
Type : string
Format : int64
filterParams.endTime
Description : End timestamp.
Location : query
Type : string
Format : int64
filterParams.eventStatuses
Description : List of possible event statuses.
Location : query
Repeated : Yes
Type : string
filterParams.taskStatuses
Description : List of possible task statuses.
Location : query
Deprecated : Yes
Repeated : Yes
Type : string
filterParams.customFilter
Description : Optional user-provided custom filter.
Location : query
Type : string
filterParams.executionId
Description : Execution id.
Location : query
Type : string
filterParams.parameterValue
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Location : query
Deprecated : Yes
Type : string
filterParams.parameterType
Description : Param type.
Location : query
Type : string
filterParams.parameterKey
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Location : query
Deprecated : Yes
Type : string
filterParams.parameterPairKey
Description : Param key in the key value pair filter.
Location : query
Type : string
filterParams.parameterPairValue
Description : Param value in the key value pair filter.
Location : query
Type : string
refreshAcl
Description : Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
Location : query
Type : boolean
truncateParams
Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
Location : query
Deprecated : Yes
Type : boolean
snapshotMetadataWithoutParams
Description : Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ integrations.projects.locations.integrations.executions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an execution in the specified project.
▼ ▲ integrations.projects.locations.integrations.executions.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
▼ ▲ integrations.projects.locations.integrations.executions.download
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download
HTTP Method : GET
Parameters :
name
Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Download the execution.
▼ ▲ integrations.projects.locations.integrations.executions.replay
Path : v1/{+name}:replay
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay
HTTP Method : POST
Parameters :
name
Description : Required. Next ID: 6 The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Re-execute an existing execution, with same request parameters and execution strategy.
▼ ▲ integrations.projects.locations.integrations.executions.suspensions.resolve
Path : v1/{+name}:resolve
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
HTTP Method : POST
Parameters :
name
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
▼ ▲ integrations.projects.locations.integrations.executions.suspensions.list
Path : v1/{+parent}/suspensions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
HTTP Method : GET
Parameters :
parent
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of entries in the response.
Location : query
Type : integer
Format : int32
pageToken
Description : Token to retrieve a specific page.
Location : query
Type : string
filter
Description : Standard filter field.
Location : query
Type : string
orderBy
Description : Field name to order by.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
▼ ▲ integrations.projects.locations.integrations.executions.suspensions.lift
Path : v1/{+name}:lift
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
HTTP Method : POST
Parameters :
name
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : * Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
▼ ▲ integrations.projects.locations.sfdcInstances.create
Path : v1/{+parent}/sfdcInstances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
▼ ▲ integrations.projects.locations.sfdcInstances.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : PATCH
Parameters :
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
▼ ▲ integrations.projects.locations.sfdcInstances.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the SfdcInstance.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc instance.
▼ ▲ integrations.projects.locations.sfdcInstances.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name that is associated with the SfdcInstance.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.sfdcInstances.list
Path : v1/{+parent}/sfdcInstances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of SfdcInstances.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.create
Path : v1/{+parent}/sfdcChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : PATCH
Parameters :
name
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an sfdc channel.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.list
Path : v1/{+parent}/sfdcChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of SfdcChannels.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
Location : query
Type : string
readMask
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
▼ ▲ integrations.projects.locations.templates.list
Path : v1/{+parent}/templates
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of Templates.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The token returned in the previous response.
Location : query
Type : string
filter
Description : Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
Location : query
Type : string
orderBy
Description : Optional. The results would be returned in the order you specified here.
Location : query
Type : string
readMask
Description : Optional. The mask which specifies fields that need to be returned in the template's response.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all templates matching the filter.
▼ ▲ integrations.projects.locations.templates.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
HTTP Method : GET
Parameters :
name
Description : Required. The template to retrieve. Format: projects/{project}/locations/{location}/templates/{template}
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a template in the specified project.
▼ ▲ integrations.projects.locations.templates.create
Path : v1/{+parent}/templates
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates
HTTP Method : POST
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new template
▼ ▲ integrations.projects.locations.templates.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Field mask specifying the fields in the above template that have been modified and must be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the template by given id.
▼ ▲ integrations.projects.locations.templates.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name that is associated with the Template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a template
▼ ▲ integrations.projects.locations.templates.search
Path : v1/{+parent}/templates:search
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates:search
HTTP Method : GET
Parameters :
parent
Description : Required. The client, which owns this collection of Templates.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The token returned in the previous response.
Location : query
Type : string
filter
Description : Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
Location : query
Type : string
orderBy
Description : Optional. The results would be returned in the order you specified here.
Location : query
Type : string
readMask
Description : Optional. The mask which specifies fields that need to be returned in the template's response.
Location : query
Type : string
Format : google-fieldmask
query
Description : Optional. The search query that will be passed to Vertex search service.
Location : query
Type : string
enableNaturalLanguageQueryUnderstanding
Description : Optional. Whether to enable natural language query understanding.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.
▼ ▲ integrations.projects.locations.templates.use
Path : v1/{+name}:use
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use
HTTP Method : POST
Parameters :
name
Description : Required. The name that is associated with the Template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.
▼ ▲ integrations.projects.locations.templates.import
Path : v1/{+name}:import
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import
HTTP Method : POST
Parameters :
name
Description : Required. The name that is associated with the Template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Import the template to an existing integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.
▼ ▲ integrations.projects.locations.templates.share
Path : v1/{+name}:share
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share
HTTP Method : POST
Parameters :
name
Description : Required. The name that is associated with the Template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Share a template with other clients. Only the template owner can share the templates with other projects. PERMISSION_DENIED would be thrown if the request is not from the owner.
▼ ▲ integrations.projects.locations.templates.unshare
Path : v1/{+name}:unshare
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare
HTTP Method : POST
Parameters :
name
Description : Required. The name that is associated with the Template.
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Unshare a template from given clients. Owner of the template can unshare template with clients. Shared client can only unshare the template from itself. PERMISSION_DENIED would be thrown if request is not from owner or for unsharing itself.
▼ ▲ integrations.projects.locations.templates.upload
Path : v1/{+parent}/templates:upload
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates:upload
HTTP Method : POST
Parameters :
parent
Description : Required. The template to upload. Format: projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Uploads a template. The content can be a previously downloaded template. Performs the same function as CreateTemplate, but accepts input in a string format, which holds the complete representation of the Template content.
▼ ▲ integrations.projects.locations.templates.download
Path : v1/{+name}:download
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download
HTTP Method : GET
Parameters :
name
Description : Required. The template to download. Format: projects/{project}/locations/{location}/template/{template_id}
Pattern : ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location : path
Required : Yes
Type : string
fileFormat
Description : Required. File format for download request.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downloads a template. Retrieves the `Template` and returns the response as a string.
▼ ▲ integrations.connectorPlatformRegions.enumerate
Path : v1/connectorPlatformRegions:enumerate
Flat Path : v1/connectorPlatformRegions:enumerate
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enumerates the regions for which Connector Platform is provisioned.
▼ ▲ integrations.callback.generateToken
Path : v1/callback:generateToken
Flat Path : v1/callback:generateToken
HTTP Method : GET
Parameters :
state
Description : The auth config id for the given request
Location : query
Type : string
code
Description : The auth code for the given request
Location : query
Type : string
gcpProjectId
Description : The gcp project id of the request
Location : query
Type : string
redirectUri
Description : Redirect uri of the auth code request
Location : query
Type : string
product
Description : Which product sends the request
Location : query
Type : string
Enum Descriptions :
Enum :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.