Clearing a Graph(2.1.2)

This API is used to clear all data in a graph.

POST /v1.0/{project_id}/graphs/{graph_id}/action

**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_id	Yes	String	Graph ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
action_id	Yes	String	Graph action ID Set this parameter to the enumeration value clear-graph, which means that all data in the target graph will be cleared.
clear-metadata	No	Boolean	Whether to clear graph metadata. Set this parameter to true. The value can be true or false. The default value is false. true: The metadata will be cleared. false: The metadata will not be cleared.

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Status code: 200

**Table 4** 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. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
jobId	String	ID of an asynchronous job. NOTE: You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.

POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=clear-graph&clear-metadata=true

Status code: 200

{
  "jobId" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Bad Request

{
  "errorMessage" : "graph [demo] is not found",
  "errorCode" : "GES.8012"
}