Deleting a Label

This API is used to delete a label as well as the vertices and edges associated with the label.

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name
label_name	Yes	String	Name of a label

**Table 2** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
data	Object	Query results. This parameter is left blank when the request fails.

**Table 3** data parameter description
Parameter	Type	Description
outputs	Integer	Number of deleted vertices or edges when a label is deleted.

Delete a label as well as the vertices and edges associated with the label.

DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName}

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Status code: 200

Example response for a successful request

Http Status Code: 200
{
    "data": {
        "outputs": 3
    },
    "status": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
  "errorMessage": "graph [demo] is not found",
  "errorCode": "GES.8003"
}

Parent topic: Metadata Operation APIs

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.