Deleting an Edge (1.0.6)

Function

This API is used to delete an edge based on the specified property value or index.

URI

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/edges?source={sourceVertex}&target={targetVertex}&index={index}&label={label}&property={name}&value={value}

Request Parameters

**Table 1** Request body 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
source	Yes	String	Source vertex name
target	Yes	String	Target vertex name
index	No	Integer	Edge index If property has been set, ignore this parameter. If property is not set, the edge is deleted based on index. If neither property nor index is set, all edges between source and target are deleted.
label	No	String	Indicates the label of an edge, which can accelerate the search of property values. This parameter must be used together with property.
property	No	String	Property name of the edge to be deleted. This parameter must be used together with value.
value	No	String	Indicates the property value of the edge to be deleted. This parameter must be used together with property.

Example Request

Delete an edge. The source vertex name of the edge to be deleted is Vivian, the target vertex name is Lethal, the edge index value is 0, the edge label value is rate, the property name is Score, and the property value is 5.

DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges?source=Vivian&target=Lethal Weapon&index=0&label=rate&property=Score&value=5

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

Response Parameters

**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.
result	String	Request result. If the request is successful, the value is success. If the request fails, the value is failed.

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200
{
"result": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
    "errorMessage": "edge source vertex [Lily] does not exist",
    "errorCode": "GES.8000"
}

Status Code

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.