2024-06-22
▼ ▲ integrations.projects.locations.templates.import
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import
Parameters:
name
Location: path
Description: Required. The name that is associated with the Template.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Type: string
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.
Parameter Order: name
HTTP Method: POST
▼ ▲ integrations.projects.locations.templates.list
Parameters:
parent
Location: path
Type: string
Description: Required. The client, which owns this collection of Templates.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Type: string
Description: Optional. The token returned in the previous response.
Location: query
readMask
Description: Optional. The mask which specifies fields that need to be returned in the template's response.
Format: google-fieldmask
Type: string
Location: query
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
Location: query
Format: int32
filter
Location: query
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\"
orderBy
Location: query
Type: string
Description: Optional. The results would be returned in the order you specified here.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates
Parameter Order: parent
HTTP Method: GET
Description: Lists all templates matching the filter.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/templates
▼ ▲ 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
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name that is associated with the Template.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
HTTP Method: POST
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use
▼ ▲ integrations.projects.locations.templates.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/templates
Description: Creates a new template
HTTP Method: POST
Parameters:
parent
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. "projects/{project}/locations/{location}" format.
Location: path
▼ ▲ integrations.projects.locations.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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates:search
Path: v1/{+parent}/templates:search
Parameters:
orderBy
Location: query
Type: string
Description: Optional. The results would be returned in the order you specified here.
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The client, which owns this collection of Templates.
pageToken
Type: string
Description: Optional. The token returned in the previous response.
Location: query
readMask
Description: Optional. The mask which specifies fields that need to be returned in the template's response.
Format: google-fieldmask
Type: string
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.
Type: integer
Format: int32
filter
Type: string
Location: query
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\"
HTTP Method: GET
▼ ▲ integrations.projects.locations.templates.share
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
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Description: Required. The name that is associated with the Template.
Type: string
Path: v1/{+name}:share
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ integrations.projects.locations.templates.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: DELETE
Parameters:
name
Required: Yes
Description: Required. The name that is associated with the Template.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Description: Deletes a template
▼ ▲ integrations.projects.locations.templates.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.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Type: string
Description: Required. The name that is associated with the Template.
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare
▼ ▲ integrations.projects.locations.templates.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Field mask specifying the fields in the above template that have been modified and must be updated.
name
Description: Identifier. Resource name of the template.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Type: string
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Parameter Order: name
Description: Updates the template by given id.
▼ ▲ integrations.projects.locations.templates.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}
Path: v1/{+name}
Description: Get a template in the specified project.
Parameter Order: name
Parameters:
name
Type: string
Description: Required. The template to retrieve. Format: projects/{project}/locations/{location}/templates/{template}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/templates/[^/]+$
Location: path
HTTP Method: GET