Help Center> RES> API Reference> API> Scenario> Deleting a Scenario
View PDF

Deleting a Scenario

Function

This API is used to delete a scenario. Deleted scenarios cannot be recovered. Exercise caution when performing this operation.

URI

DELETE /v2.0/{project_id}/workspaces/{workspace_id}/scenes/{scene_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

scene_id

Yes

String

Scenario ID

workspace_id

Yes

String

Workspace ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type. The value is application/json.

X-Auth-Token

Yes

String

User token. For details on how to obtain the user token, see Obtaining a User Token Through Password Authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

message

String

Response message (This field is not returned when the request is successful.)

error_code

String

Error code (This parameter is not returned when the request is successful.)

Example Requests

This API is used to delete a specified scenario.

/v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/scenes/testuuidxxxxxxxxxxxxxxxxxxxxxxxx

-

Example Responses

Status code: 200

OK

{
  "is_success" : "true"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Scenario