Adding a Label (1.1.6)

Function

This API is used to add a label.

URI

Request Parameters

• Request parameters (OBS scenario)

  Table 2 Request body parameters

  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.
  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	Properties you want to add to the label. For details about the object, see properties elements.

  Table 3 properties elements

  Parameter	Mandatory	Type	Description
  property	No	Object	Label properties. For details about the object, see Table 4 property elements.

  Table 4 property parameters

  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 Parameters

Example Request

Add a label. The label name is book. The label has three properties to add.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels  
{
  "name": "book",
  "type": "vertex",
  "properties": [
    {
      "property": {
        "name": "Title",
        "cardinality": "single",
        "dataType": "string"
      }
    },
    {
      "property": {
        "name": "Version",
        "cardinality": "single",
        "dataType": "string"
      }
    },
    {
      "property": {
        "name": "Category",
        "typeName1": "science",
        "typeName2": "literature",
        "typeNameCount": "2",
        "cardinality": "single",
        "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

Error Codes

See Error Codes.