Clearing a Graph

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

POST /v2/{project_id}/graphs/{graph_id}/clear-graph

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
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 Request header parameter
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
job_id	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.

Status code: 400

Table 5 Response body parameters
Parameter	Type	Description
error_code	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.
error_msg	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

Clear all data in a graph.

POST http://Endpoint/v2/{project_id}/graphs/{graph_id}/clear-graph?clear_metadata=true

{ }

Status code: 200

Example response for a successful request

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "graph [demo] is not found",
  "error_code" : "GES.8012"
}

Была ли эта статья полезна?