Method: referenceLists.list

Full name: projects.locations.instances.referenceLists.list

Lists a collection of reference lists.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of reference lists. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

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

enum (ReferenceListView)

How much of each ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_BASIC.

Request body

The request body must be empty.

Response body

A response to a request for a list of reference lists.

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

JSON representation 
{
  "referenceLists": [
    {
      object (ReferenceList)
    }
  ],
  "nextPageToken": string
}
Fields
referenceLists[]

object (ReferenceList)

The reference lists. Ordered in ascending alphabetical order by name.
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.

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:

  • chronicle.referenceLists.list

For more information, see the IAM documentation.