Method: projects.locations.entryGroups.entries.list

Lists entries.

HTTP request

GET https://datacatalog.googleapis.com/v1/{parent}/entries

Path parameters

Parameters
parent

string

Required. The name of the entry group that contains the entries, which can be provided in URL format. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entryGroupId} It takes the form projects/{project_id}/locations/{location_id}/entryGroups/{entrygroup_id}.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for pageSize > 1000.

pageToken

string

Token that specifies which page is requested. If empty, the first page is returned.

readMask

string (FieldMask format)

The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting readMask to contain only one path "name" will cause entries.list to return a list of Entries with only "name" field.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

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

Response message for entries.list.

JSON representation
{
  "entries": [
    {
      object (Entry)
    }
  ],
  "nextPageToken": string
}
Fields
entries[]

object (Entry)

Entry details.

nextPageToken

string

Token to retrieve the next page of results. It is set to empty if no items remain in results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!