Adding Labels in Batches

Function

This API is used to add labels in batches.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/action?action_id=batch-add

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
  graph_name	Yes	String	Graph name

Request

• Request example

  POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/action?action_id=batch-add  
  {
      "labels": [
          {
              "name": "book",
              "properties": [
                  {
                      "property": {
                          "name": "title",
                          "cardinality": "single",
                          "dataType": "string"
                      }
                  }
              ]
          },
          {
              "name": "movie",
              "properties": [
                  {
                      "property": {
                          "name": "movieid",
                          "cardinality": "single",
                          "dataType": "int"
                      }
                  }
              ]
          }
      ]
  }
  

  

  SERVER_URL: Address for accessing a graph. For details about its value, see Constraints of Using Service Plane APIs.

  Table 2 label parameter description

  Parameter	Mandatory	Type	Description
  name	Yes	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	Json	Property array to be added. The array element is property. For details about the parameters, see Table 3.

  Table 3 property parameter description

  Parameter	Mandatory	Type	Description
  name	Yes	String	Property name A property name can contain a maximum of 256 characters. A property name cannot contain <, >, &, ASCII 14, 15 or 30. The property under a label must be unique.
  cardinality	Yes	String	Cardinality type of a property. Possible values: single list set
  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

• Parameter description

  Table 4 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	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	No	String	If the execution is successful, the value of result is success.
  data	No	Json	If some labels fail to be added, this field contains the names of the failed labels and the failure causes.

• Response example (successful request)

  Http Status Code: 200
  {
   "result": "success"
  }

• Request example (successful request)

  Http Status Code: 200
  {
      "result": "partial success",
      "data": {
          "failed": [
              {
                  "cause": "label name is invalid  which can only contain letters, digits, space,%,@,#,$,:,?,*,.,+,- and _",
                  "labelName": "book<"
              }
          ]
      }
  }

• Response example (failed request)

  Http Status Code: 400
   {
    "errorMessage": "label already exists",
    "errorCode": "GES.8801"
   }

Return Value

• Normal

  200

• Abnormal

  Table 5 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.