Updating a Label

Function

This API is used to modify a label in overwriting mode. Modifying a label affects only metadata and does not affect existing vertices and edges. The existing vertex and edge properties remain in the old label format, while newly added (or overwritten) vertex and edge properties are written in the latest label format.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}

**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
label	Yes	String	Label name

Request Parameters

**Table 2** Request body parameter descriptions
Parameter	Mandatory	Type	Description
type	No	String	Label type, indicating that the label is used for vertices or edges. The options are: vertex: The label is used for vertices. edge: The label is used for edges. all: The label is used for vertices and edges. The default value is all.
properties	Yes	Object	Property array to be updated. Table 3 describes the parameters in an array.

**Table 3** properties parameter descriptions
Parameter	Mandatory	Type	Description
property	No	Object	Label properties. For details about the parameters, see Table 4. Note: If modifying the label disrupts the order of the original properties, such as inserting a new property in the middle of the original property list or deleting a property, then after data export, the old vertices and edges under this label will still be exported in the format of the old label, which does not match the exported schema and cannot be re-imported. If adding a property at the end of the original label, all exported data can be imported without being affected.

**Table 4** property parameter descriptions
Parameter	Mandatory	Type	Description
name	Yes	String	Property name A property name can contain a maximum of 256 characters. A property name cannot contain <, >, &, ASCCI 14,15 and 30. The property under a label must be unique.
cardinality	Yes	String	Composite type of a property. Currently, only single is supported.
dataType	Yes	String	Data type of a property. For details, see the metadata types in Specification Description.

Response Parameters

**Table 5** Response body parameter descriptions
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	Response result. If the request is successful, the value is success. If the request fails, the value is failed.

Example Request

Update the label named book.

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}
{
  "type": "vertex",
  "properties": [
    {
      "property": {
        "name": "Title",
        "cardinality": "single",
        "dataType": "string"
      }
    },
    {
      "property": {
        "name": "Version",
        "cardinality": "single",
        "dataType": "string"
      }
    }
  ]
}

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": "label : book not exist",
  "errorCode": "GES.8703",
  "result": "failed"
}

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.