Updating Edge Properties

Function

This API is used to update edge property values. The operations include ADD, UPDATE, and DEL.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index}

• 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
  actionId	Yes	String	Operator. Possible values: update: Update a property value. add: Add a property value. When the property's cardinality is single, the operation is the same as that of UPDATE. When cardinality is list or set, the operator adds a value to a set. del: Delete a property value.
  sourceVertex	Yes	String	Source vertex of an edge
  targetVertex	Yes	String	Target vertex of an edge
  index	No	Integer	Edge index. If this parameter is not set, properties of the first edge between vertices are modified.

Request

• Request example

  POST
  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id=update&source=Lily&target=Tom&index=1
  {
      "properties": {
          "Rating": ["7"],
          "Datetime":["2020-12-27 23:44:41"]
      },
      "targetProperties": [
      {
        "label": "rate",
        "properties": [
          "Rating"
        ]
      }
    ]
  }

  

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

• Parameter description

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  properties	Yes	Json	Value of each property
  label	No	String	Name of a label
  targetProperties	No	Array	Properties used to determine duplicate edges. If this parameter is not left blank, other properties of duplicate edges (with the same source vertex and target vertex) that has the same property value as the input property value will be overwritten. If there are multiple specified properties, the properties of the first edge that is matched based on the property input sequence are modified. If this parameter is left blank or no property is specified for the input edge, the first edge that meets the criteria is updated. For details about the property elements, see Table 3.

  Table 3 targetProperty parameter description

  Parameter	Mandatory	Type	Description
  label	Yes	String	Label name. The label of duplicate edges is determined by the property.
  properties	Yes	Array	Value of each property. The property list of duplicate edges is determined by the property. Currently, only a single property is supported. If multiple properties are entered, the first property is used.

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.

• Response example (successful request)

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

• Response example (failed request)

  Http Status Code: 400
   {
    "errorMessage": "edge [Lily-Tom-1] does not exist",
    "errorCode": "GES.8221"
   }

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.