Skip to content

Latest commit

 

History

History
131 lines (96 loc) · 3.89 KB

delete.md

File metadata and controls

131 lines (96 loc) · 3.89 KB
editable sourcePath
false
en/_api-ref/datasphere/v2/api-ref/Project/delete.md

DataSphere API v2, REST: Project.Delete

Deletes the specified project.

HTTP request

DELETE https://datasphere.{{ api-host }}/datasphere/v2/projects/{projectId}

Path parameters

#| ||Field | Description || || projectId | string

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

Response {#yandex.cloud.operation.Operation}

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "projectId": "string"
  },
  // Includes only one of the fields `error`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  }
  // 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. || || createdAt | string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || createdBy | string

ID of the user or service account who initiated the operation. || || modifiedAt | string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || done | boolean

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 | DeleteProjectMetadata

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 | Status

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

Includes only one of the fields error.

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. || |#

DeleteProjectMetadata {#yandex.cloud.datasphere.v2.DeleteProjectMetadata}

#| ||Field | Description || || projectId | string

ID of the project that is being deleted. || |#

Status {#google.rpc.Status}

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

#| ||Field | Description || || code | integer (int32)

Error code. An enum value of google.rpc.Code. || || message | string

An error message. || || details[] | object

A list of messages that carry the error details. || |#