Help Center/ Graph Engine Service/ API Reference/ Service Plane APIs/ Database Edition/ Vertex Operation APIs/ Adding Vertices in Batches
Updated on 2024-01-04 GMT+08:00
View PDF

Adding Vertices in Batches

Function

This API is used to add vertices in batches.

URI

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

vertices

Yes

Json

Vertices you want to add. A maximum of 10,000 vertices can be added at a time. For details about this array, see the vertices parameters.

overrideExists

No

Boolean

Checks whether the vertex to be inserted exists. The default value is false.

  • If this parameter is set to false, an error is reported as long as there is one vertex, and all vertices fail to be written.
  • If this parameter is set to true, the existing vertices are overwritten.
Table 3 vertices parameter description

Parameter

Mandatory

Type

Description

vertex

Yes

String

Vertex ID

label

Yes

String

Vertex label

properties

No

Json

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.

  • 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

Add vertices in batches. The names of the vertices to be added are 150 and 6.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add
{
    "vertices": [
        {
            "vertex": "150",
            "label": "movie",
            "properties": {
                "movieid": [
                    "150"
                ],
                "title": [
                    "testmoive"
                ],
                "genres": [
                    "Comedy"
                ]
            }
        },
        {
            "vertex": "6",
            "label": "movie",
            "properties": {
                "movieid": [
                    "6"
                ],
                "title": [
                    "testmoive_exist_id"
                ],
                "genres": [
                    "Comedy"
                ]
            }
        }
    ],
    "overrideExists": true
}
  • SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
  • In the example, if vertex 6 already exists in the graph, properties of vertex 6 are overwritten.

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] already exists",
"errorCode": "GES.8000"
}

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.

Parent topic: Vertex Operation APIs