Batch Adding Labels (2.2.21)
Function
This API is used to add labels in batches.
URI
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/action?action_id=batch-add
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
labels |
Yes |
Object |
Metadata labels |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Name of a label. Enter a maximum of 256 characters. Only letters, numbers, spaces, and the following special characters (%@#$:?*.+-_) are allowed. |
type |
No |
String |
Label type, indicating that the label is used for vertices or edges. The value can be vertex, edge, or all. The default value is all, indicating that the label applies to vertices and edges. |
properties |
Yes |
Object |
Property array to be added. Each array element is a property. For details, see Table 4. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Property name
|
cardinality |
Yes |
String |
Cardinality type of a property. The options are:
|
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
Parameter |
Type |
Description |
---|---|---|
errorMessage |
String |
System prompt.
|
errorCode |
String |
System prompt code.
|
result |
String |
Response result. If the execution is successful, the value is success. |
data |
Object |
If some labels fail to be added, this field contains the names of the failed labels and the failure causes. |
Example Request
Add metadata labels and their properties in batches. The names of the metadata labels are book and movie.
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/action?action_id=batch-add { "labels": [ { "name": "book", "type": "vertex", "properties": [ { "property": { "name": "title", "cardinality": "single", "dataType": "string" } } ] }, { "name": "movie", "type": "vertex", "properties": [ { "property": { "name": "movieid", "cardinality": "single", "dataType": "int" } } ] } ] }

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" }
Http Status Code: 200 { "result": "partial success", "data": { "failed": [ { "cause": "label name is invalid which can only contain letters, digits, space,%,@,#,$,:,?,*,.,+,- and _", "labelName": "book<" } ] } }
Status code: 400
Example response for a failed request
Http Status Code: 400 { "errorMessage": "Label : movie already exists", "errorCode": "GES.8812" }
Status Code
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. |
Error Code
See Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot