Method: projects.locations.templates.search

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 request

GET https://integrations.googleapis.com/v1/{parent=projects/*/locations/*}/templates:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The client, which owns this collection of Templates.

Query parameters

Parameters
pageSize

integer

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.
pageToken

string

Optional. The token returned in the previous response.
filter

string

Optional. Standard filter field to filter templates. clientId 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

string

Optional. The results would be returned in the order you specified here.
readMask

string (FieldMask format)

Optional. The mask which specifies fields that need to be returned in the template's response.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
query

string

Optional. The search query that will be passed to Vertex search service.
enableNaturalLanguageQueryUnderstanding

boolean

Optional. Whether to enable natural language query understanding.

Request body

The request body must be empty.

Response body

Response for a request to search templates

If successful, the response body contains data with the following structure:

JSON representation 
{
  "templates": [
    {
      object (Template)
    }
  ],
  "nextPageToken": string
}
Fields
templates[]

object (Template)

List of templates retrieved.
nextPageToken

string

The token used to retrieve the next page results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • integrations.templates.list

For more information, see the IAM documentation.