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

Updating Edge Properties in Batches

Function

This API is used to update edge properties in batches.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/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

edges

Yes

Json

Edge array to be updated

ignoreError

No

Boolean

Whether to ignore the update error of specific edges. The default value is false, indicating that an error that causes the update failure must be detected. For example, if the edge to be updated does not exist, an error is reported and no edge is updated.

If the value is true, similar errors are ignored and other edge properties without errors are updated.

Table 3 edges parameter description

Parameter

Mandatory

Type

Description

source

Yes

String

Source vertex of an edge

target

Yes

String

Target vertex of an edge

index

No

String

Edge index. If this parameter is not set, the first edge between vertices is updated.

properties

Yes

Object

Value of each property

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 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 edge properties in batches. The source vertex of the edge is 46, and the target vertices of the edge are 39 and 38.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id=batch-update
{
    "edges": [
        {
            "source": "46",
            "target": "39",
            "properties": {
                "Rating": [
                    5
                ],
                "Datetime": [
                    "2018-01-0120:30:05"
                ]
            }
        },
        {
            "source": "46",
            "target": "38",
            "index": "0",
            "properties": {
                "Rating": [
                    4
                ],
                "Datetime": [
                    "2018-01-0120:30:05"
                ]
            }
        }
    ],
        "ignoreError": true
}

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":"edge source vertex [46] does not exist",
 "errorCode":"GES.8221"
}

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.

Error Codes

See Error Codes.