Method: projects.locations.synonymSets.list

Returns all SynonymSets (for all contexts) for the specified location.

HTTP request

GET https://contentwarehouse.googleapis.com/v1/{parent}/synonymSets

Path parameters

Parameters
parent

string

Required. The parent name. Format: projects/{projectNumber}/locations/{location}. It takes the form projects/{project}/locations/{location}.

Query parameters

Parameters
pageSize

integer

The maximum number of synonymSets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous synonymSets.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to synonymSets.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for SynonymSetService.ListSynonymSets.

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

JSON representation 
{
  "synonymSets": [
    {
      object (SynonymSet)
    }
  ],
  "nextPageToken": string
}
Fields
synonymSets[]

object (SynonymSet)

The synonymSets from the specified parent.
nextPageToken

string

A page token, received from a previous synonymSets.list call. Provide this to retrieve the subsequent page.

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:

  • contentwarehouse.synonymSets.list

For more information, see the IAM documentation.