Help Center/ Graph Engine Service/ API Reference/ Service Plane APIs/ Memory Edition/ Vertex Operation APIs/ Updating Vertex Properties
Updated on 2024-01-04 GMT+08:00
View PDF

Updating Vertex Properties

Function

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

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/properties/action?action_id={actionId}
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

vertex_id

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 Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

properties

Yes

Object

Value of each property

label

No

String

Name of a label

Response Parameters

Table 3 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 code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

result

String

Request result. If the request is successful, the value is success. If the request fails, the value is failed.

Example Request

Update the property value of a vertex. The value of the Age property is under 18, and the value of the Gender property is F.

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 Using Service Plane APIs.

Example Response

Status code: 200

Example response for a successful request 
Http Status Code: 200
 {
  "result": "success"
 }

Status code: 400

Example response for a failed request

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

Status Code

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.

Error Code

See Error Code.

Parent topic: Vertex Operation APIs