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