Updating a Label
Function
In the current version, this API can only add properties to the end of existing labels, but cannot delete existing properties or update the property sequence.
URI
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties | 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | No | String | Name of a label. A label name can contain a maximum of 256 characters. Only letters, digits, spaces, and special characters %,@,#,$,:,?,*, .,+,- are allowed. |
| properties | Yes | Object | Property array to be appended. For details about the object, see properties elements. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| property | No | Object | Label properties. For details about the object, see Table 4 property elements. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Property name
|
| cardinality | Yes | String | Composite type of a property. Possible values:
|
| dataType | Yes | String | Data type of a property. For details, see the metadata types 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
| Parameter | Type | Description |
|---|---|---|
| errorMessage | String | System prompt.
|
| errorCode | String | System prompt code.
|
| result | String | Request result. If the request is successful, the value is success. If the request fails, the value is failed. |
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/{label_name}/properties
{
"name": "book",
"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
Http Status Code: 400
{
"errorMessage": "label already exists",
"errorCode": "GES.8801"
} 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
