Adding an Edge (1.0.6)

Function

This API is used to add an edge.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges

• Parameter description

  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

Request

• Request example

  POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges
  
  {
       "source":"Lily",
       "target": "Rocky",
       "label": "rate",
       "properties": {"Score":[5],"Datetime":["2018-01-01 20:30:05"]},
       "parallelEdge": "override"
  }

  

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

• Request body parameters

  Parameter	Mandatory	Type	Description
  source	Yes	String	Source vertex name
  target	Yes	String	Target vertex name
  label	Yes	String	Label of a vertex. If no label exists, set it to __DEFAULT__.
  properties	No	Json	Value of each property
  parallelEdge	No	String	Processing mode of repetitive edges. The value can be allow, ignore, or override. allow indicates that repetitive edges are allowed. ignore indicates that subsequent repetitive edges are ignored. override indicates that the previous repetitive edges are overwritten. The default value is allow.

Response

• Parameter description

  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.
  data	String	This data field is included for a successful query, which contains the edge query result.
  result	String	If the execution is successful, the value of result is success.

• Response example (successful request)

  Http Status Code: 200
  {
   "result":"success",
   "data":{"index":"0"}
  }

• Response example (failed request)

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

Return Value

• Normal

  200

• Abnormal

  Table 2 Return code for failed requests

  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.