Updating Vertex Properties in Batches

Function

This API is used to update vertex properties in batches.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId}

• 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: batch-update: Update the value of a property. batch-add: Add the value to a property. When the property's cardinality is single, the operation is the same as that of batch-update. When cardinality is list or set, the operator adds a value to a set. batch-del: Delete a property value.

Request

• Request example

  POST
  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id=batch-update
  {
      "vertices": [
          {
              "vertex": "150",
              "label": "movie",
              "properties": {
                  "movieid": [
                      "150"
                  ],
                  "title": [  
                      "testmoive"
                  ],
                  "genres": [
                      "Comedy"
                  ]
              }
          },
          {
              "vertex": "6",
              "properties": {
                  "title": [
                      "testmoive_exist_id"
                  ],
                  "genres": [
                      "Comedy"
                  ]
              }
          }
      ],
          "ignoreError": true
  
  }

  

  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
  vertices	Yes	Json	Vertex array to be updated
  ignoreError (2.2.13)	No	Boolean	Whether to ignore the update error of specific vertices. The default value is false, indicating that an error that causes the update failure must be detected. For example, if the vertex to be updated does not exist, an error is reported and no vertex is updated. If the value is true, similar errors are ignored and other vertex properties without errors are updated.

  Table 3 vertices parameter description

  Parameter	Mandatory	Type	Description
  vertex	Yes	String	Vertex name
  label	No	String	Vertex label
  properties	Yes	Json	Value of each property to be updated

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":"vertex [Lily] does not exist",
   "errorCode":"GES.8220"
  }

Return Value

• Normal

  200

• Abnormal