Updating a Label (1.1.7)

Function

This API is used to either append properties to existing labels or overwrite the entire label.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties

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

Request Parameters

**Table 2** Request body parameter descriptions
Parameter	Mandatory	Type	Description
properties	Yes	Object	Property array to be appended. For details about the parameters, see Table 3.
override	No	Bool	The default value is false. If the value is true, the entire label is overwritten.

**Table 3** properties parameter descriptions
Parameter	Mandatory	Type	Description
property	No	Object	Label properties. For details about the parameters, see Table 4.

**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	Cardinality type of a property. The options are: single list set
dataType	Yes	String	Data type of a property. For details, see the metadata type in Table 1.
typeNameCount	No (This parameter is mandatory if dataType is enum.)	String	Total number of parameters of the enum type. This parameter controls the typeName quantity.
typeName*	No (This parameter is mandatory if dataType is enum.)	String	Names of parameters of the enum type. For example, if the value of typeNameCount is 2, the parameter contains typeName1:science and typeName2:literature.

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 code. 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 execution is successful, the value is success.

Example Request

Update a label. The label name is book. The label has three properties to update.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/book/properties
{
  "properties": [
    {
      "property": {
        "name": "Title",
        "cardinality": "single",
        "dataType": "string"
      }
    },
    {
      "property": {
        "name": "Version",
        "cardinality": "single",
        "dataType": "string"
      }
    },
    {
      "property": {
        "name": "Category",
        "typeName1": "science",
        "typeName2": "literature",
        "typeNameCount": "2",
        "dataType": "enum"
      }
    }
  ]
}

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": "Bad Request, properties is null",
    "errorCode": "GES.8000"
}

Status Codes

Return Value	Description
202 Accepted	The request has been received but has not been processed.
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.