Method: projects.locations.studies.list

Lists all the studies in a region for an associated project.

Endpoint

get https://{endpoint}/v1/{parent}/studies

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

parent string

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}

Query parameters

pageToken string

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

pageSize integer

Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.

Request body

The request body must be empty.

Response body

Response message for VizierService.ListStudies.

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

Fields
studies[] object (Study)

The studies associated with the project.

nextPageToken string

Passes this token as the pageToken field of the request for a subsequent call. If this field is omitted, there are no subsequent pages.

JSON representation
{
  "studies": [
    {
      object (Study)
    }
  ],
  "nextPageToken": string
}