Changing Property Names in Batches

Updated on 2024-01-04 GMT+08:00

View PDF

Function

This API is used to change property names in batches.

URI

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

**Table 1** URI parameters
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

**Table 2** Request body parameters
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 Parameters

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	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	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
updated_count	Integer	Number of properties that are successfully updated

Example Request

Change label property names in batches. The label name is movie, the original property name is title, and the new property name is movie_title. The label name is movie, the original property name is newProperty, and the new property name is xxxxProperty. The label name is user, the original property name is gender, and the new property name is sexuality.

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"
		}
	]
}

NOTE:

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
{
 "updated_count": 4
}

Status code: 400

Example response for a failed request

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

Status Code

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.