2022-12-30
▼ ▲ integrations.connectorPlatformRegions.enumerate
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/connectorPlatformRegions:enumerate
Flat Path: v1alpha/connectorPlatformRegions:enumerate
HTTP Method: GET
Description: Enumerates the regions for which Connector Platform is provisioned.
▼ ▲ integrations.callback.generateToken
Parameters:
code
Location: query
Description: The auth code for the given request
Type: string
gcpProjectId
Location: query
Type: string
Description: The gcp project id of the request
redirectUri
Type: string
Location: query
Description: Redirect uri of the auth code request
product
Description: Which product sends the request
Enum:
Type: string
Location: query
Enum Descriptions:
state
Type: string
Location: query
Description: The auth config id for the given request
Flat Path: v1alpha/callback:generateToken
HTTP Method: GET
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.
Path: v1alpha/callback:generateToken
▼ ▲ integrations.projects.locations.listTaskEntities
HTTP Method: GET
Path: v1alpha/{+parent}:listTaskEntities
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}:listTaskEntities
Parameter Order: parent
Description: This is a UI only method and will be moved away. Returns a list of common tasks.
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The location resource of the request. This is not going to be used but preserve the field for future.
Required: Yes
Location: path
▼ ▲ integrations.projects.locations.authConfigs.list
Description: Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Path: v1alpha/{+parent}/authConfigs
Parameters:
pageSize
Description: The size of entries in the response. If unspecified, defaults to 100.
Format: int32
Location: query
Type: integer
readMask
Format: google-fieldmask
Location: query
Description: The mask which specifies fields that need to be returned in the AuthConfig's response.
Type: string
filter
Location: query
Type: string
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
pageToken
Type: string
Description: The token returned in the previous response.
Location: query
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The client, which owns this collection of AuthConfigs.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
▼ ▲ integrations.projects.locations.authConfigs.patch
HTTP Method: PATCH
Parameter Order: name
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.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Type: string
Required: Yes
Location: path
Description: Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
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
updateMask
Location: query
Type: string
Description: Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Format: google-fieldmask
clientCertificate.sslCertificate
Location: query
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-----
Type: string
clientCertificate.encryptedPrivateKey
Type: string
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.authConfigs.get
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameters:
name
Description: Required. The name that is associated with the AuthConfig.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
HTTP Method: GET
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.delete
HTTP Method: DELETE
Parameter Order: name
Path: v1alpha/{+name}
Description: Deletes an auth config.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Type: string
Description: Required. The name that is associated with the AuthConfig.
▼ ▲ integrations.projects.locations.authConfigs.create
Parameter Order: parent
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.
HTTP Method: POST
Path: v1alpha/{+parent}/authConfigs
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
clientCertificate.encryptedPrivateKey
Location: query
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-----
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.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
parent
Type: string
Required: Yes
Location: path
Description: Required. "projects/{project}/locations/{location}" format.
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ integrations.projects.locations.connections.runtimeActionSchemas.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Required: Yes
Location: path
Type: string
Description: Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
pageToken
Type: string
Location: query
Description: Page token.
pageSize
Format: int32
Location: query
Type: integer
Description: Page size.
filter
Location: query
Type: string
Description: Filter. Only the action field with literal equality operator is supported.
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas
Description: Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
Path: v1alpha/{+parent}/runtimeActionSchemas
Parameter Order: parent
▼ ▲ integrations.projects.locations.connections.runtimeEntitySchemas.list
Path: v1alpha/{+parent}/runtimeEntitySchemas
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Description: Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
pageSize
Type: integer
Location: query
Format: int32
Description: Page size.
filter
Description: Filter. Only the entity field with literal equality operator is supported.
Type: string
Location: query
pageToken
Location: query
Description: Page token.
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas
Description: Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$
Type: string
Location: path
Description: Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata
Path: v1alpha/{+name}
Description: Lists the available entities and actions associated with a Connection.
▼ ▲ integrations.projects.locations.connections.list
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+parent}/connections
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Description: Lists Connections in a given project and location.
Parameters:
pageSize
Location: query
Description: Page size.
Type: integer
Format: int32
filter
Type: string
Location: query
Description: Filter.
orderBy
Description: Order by parameters.
Type: string
Location: query
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent resource of the Connection, of the form: `projects/*/locations/*`
Location: path
Type: string
pageToken
Description: Page token.
Type: string
Location: query
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.get
Description: Returns an IntegrationTemplateVersion in the specified project.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameters:
name
Description: Required. The TemplateVersion to retrieve. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+/versions/[^/]+$
Type: string
Location: path
Parameter Order: name
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions/{versionsId}
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Description: Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Required: Yes
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
Description: Creates an IntegrationTemplateVersion.
Path: v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.list
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
HTTP Method: GET
Description: Returns the list of all IntegrationTemplateVersions in the specified project.
Parameters:
pageToken
Description: A page token, received from a previous `ListIntegrationTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationTemplateVersions` must match the call that provided the page token.
Type: string
Location: query
pageSize
Format: int32
Type: integer
Description: The maximum number of IntegrationTemplateVersions 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
filter
Location: query
Type: string
Description: Filter syntax: defined in the EBNF grammar.
parent
Description: Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.products.certificates.delete
Parameter Order: name
Description: Delete a certificate
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Required: Yes
Description: Required. The name that is associated with the Certificate.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
▼ ▲ integrations.projects.locations.products.certificates.get
Description: Get a certificates in the specified project.
Parameters:
name
Required: Yes
Location: path
Description: Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
HTTP Method: GET
Parameter Order: name
Path: v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.certificates.patch
Parameter Order: name
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.
Path: v1alpha/{+name}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Output only. Auto generated primary key
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
updateMask
Location: query
Description: Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Format: google-fieldmask
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
▼ ▲ integrations.projects.locations.products.certificates.create
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Path: v1alpha/{+parent}/certificates
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Description: Required. "projects/{project}/locations/{location}" format.
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.list
Parameter Order: parent
Path: v1alpha/{+parent}/certificates
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Description: The size of entries in the response. If unspecified, defaults to 100.
Type: integer
Format: int32
Location: query
readMask
Format: google-fieldmask
Type: string
Location: query
Description: The mask which specifies fields that need to be returned in the Certificate's response.
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required: Yes
Type: string
Description: Required. The client, which owns this collection of Certificates.
pageToken
Type: string
Description: The token returned in the previous response.
Location: query
filter
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type: string
Location: query
Description: List all the certificates that match the filter. Restrict to certificate of current client only.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.get
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location: path
Required: Yes
Description: Required. The name that is associated with the SfdcChannel.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameter Order: name
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.list
Parameter Order: parent
Path: v1alpha/{+parent}/sfdcChannels
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method: GET
Parameters:
pageToken
Location: query
Type: string
Description: The token returned in the previous response.
pageSize
Description: The size of entries in the response. If unspecified, defaults to 100.
Location: query
Type: integer
Format: int32
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Description: Required. The client, which owns this collection of SfdcChannels.
readMask
Location: query
Description: The mask which specifies fields that need to be returned in the SfdcChannel's response.
Format: google-fieldmask
Type: string
filter
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type: string
Location: query
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Description: Required. The name that is associated with the SfdcChannel.
Location: path
Required: Yes
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Path: v1alpha/{+name}
Parameter Order: name
Description: Deletes an sfdc channel.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.create
Parameters:
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Type: string
Description: Required. "projects/{project}/locations/{location}" format.
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Path: v1alpha/{+parent}/sfdcChannels
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch
Description: Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Description: Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Format: google-fieldmask
Type: string
name
Description: Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Parameter Order: name
▼ ▲ integrations.projects.locations.products.sfdcInstances.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
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.
Parameter Order: parent
Path: v1alpha/{+parent}/sfdcInstances
HTTP Method: GET
Parameters:
pageToken
Description: The token returned in the previous response.
Type: string
Location: query
readMask
Description: The mask which specifies fields that need to be returned in the SfdcInstance's response.
Type: string
Format: google-fieldmask
Location: query
pageSize
Type: integer
Description: The size of entries in the response. If unspecified, defaults to 100.
Format: int32
Location: query
filter
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type: string
Location: query
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Description: Required. The client, which owns this collection of SfdcInstances.
▼ ▲ integrations.projects.locations.products.sfdcInstances.patch
Description: Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Parameter Order: name
HTTP Method: PATCH
Parameters:
name
Required: Yes
Description: Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location: path
Type: string
updateMask
Location: query
Description: Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Type: string
Format: google-fieldmask
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.products.sfdcInstances.get
Parameters:
name
Required: Yes
Type: string
Description: Required. The name that is associated with the SfdcInstance.
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Location: path
Description: Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.products.sfdcInstances.delete
Parameters:
name
Description: Required. The name that is associated with the SfdcInstance.
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Type: string
Location: path
Required: Yes
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Path: v1alpha/{+name}
Description: Deletes an sfdc instance.
▼ ▲ integrations.projects.locations.products.sfdcInstances.create
Parameter Order: parent
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required: Yes
Location: path
Description: Required. "projects/{project}/locations/{location}" format.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/sfdcInstances
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
HTTP Method: POST
Description: Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
▼ ▲ integrations.projects.locations.products.integrations.schedule
Description: Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Path: v1alpha/{+name}:schedule
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: The integration resource name.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
HTTP Method: POST
Parameter Order: name
▼ ▲ integrations.projects.locations.products.integrations.execute
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description: Required. The integration resource name.
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}:execute
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.
HTTP Method: POST
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute
▼ ▲ integrations.projects.locations.products.integrations.archiveBundle
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}:archiveBundle
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle
Parameters:
name
Description: Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration}
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
HTTP Method: POST
Description: PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
▼ ▲ integrations.projects.locations.products.integrations.monitorexecutionstats
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:monitorexecutionstats
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
parent
Required: Yes
Location: path
Description: Required. The parent resource name: {parent=projects/*/locations/*}.
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type: string
Description: Get execution stats
Path: v1alpha/{+parent}:monitorexecutionstats
HTTP Method: POST
▼ ▲ integrations.projects.locations.products.integrations.list
Parameters:
parent
Location: path
Required: Yes
Description: Required. Project and location from which the integrations should be listed. Format: projects/{project}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
pageToken
Type: string
Description: The page token for the resquest.
Location: query
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
pageSize
Type: integer
Format: int32
Location: query
Description: The page size for the resquest.
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
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+parent}/integrations
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations
Description: Returns the list of all integrations in the specified project.
Parameter Order: parent
▼ ▲ integrations.projects.locations.products.integrations.executions.cancel
Description: Cancellation of an execution
HTTP Method: POST
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Description: Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Type: string
Location: path
Path: v1alpha/{+name}:cancel
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel
▼ ▲ integrations.projects.locations.products.integrations.executions.list
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.
Path: v1alpha/{+parent}/executions
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions
Parameters:
filterParams.eventStatuses
Type: string
Location: query
Description: List of possible event statuses.
Repeated: Yes
filterParams.parameterType
Type: string
Description: Param type.
Location: query
truncateParams
Location: query
Type: boolean
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.
filterParams.parameterPairValue
Type: string
Description: Param value in the key value pair filter.
Location: query
filterParams.parameterKey
Description: Param key. DEPRECATED. User parameter_pair_key instead.
Location: query
Type: string
filterParams.startTime
Location: query
Type: string
Format: int64
Description: Start timestamp.
orderBy
Type: string
Description: Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Location: query
filterParams.customFilter
Description: Optional user-provided custom filter.
Location: query
Type: string
pageSize
Format: int32
Description: Optional. The size of entries in the response.
Location: query
Type: integer
parent
Description: Required. The parent resource name of the integration execution.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location: path
pageToken
Location: query
Description: Optional. The token returned in the previous response.
Type: string
filterParams.endTime
Format: int64
Location: query
Type: string
Description: End timestamp.
readMask
Location: query
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 event execution info will be filled and returned.
Format: google-fieldmask
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.
Type: boolean
Location: query
filterParams.parameterPairKey
Description: Param key in the key value pair filter.
Type: string
Location: query
filterParams.executionId
Type: string
Location: query
Description: Execution id.
filterParams.parameterValue
Type: string
Description: Param value. DEPRECATED. User parameter_pair_value instead.
Location: query
filterParams.taskStatuses
Type: string
Description: List of possible task statuses.
Location: query
Repeated: Yes
filterParams.workflowName
Location: query
Description: Workflow name.
Type: string
filter
Type: string
Description: Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
Location: query
Parameter Order: parent
▼ ▲ integrations.projects.locations.products.integrations.executions.get
Description: Get an execution in the specified project.
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Required: Yes
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/[^/]+$
Parameter Order: name
Path: v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.list
Path: v1alpha/{+parent}/suspensions
Description: * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
Parameters:
filter
Type: string
Description: Standard filter field.
Location: query
parent
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Description: Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
pageSize
Format: int32
Type: integer
Description: Maximum number of entries in the response.
Location: query
pageToken
Location: query
Description: Token to retrieve a specific page.
Type: string
orderBy
Description: Field name to order by.
Type: string
Location: query
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.lift
Path: v1alpha/{+name}:lift
Description: * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Required: Yes
Location: path
Description: Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Parameter Order: name
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.resolve
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Description: Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
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.
HTTP Method: POST
Path: v1alpha/{+name}:resolve
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
▼ ▲ integrations.projects.locations.products.integrations.executionsnapshots.list
Description: Lists the snapshots of a given integration executions. This RPC is not being used.
Parameters:
pageToken
Description: The token used to retrieve the next page results.
Location: query
Type: string
readMask
Location: query
Format: google-fieldmask
Type: string
Description: 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 event execution snapshot will be filled and returned.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required: Yes
Description: Required. The parent resource name of the integration execution.
Location: path
Type: string
pageSize
Format: int32
Description: Number of entries to be returned in a page.
Location: query
Type: integer
filter
Description: Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots
Path: v1alpha/{+parent}/executionsnapshots
▼ ▲ integrations.projects.locations.products.integrations.versions.archive
Parameter Order: name
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 archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location: path
Description: Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive
Path: v1alpha/{+name}:archive
▼ ▲ integrations.projects.locations.products.integrations.versions.getBundle
HTTP Method: GET
Path: v1alpha/{+name}:getBundle
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description: Required. The bundle name.
Description: PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
▼ ▲ integrations.projects.locations.products.integrations.versions.patch
Path: v1alpha/{+name}
HTTP Method: PATCH
Parameter Order: name
Description: Update a integration with a draft version in the specified project.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location: path
Description: Output only. Auto-generated primary key.
Type: string
Required: Yes
updateMask
Format: google-fieldmask
Description: Field mask specifying the fields in the above integration that have been modified and need to be updated.
Type: string
Location: query
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
▼ ▲ integrations.projects.locations.products.integrations.versions.download
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}:download
Parameters:
name
Required: Yes
Description: Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
fileFormat
Enum Descriptions:
Location: query
Enum:
Description: File format for download request.
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download
HTTP Method: GET
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.publish
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description: Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required: Yes
Type: string
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.
Path: v1alpha/{+name}:publish
▼ ▲ integrations.projects.locations.products.integrations.versions.validate
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description: Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
HTTP Method: POST
Description: Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
Path: v1alpha/{+name}:validate
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate
▼ ▲ integrations.projects.locations.products.integrations.versions.takeoverEditLock
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.
Parameters:
integrationVersion
Description: Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type: string
HTTP Method: POST
Parameter Order: integrationVersion
Path: v1alpha/{+integrationVersion}:takeoverEditLock
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
▼ ▲ integrations.projects.locations.products.integrations.versions.deactivate
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.
Path: v1alpha/{+name}:deactivate
HTTP Method: POST
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location: path
Required: Yes
Description: Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Type: string
▼ ▲ integrations.projects.locations.products.integrations.versions.updateBundle
HTTP Method: PATCH
Path: v1alpha/{+name}:updateBundle
Description: THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Description: Required. Bundle name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
▼ ▲ integrations.projects.locations.products.integrations.versions.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/versions
HTTP Method: POST
Parameters:
newIntegration
Location: query
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.
Type: boolean
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description: Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Description: Create a integration with a draft version in the specified project.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Parameter Order: parent
▼ ▲ integrations.projects.locations.products.integrations.versions.upload
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.
Parameters:
parent
Type: string
Description: Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/versions:upload
▼ ▲ integrations.projects.locations.products.integrations.versions.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Get a integration in the specified project.
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Path: v1alpha/{+name}
Parameters:
name
Required: Yes
Type: string
Description: Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
HTTP Method: GET
▼ ▲ integrations.projects.locations.products.integrations.versions.list
Parameter Order: parent
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". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required: Yes
Type: string
Location: path
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", "snapshot_number" Ascending sort order for "name".
Location: query
Type: string
pageToken
Type: string
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
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`.
Type: string
Location: query
pageSize
Location: query
Type: integer
Format: int32
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.
fieldMask
Description: The field mask which specifies the particular data to be returned.
Format: google-fieldmask
Location: query
Type: string
Description: Returns the list of all integration versions in the specified project.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
HTTP Method: GET
Path: v1alpha/{+parent}/versions
▼ ▲ integrations.projects.locations.products.authConfigs.delete
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Description: Required. The name that is associated with the AuthConfig.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Required: Yes
Description: Deletes an auth config.
Path: v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.authConfigs.create
Parameters:
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.
Type: string
Location: query
parent
Description: Required. "projects/{project}/locations/{location}" format.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location: path
Type: string
clientCertificate.encryptedPrivateKey
Location: query
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-----
Type: string
clientCertificate.sslCertificate
Type: string
Location: query
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-----
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1alpha/{+parent}/authConfigs
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
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.get
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.
Path: v1alpha/{+name}
Parameter Order: name
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Description: Required. The name that is associated with the AuthConfig.
Location: path
Required: Yes
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.products.authConfigs.list
Description: Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
pageToken
Description: The token returned in the previous response.
Type: string
Location: query
filter
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Location: query
Type: string
pageSize
Description: The size of entries in the response. If unspecified, defaults to 100.
Format: int32
Type: integer
Location: query
readMask
Format: google-fieldmask
Type: string
Description: The mask which specifies fields that need to be returned in the AuthConfig's response.
Location: query
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required: Yes
Description: Required. The client, which owns this collection of AuthConfigs.
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
Path: v1alpha/{+parent}/authConfigs
HTTP Method: GET
▼ ▲ integrations.projects.locations.products.authConfigs.patch
Parameter Order: name
Path: v1alpha/{+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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
HTTP Method: PATCH
Parameters:
clientCertificate.encryptedPrivateKey
Location: query
Type: string
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-----
clientCertificate.passphrase
Type: string
Location: query
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.
name
Required: Yes
Description: Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
clientCertificate.sslCertificate
Type: string
Location: query
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-----
updateMask
Location: query
Description: Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Type: string
Format: google-fieldmask
▼ ▲ integrations.projects.locations.products.createBundle
Parameter Order: parent
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location: path
Required: Yes
Description: Required. The location resource of the request.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle
Description: PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
HTTP Method: POST
Path: v1alpha/{+parent}:createBundle
▼ ▲ integrations.projects.locations.products.listTaskEntities
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The location resource of the request. This is not going to be used but preserve the field for future.
Path: v1alpha/{+parent}:listTaskEntities
Description: This is a UI only method and will be moved away. Returns a list of common tasks.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ integrations.projects.locations.appsScriptProjects.link
Parameters:
parent
Location: path
Required: Yes
Description: Required. The project that the executed integration belongs to.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1alpha/{+parent}/appsScriptProjects:link
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Links a existing Apps Script project.
Parameter Order: parent
▼ ▲ integrations.projects.locations.appsScriptProjects.create
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects
HTTP Method: POST
Description: Creates an Apps Script project.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The project that the executed integration belongs to.
Parameter Order: parent
Path: v1alpha/{+parent}/appsScriptProjects
▼ ▲ integrations.projects.locations.certificates.get
Parameters:
name
Required: Yes
Location: path
Description: Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Path: v1alpha/{+name}
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
HTTP Method: GET
Description: Get a certificates in the specified project.
▼ ▲ integrations.projects.locations.sfdcInstances.delete
Parameters:
name
Required: Yes
Description: Required. The name that is associated with the SfdcInstance.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Type: string
HTTP Method: DELETE
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes an sfdc instance.
▼ ▲ integrations.projects.locations.sfdcInstances.get
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Description: Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Description: Required. The name that is associated with the SfdcInstance.
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Type: string
Location: path
HTTP Method: GET
▼ ▲ integrations.projects.locations.sfdcInstances.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
HTTP Method: POST
Parameters:
parent
Location: path
Type: string
Description: Required. "projects/{project}/locations/{location}" format.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Path: v1alpha/{+parent}/sfdcInstances
Description: Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Parameter Order: parent
▼ ▲ integrations.projects.locations.sfdcInstances.patch
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Path: v1alpha/{+name}
Description: Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description: Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Required: Yes
Location: path
Type: string
updateMask
Description: Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Format: google-fieldmask
Type: string
Location: query
▼ ▲ integrations.projects.locations.sfdcInstances.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Location: query
Type: string
parent
Location: path
Type: string
Description: Required. The client, which owns this collection of SfdcInstances.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Format: int32
Type: integer
Description: The size of entries in the response. If unspecified, defaults to 100.
Location: query
readMask
Type: string
Location: query
Description: The mask which specifies fields that need to be returned in the SfdcInstance's response.
Format: google-fieldmask
pageToken
Description: The token returned in the previous response.
Location: query
Type: string
Path: v1alpha/{+parent}/sfdcInstances
Description: Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
HTTP Method: GET
Parameter Order: parent
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Parameters:
readMask
Description: The mask which specifies fields that need to be returned in the SfdcChannel's response.
Type: string
Location: query
Format: google-fieldmask
filter
Location: query
Type: string
Description: Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Location: path
Description: Required. The client, which owns this collection of SfdcChannels.
Type: string
Required: Yes
pageToken
Type: string
Location: query
Description: The token returned in the previous response.
pageSize
Type: integer
Location: query
Description: The size of entries in the response. If unspecified, defaults to 100.
Format: int32
Path: v1alpha/{+parent}/sfdcChannels
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.
HTTP Method: GET
Parameter Order: parent
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.create
Description: Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Path: v1alpha/{+parent}/sfdcChannels
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Description: Required. "projects/{project}/locations/{location}" format.
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Required: Yes
Location: path
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
HTTP Method: POST
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.delete
HTTP Method: DELETE
Description: Deletes an sfdc channel.
Parameter Order: name
Path: v1alpha/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Required: Yes
Description: Required. The name that is associated with the SfdcChannel.
Location: path
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.get
HTTP Method: GET
Description: Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameters:
name
Required: Yes
Location: path
Description: Required. The name that is associated with the SfdcChannel.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.patch
Path: v1alpha/{+name}
Parameters:
name
Required: Yes
Location: path
Description: Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
updateMask
Format: google-fieldmask
Description: Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Type: string
Location: query
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameter Order: name
▼ ▲ integrations.projects.locations.integrations.monitorexecutionstats
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:monitorexecutionstats
Path: v1alpha/{+parent}:monitorexecutionstats
Parameter Order: parent
Description: Get execution stats
Parameters:
parent
Location: path
Required: Yes
Description: Required. The parent resource name: {parent=projects/*/locations/*}.
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type: string
HTTP Method: POST
▼ ▲ integrations.projects.locations.integrations.execute
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute
Parameters:
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Description: Required. The integration resource name.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameter Order: name
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.
Path: v1alpha/{+name}:execute
▼ ▲ integrations.projects.locations.integrations.schedule
Description: Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Location: path
Description: The integration resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Path: v1alpha/{+name}:schedule
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule
▼ ▲ integrations.projects.locations.integrations.list
Parameter Order: parent
Description: Returns the list of all integrations in the specified project.
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations
Parameters:
orderBy
Location: query
Type: string
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.
pageSize
Location: query
Format: int32
Description: The page size for the resquest.
Type: integer
pageToken
Type: string
Location: query
Description: The page token for the resquest.
filter
Type: string
Location: query
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`.
parent
Required: Yes
Description: Required. Project and location from which the integrations should be listed. Format: projects/{project}
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/integrations
▼ ▲ integrations.projects.locations.integrations.executions.list
Parameter Order: parent
Parameters:
filterParams.taskStatuses
Repeated: Yes
Type: string
Location: query
Description: List of possible task statuses.
filter
Type: string
Description: Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
Location: query
filterParams.startTime
Description: Start timestamp.
Location: query
Type: string
Format: int64
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. The size of entries in the response.
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.
Type: boolean
Location: query
parent
Required: Yes
Description: Required. The parent resource name of the integration execution.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Location: path
filterParams.parameterPairKey
Type: string
Description: Param key in the key value pair filter.
Location: query
filterParams.parameterType
Description: Param type.
Type: string
Location: query
pageToken
Type: string
Location: query
Description: Optional. The token returned in the previous response.
filterParams.eventStatuses
Type: string
Location: query
Repeated: Yes
Description: List of possible event statuses.
filterParams.endTime
Description: End timestamp.
Format: int64
Type: string
Location: query
filterParams.parameterValue
Description: Param value. DEPRECATED. User parameter_pair_value instead.
Location: query
Type: string
filterParams.parameterKey
Description: Param key. DEPRECATED. User parameter_pair_key instead.
Location: query
Type: string
filterParams.workflowName
Type: string
Location: query
Description: Workflow name.
filterParams.executionId
Location: query
Type: string
Description: Execution id.
filterParams.parameterPairValue
Type: string
Location: query
Description: Param value in the key value pair filter.
truncateParams
Location: query
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.
Type: boolean
orderBy
Description: Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Type: string
Location: query
filterParams.customFilter
Type: string
Location: query
Description: Optional user-provided custom filter.
readMask
Type: string
Location: query
Format: google-fieldmask
Description: Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions
Path: v1alpha/{+parent}/executions
HTTP Method: GET
▼ ▲ integrations.projects.locations.integrations.versions.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description: Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Description: Get a integration in the specified project.
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Path: v1alpha/{+name}
▼ ▲ integrations.projects.locations.integrations.versions.archive
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive
HTTP Method: POST
Parameter Order: name
Path: v1alpha/{+name}:archive
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Description: Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required: Yes
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 archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
▼ ▲ integrations.projects.locations.integrations.versions.validate
HTTP Method: POST
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required: Yes
Type: string
Description: Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:validate
Path: v1alpha/{+name}:validate
Parameter Order: name
Description: Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
▼ ▲ integrations.projects.locations.integrations.versions.publish
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description: Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Location: path
Required: Yes
Type: string
Parameter Order: name
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.
HTTP Method: POST
Path: v1alpha/{+name}:publish
▼ ▲ integrations.projects.locations.integrations.versions.takeoverEditLock
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.
Path: v1alpha/{+integrationVersion}:takeoverEditLock
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
Parameter Order: integrationVersion
HTTP Method: POST
Parameters:
integrationVersion
Location: path
Type: string
Description: Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
▼ ▲ integrations.projects.locations.integrations.versions.create
Description: Create a integration with a draft version in the specified project.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
Parameters:
parent
Description: Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Required: Yes
Location: path
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
HTTP Method: POST
Path: v1alpha/{+parent}/versions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ integrations.projects.locations.integrations.versions.patch
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a integration with a draft version in the specified project.
Parameters:
updateMask
Type: string
Format: google-fieldmask
Description: Field mask specifying the fields in the above integration that have been modified and need to be updated.
Location: query
name
Description: Output only. Auto-generated primary key.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Location: path
Required: Yes
▼ ▲ integrations.projects.locations.integrations.versions.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Description: Returns the list of all integration versions in the specified project.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
Path: v1alpha/{+parent}/versions
Parameters:
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`.
Type: string
Location: query
pageToken
Location: query
Type: string
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.
fieldMask
Description: The field mask which specifies the particular data to be returned.
Type: string
Location: query
Format: google-fieldmask
orderBy
Location: query
Type: string
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", "snapshot_number" Ascending sort order for "name".
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". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Required: Yes
pageSize
Location: query
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.
Format: int32
Type: integer
▼ ▲ integrations.projects.locations.integrations.versions.deactivate
Parameters:
name
Location: path
Description: Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}:deactivate
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
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.
Parameter Order: name