Contact UsGet started

DataSphere API v2, gRPC: ProjectService.Open

Written by
Updated at April 24, 2025

Opens the specified project.

gRPC request

rpc Open (OpenProjectRequest) returns (operation.Operation)

OpenProjectRequest

{
  "project_id": "string"
}

Field

Description

project_id

string

Required field. ID of the Project resource to open.
To get the project ID use a ProjectService.List request.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "project_id": "string",
    "status": "OpenProjectStatus"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "project_url": "string",
    "session_token": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

OpenProjectMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

OpenProjectResponse

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

OpenProjectMetadata

Field

Description

project_id

string

ID of the project that is being opened.

status

enum OpenProjectStatus

Project opening status.

  • OPEN_PROJECT_STATUS_UNSPECIFIED
  • OPEN_PROJECT_STATUS_CLOSING_IDE: Closing previous IDE instance.
  • OPEN_PROJECT_STATUS_UNZIPPING_PROJECT: Unzipping project.
  • OPEN_PROJECT_STATUS_ALLOCATING_VM: Allocating VM for the project.
  • OPEN_PROJECT_STATUS_ALLOCATING_RESOURCES: Allocating resources for the project.
  • OPEN_PROJECT_STATUS_STARTING_IDE: Starting IDE.
  • OPEN_PROJECT_STATUS_UNKNOWN: Unknown open project status.

OpenProjectResponse

Field

Description

project_url

string

URL of the project that is being opened.
Make GET request to project_url with sessionToken query parameter equals to session_token
or POST request to project_url with sessionToken body parameter equals to session_token
to fetch DataSphere web interface.

session_token

string

Session token of the project that is being opened.
Previous
Delete
Next
Get