Adding a Vertex

Function

This API is used to add a vertex.

URI

• URI format

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

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, 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}/vertices
  {
      "vertex":"Lily",
      "label":"user",
      "properties":{
          "Age":[
              "under 18"
          ],
          "Gender":[
              "F"
          ],
          "Occupation":[
              "artist"
          ],
          "Zip-code":[
              "98133"
          ]
      }
  }

  

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

• Parameter description

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  vertex	Yes	String	Vertex name
  label	Yes	String	Label of a vertex. If no label exists, set it to __DEFAULT__.
  properties	No	Json	Value of each property

Response

• Parameter description

  Table 3 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  result	No	String	If the execution is successful, the value of result is success.

• Response example (successful request)

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

• Response example (failed request)

  Http Status Code: 400
  {
  "errorMessage": "vertex [Lily] already exists",
  "errorCode": "GES.8000"
  }

Return Value

• Normal

  200

• Abnormal