更新时间:2022-02-22 GMT+08:00

更新边属性

功能介绍

更新边的属性值,更新操作包含添加ADD,修改UPDATE和删除DEL。

URI

  • URI格式
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index}
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目编号,用于资源隔离。请参考获取项目ID

    graph_name

    String

    图名称。

    actionId

    String

    操作符。

    • update更新该属性的值。
    • add 添加属性的值。当属性的cardiniality为single时,其操作与update一致;当cardinality为list或set时,意为向集合中添加值。
    • del 删除属性的值。

    sourceVertex

    String

    边的起点。

    targetVertex

    String

    边的终点。

    index

    Integer

    边的标识号,若不设置,则修改两点间第一条边的属性。

请求

  • 请求样例
    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:图的访问地址,取值请参考业务面API使用限制

  • 参数说明
    表2 Body参数说明

    参数

    是否必选

    类型

    说明

    properties

    Json

    各个属性的值。

    label

    String

    label名称

    targetProperties

    Array

    判断重复边所用的属性列表。

    • 若不为空,则会覆盖重复边(起点终点一致)中,指定属性值与输入属性值相同的边的其他属性(若有多个指定属性,则修改按属性输入顺序匹配上的第一条边的属性)。
    • 若为空或输入边没有指定属性则更新行为与之前一致——更新符合条件的第一条边。

    属性列表元素格式见表 targetProperty参数说明

    表3 targetProperty参数说明

    参数

    是否必选

    类型

    说明

    label

    String

    label名称, 需要按属性判断重复边的Label。

    properties

    Array

    各个属性的值。需要按属性来判断重复边的Property列表。当前仅支持单个属性,输入多个属性则取第一个。

响应

  • 要素说明
    表4 要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

    系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。

    errorCode

    String

    系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。

    result

    String

    成功时result值为success。

  • 请求成功样例
    Http Status Code: 200
     {
      "result": "success"
     }
  • 请求失败样例
    Http Status Code: 400
     {
      "errorMessage": "edge [Lily-Tom-1] does not exist",
      "errorCode": "GES.8221"
     }

返回值

  • 正常

    200

  • 异常
    表5 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。