Method: projects.locations.studies.list

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

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/studies

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

Path parameters

Parameters
parent

string

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

Query parameters

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

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

Response message for VizierService.ListStudies.

JSON representation
{
  "studies": [
    {
      object (Study)
    }
  ],
  "nextPageToken": string
}
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.

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:

  • aiplatform.studies.list

For more information, see the IAM documentation.