Method: projects.locations.glossaries.terms.list

Lists GlossaryTerm resources in a Glossary.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/glossaries/*}/terms

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId} where locationId refers to a Google Cloud region.

Query parameters

Parameters
pageSize

integer

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

string

Optional. A page token, received from a previous terms.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to terms.list must match the call that provided the page token.
filter

string

Optional. Filter expression that filters GlossaryTerms listed in the response. Filters are supported on the following fields: - immediate_parent

Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}" - immediate_parent="projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}"

This will only return the GlossaryTerms that are directly nested under the specified parent.
orderBy

string

Optional. Order by expression that orders GlossaryTerms listed in the response. Order by fields are: name or createTime for the result. If not specified, the ordering is undefined.

Request body

The request body must be empty.

Response body

List GlossaryTerms Response

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

JSON representation 
{
  "terms": [
    {
      object (GlossaryTerm)
    }
  ],
  "nextPageToken": string,
  "unreachableLocations": [
    string
  ]
}
Fields
terms[]

object (GlossaryTerm)

Lists the GlossaryTerms in the specified parent.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
unreachableLocations[]

string

Locations that the service couldn't reach.

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:

  • dataplex.glossaryTerms.list

For more information, see the IAM documentation.