Updating Vertex Properties in Batches

Updated on 2024-01-04 GMT+08:00

View PDF

Function

This API is used to update vertex properties in batches.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/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
actionId	Yes	String	Operator. Possible values: batch-update: Update the value of a property. batch-add: Add the value to a property. When the property's cardinality is single, the operation is the same as that of batch-update. When cardinality is list or set, the operator adds a value to a set. batch-del: Delete a property value.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
vertices	Yes	Json	Vertex array to be updated For details about this array, see the vertices parameters.
ignoreError	No	Boolean	Whether to ignore the update error of specific vertices. The default value is false. The value false indicates that if an error that causes the update failure is detected, for example, the vertex to be updated does not exist, an error is reported and no vertex will be updated. The value true indicates that similar errors will be ignored and other vertex properties without errors will be updated.

**Table 3** vertices parameter description
Parameter	Mandatory	Type	Description
vertex	Yes	String	Vertex ID
label	No	String	Vertex label
properties	Yes	Json	Value of each property to be updated

Response Parameters

**Table 4** 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. 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 vertex properties in batches. The vertex names to be updated are 150 and 6.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id=batch-update
{
    "vertices": [
        {
            "vertex": "150",
            "label": "movie",
            "properties": {
                "movieid": [
                    "150"
                ],
                "title": [  
                    "testmoive"
                ],
                "genres": [
                    "Comedy"
                ]
            }
        },
        {
            "vertex": "6",
            "properties": {
                "title": [
                    "testmoive_exist_id"
                ],
                "genres": [
                    "Comedy"
                ]
            }
        }
    ],
        "ignoreError": true

}

NOTE:

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 Codes

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.