Updated on 2024-05-23 GMT+08:00

Batch Adding Vertices (2.1.9)

Function

This API is used to add vertices in batches.

URI

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

  • Request example
    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"
                    ]
                }
            }
        ]
    }

    SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

  • Parameter description
    Table 2 Request body parameter

    Parameter

    Mandatory

    Type

    Description

    vertices

    Yes

    Json

    Vertex array to be added

    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

  • Parameter description
    Table 4 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] already exists",
    "errorCode": "GES.8000"
    }

Return Value

  • Normal

    200

  • Abnormal
Table 5 Return code for failed requests

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.