Adding a Vertex (1.0.6)

Function

This API is used to add a vertex.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices

**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
vertex	Yes	String	Vertex name
label	Yes	String	Label of a vertex. If no label exists, set it to __DEFAULT__.
properties	No	Json	Value of each property

Response Parameters

**Table 3** Parameter description
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

Add a vertex named Lily and set the vertex label to user.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices
{
    "vertex":"Lily",
    "label":"user",
    "properties":{
        "Age":[
            "under 18"
        ],
        "Gender":[
            "F"
        ],
        "Occupation":[
            "artist"
        ],
        "Zip-code":[
            "98133"
        ]
    }
}

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

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.