1. 修改{relationship}关系类实例数据
修改关系类实例数据。
请求方式:PUT
请求地址:/bosfoundationservice/{appKey}/prototype/edges/{relationship}?transactionCode=xxx&fromKey={fromKey}&toKey={toKey}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
relationship | string | irSystemTag | 是 | 关系类名 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
fromKey | string | folders/123456 | 是 | 左对象类/左对象实例key |
toKey | string | documents/456789 | 是 | 右对象类/右对象类实例key |
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
{
"属性1": "值1",
"属性2": "值2"
}
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code:200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://xxx.xxx.xxx/bosfoundationservice/h5e4ff8257dc4e86a8042097f67d2718/prototype/edges/irFolderDocument/by-key/xxxx"
}
1.4. 状态码:
状态码 | code | message | 原因 |
---|---|---|---|
200 | RELATIONSHIP_BYFROMTO_NOTFOUND | 左对象为{fromKey}、右对象为{toKey}的关系对象不存在 | 当fromKey、toKey对应的relationship不存在时 |
200 | RELATIONSHIP_RELATIONENTITY_PERMISSION_INSUFFICIENT | 如果对关系中fromKey、toKey对应的实体对象无读权限 | 如果对关系中fromKey、toKey对应的实体对象无读权限 |
200 | BOSCLASS_NA | 不适用于{relationship}类型实例数据 | 当对entity类型操作时 |
200 | RELATIONSHIP_BOSCLASS_NOTFOUND | 关系类{relationship}不存在 | 当传入relationship错误时 |
200 | JSON_FORMAT_WRONG | Json格式错误 | 当传入body格式错误时 |
200 | ENTITYKEY_FORMAT_WRONG | 实体对象{bosclass/key}格式错误 | 当传入fromKey/toKey参数格式错误时 |
200 | RELATIONSHIP_RELATIONENTITY_DATATYPE_WRONG | 关联左/右对象{bosclass/key}数据类型错误 | 当传入fromKey/toKey参数数据类型错误时 |
200 | ENTITY_NOTFOUND | Key为{key}的{entity}实体对象不存在 | 当关联的对象不存在时 |
200 | RELATIONSHIP_BOSCLASS_WRONG | 关系类名称错误 | 当实体对象关联关系存在但bosclass不等于{relationship} |
200 | OBJECT_FIELD_DATATYPE_WRONG | XXX属性数据类型错误 | 当传入body字段数据类型错误 |
200 | RELATIONSHIP_BOSCLASS_CANNT_MODIFY | 关系类bosclass不可修改 | 当修改bosclass属性时 |
200 | RELATIONSHIP_FROM_CANNT_MODIFY | 关系类左对象不可修改 | 当修改fromKey属性时 |
200 | RELATIONSHIP_TO_CANNT_MODIFY | 关系类右对象不可修改 | 当修改toKey属性时 |
200 | CLASS_READPERMISSION_REQUIRED | 缺少实体类{bosclass}的读权限 | 当关联实体启用了类权限,但当前用户没有类的读权限时 |
1.5. 注意事项:
1、关系类指数据模型中配置的关系类。
2、可只传入需要修改的属性数据进行局部修改,其余属性值保持不变。
3、在body中传入relationship中未定义的属性时,对传入的属性作忽略处理。