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
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 |
---|---|---|---|
type |
No |
String |
Label type, indicating that the label is used for vertices or edges. The options are as follows:
The default value is all. |
properties |
Yes |
Object |
Property array to be appended. Table 3 describes the parameters in an array. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
property |
No |
Object |
Label properties. For details about the parameters, see Table 4. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Property name
|
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
Parameter |
Type |
Description |
---|---|---|
errorMessage |
String |
System prompt.
|
errorCode |
String |
System prompt.
|
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 one property to update.
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
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.