Console
    Contact Us Start free

    Method: projects.locations.glossaries.list

    Lists Glossary resources in a project and location.

    HTTP request

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

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

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

    Authorization requires the following IAM permission on the specified resource parent :

    • dataplex.glossaries.list

    Query parameters

    Parameters
    pageSize

    integer

    Optional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries 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 glossaries.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to glossaries.list must match the call that provided the page token.
    filter

    string

    Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are: - displayName="my-glossary" - categoryCount=1 - termCount=0

    orderBy

    string

    Optional. Order by expression that orders Glossaries 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 Glossaries Response

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

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

    object ( Glossary )

    Lists the Glossaries 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.glossaries.list

    For more information, see the IAM documentation .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: