2024-06-20
▼ ▲ integrations.projects.locations.templates.patch
HTTP Method: PATCH
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Location: query
Description: Required. Field mask specifying the fields in the above template that have been modified and must be updated.
Type: string
Format: google-fieldmask
name
Type: string
Required: Yes
Description: Identifier. Resource name of the template.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Description: Updates the template by given id.
▼ ▲ integrations.projects.locations.templates.delete
Description: Deletes a template
Path: v1/{+name}
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The name that is associated with the Template.
▼ ▲ integrations.projects.locations.templates.get
Parameters:
name
Description: Required. The template to retrieve. Format: projects/{project}/locations/{location}/templates/{template}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Required: Yes
Type: string
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Parameter Order: name
Path: v1/{+name}
Description: Get a template in the specified project.
▼ ▲ integrations.projects.locations.templates.search
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates:search
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/templates:search
Parameters:
parent
Description: Required. The client, which owns this collection of Templates.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
pageSize
Description: Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Location: query
Type: integer
pageToken
Type: string
Location: query
Description: Optional. The token returned in the previous response.
orderBy
Location: query
Type: string
Description: Optional. The results would be returned in the order you specified here.
filter
Description: Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
Location: query
Type: string
readMask
Type: string
Format: google-fieldmask
Description: Optional. The mask which specifies fields that need to be returned in the template's response.
Location: query
Description: Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.
HTTP Method: GET
▼ ▲ integrations.projects.locations.templates.import
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Description: Required. The name that is associated with the Template.
Type: string
Required: Yes
Description: Import the template to an existing integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.
Path: v1/{+name}:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import
HTTP Method: POST
▼ ▲ integrations.projects.locations.templates.create
Parameters:
parent
Description: Required. "projects/{project}/locations/{location}" format.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
Description: Creates a new template
Path: v1/{+parent}/templates
HTTP Method: POST
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates
▼ ▲ integrations.projects.locations.templates.list
Parameter Order: parent
Path: v1/{+parent}/templates
Description: Lists all templates matching the filter.
Parameters:
pageToken
Location: query
Description: Optional. The token returned in the previous response.
Type: string
orderBy
Type: string
Location: query
Description: Optional. The results would be returned in the order you specified here.
filter
Type: string
Description: Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
Location: query
pageSize
Location: query
Description: Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Type: integer
parent
Required: Yes
Description: Required. The client, which owns this collection of Templates.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
readMask
Type: string
Format: google-fieldmask
Location: query
Description: Optional. The mask which specifies fields that need to be returned in the template's response.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ integrations.projects.locations.templates.share
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location: path
Type: string
Description: Required. The name that is associated with the Template.
Required: Yes
Path: v1/{+name}:share
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Share a template with other clients. Only the template owner can share the templates with other projects. PERMISSION_DENIED would be thrown if the request is not from the owner.
HTTP Method: POST
▼ ▲ integrations.projects.locations.templates.use
Path: v1/{+name}:use
Description: Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use
Parameter Order: name
HTTP Method: POST
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Type: string
Description: Required. The name that is associated with the Template.
Required: Yes
Location: path
▼ ▲ integrations.projects.locations.templates.unshare
Parameter Order: name
Description: Unshare a template from given clients. Owner of the template can unshare template with clients. Shared client can only unshare the template from itself. PERMISSION_DENIED would be thrown if request is not from owner or for unsharing itself.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare
Parameters:
name
Description: Required. The name that is associated with the Template.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:unshare
HTTP Method: POST