Lists all the studies in a region for an associated project.
HTTP request
GET https://{service-endpoint}/v1/{parent}/studies
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the Location to list the Study from. Format: |
Query parameters
Parameters | |
---|---|
pageToken |
Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. |
pageSize |
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:
JSON representation |
---|
{
"studies": [
{
object ( |
Fields | |
---|---|
studies[] |
The studies associated with the project. |
nextPageToken |
Passes this token as the |
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.