GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup

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

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

Request body

displayNamestring

Required. The user-defined display name of the Study

Response

Successful response

createTimestring google-datetime

Output only. Time at which the study was created.

displayNamestring

Required. Describes the Study, default value is empty string.

inactiveReasonstring

Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

namestring

Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE' | 'COMPLETED'

Output only. The detailed state of a Study.

Changes

No recorded changes to this operation across all 8 revisions of this API.