Method: projects.locations.studies.lookup

Stay organized with collections Save and categorize content based on your preferences.

Looks a study up using the user-defined displayName field instead of the fully qualified resource name.

HTTP request

POST https://{service-endpoint}/v1beta1/{parent}/studies:lookup

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

Path parameters



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

Request body

The request body contains data with the following structure:

JSON representation
  "displayName": string


Required. The user-defined display name of the Study

Response body

If successful, the response body contains an instance of Study.

Authorization Scopes

Requires the following OAuth scope:


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.