Updating Vertex Properties

Function

This API is used to update vertex property values. The operations include ADD, UPDATE, and DEL.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/properties/action?action_id={actionId}

• 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
  vertexId	Yes	String	Vertex ID
  actionId	Yes	String	Operator. Possible values: UPDATE: Update the value of a property. ADD: Add the value to a property. When the property's cardinality is single, the operation is the same as that of UPDATE. When cardinality is list or set, the operator adds a value to a set. DEL: Delete a property value.

Request

• Request example

  POST
  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/Lily/properties/action?action_id={actionId}
  {
      "properties":{
  
          "Age":[
              "under 18"
          ],
          "Gender":[
              "F"
          ]
      }
  }

  

  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
  properties	Yes	Json	Value of each property
  label	No	String	Name of a label

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] does not exist",
    "errorCode": "GES.8220"
   }

Return Value

• Normal

  200

• Abnormal

  Table 4 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.