1. 根据左右关联对象获取{relationship}实例数据
根据左右关联对象获取{relationship}实例数据。
请求方式:/bosfoundationservice/{appKey}/prototype/edges/{relationship}/by-fromto?fromKey={fromKey}&toKey={toKey}
请求地址:GET
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
relationship | string | irSystemTag | 是 | 关系类名 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
fromKey | string | folders/123456 | 是 | 左对象类/左对象实例key |
toKey | string | documents/456789 | 是 | 右对象类/右对象类实例key |
Body:
application/json:
NULL
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
HTTP 200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": {
"bosclass": "",
"key": "123",
"from": "",
"to": ""
}
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | BOSCLASS_NA | 不适用于{relationship}类型实例数据 | NULL | 当对entity类型操作时 |
200 | ENTITYKEY_FORMAT_WRONG | 实体对象{bosclass/key}格式错误 | NULL | 当传入fromKey/toKey参数格式错误时 |
200 | RELATIONSHIP_BYFROMTO_NOTFOUND | 左对象为{fromKey}、右对象为{toKey}的关系对象不存在 | NULL | 当fromKey、toKey对应的relationship不存在时 |
200 | RELATIONSHIP_RELATIONENTITY_PERMISSION_INSUFFICIENT | 缺少对关联实体对象{bosclass/key}的读权限 | NULL | 如果对关系中fromKey、toKey对应的实体对象无读权限 |
200 | RELATIONSHIP_BOSCLASS_NOTFOUND | 关系类 relationship}不存在 | NULL | 当传入relationship错误时 |
200 | RELATIONSHIP_RELATIONENTITY_DATATYPE_WRONG | 关联左/右对象{bosclass/key}数据类型错误 | NULL | 若fromKey或toKey数据类型错误 |
200 | RELATIONSHIP_BOSCLASS_WRONG | 关系类名称错误 | NULL | 当实体对象关联关系存在但bosclass不等于{relationship}时 |
200 | CLASS_READPERMISSION_REQUIRED | 缺少实体类{bosclass}的读权限 | NULL | 当关联实体启用了类权限,但当前用户没有实体类的读权限时 |
1.5. 注意事项:
关系类指数据模型中配置的关系类。
fromKey、toKey格式为bosclass/key。