Changing Property Names in Batches

Function

This API is used to change property names in batches.

URI

• URI format

  PUT /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/properties

• 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

  PUT  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/properties
  {
  	"labels": [{
  			"label": "movie",
  			"originPropertyName": "title",
  			"updatedPropertyName": "movie_title"
  		},
  		{
  			"label": "movie",
  			"originPropertyName": "newProperty",
  			"updatedPropertyName": "xxxxProperty"
  		},
  		{
  			"label": "user",
  			"originPropertyName": "gender",
  			"updatedPropertyName": "sexuality"
  		}
  	]
  }

  

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

• Request body parameter description

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  labels	Yes	JsonArray	Label array
  label	Yes	String	Name of a label
  originPropertyName	Yes	String	Original property name
  updatedPropertyName	Yes	String	New property name

Response

• Parameter description

  Table 3 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.
  updated_count	No	Integer	Number of properties that are successfully updated

• Response example (successful request)

  Http Status Code: 200
  {
   "updated_count": 4
  }

• Response example (failed request)

  Http Status Code: 400
   {
    "errorMessage": "label name does not exist",
    "errorCode": "GES.8807"
   }

Return Value

• Normal

  200

• Abnormal

  Table 4 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.