API开放平台

TIP

# 合作伙伴关系接口

# 新增合作伙伴

请求方式： POST（HTTPS）
**请求地址： ** https://openapi.waiqin365.com/api/apaas/v1/saveRelationData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "startObjectKey": "object_o12j1__cb3o44q",
  "startDataId": "782374823947929203",
  "endObjectKey": "object_o12j1__cb3o44q",
  "endDataId": "4637463847384733473",
  "code": "REL001",
  "orderNum": "1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
startObjectKey VARCHAR 是 关系起点对象key
startDataId VARCHAR 是 关系起点数据_id
endObjectKey VARCHAR 是 关系终点对象key
endDataId VARCHAR 是 关系终点数据_id
code VARCHAR 是 关系类型编码
orderNum VARCHAR 否 排序号

响应示例：

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": ""
}

异常示例：

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "新增合作伙伴关系失败！"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 删除合作伙伴关系

请求方式： POST（HTTPS）
**请求地址： ** https://openapi.waiqin365.com/api/apaas/v1/removeRelationData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "startObjectKey": "object_o12j1__cb3o44q",
  "startDataId": "782374823947929203",
  "endObjectKey": "object_o12j1__cb3o44q",
  "endDataId": "4637463847384733473",
  "code": "REL001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
startObjectKey VARCHAR 是 关系起点对象key
startDataId VARCHAR 是 关系起点数据_id
endObjectKey VARCHAR 是 关系终点对象key
endDataId VARCHAR 是 关系终点数据_id
code VARCHAR 是 关系类型编码

响应示例：

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": ""
}

异常示例：

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "删除合作伙伴关系失败！"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int
响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 查询合作伙伴关系

请求方式： POST（HTTPS）
**请求地址： ** https://openapi.waiqin365.com/api/apaas/v1/queryRelationData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "startObjectKey": "object_o12j1__cb3o44q",
  "startDataId": "782374823947929203",
  "endObjectKey": "object_o12j1__cb3o44q",
  "endDataId": "4637463847384733473",
  "code": "REL001"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
startObjectKey VARCHAR 是 关系起点对象key
startDataId VARCHAR 否 关系起点数据_id
endObjectKey VARCHAR 否 关系终点对象key
endDataId VARCHAR 否 关系终点数据_id
code VARCHAR 是 关系类型编码
page INT4 是 页数
rows INT4 是 行数

响应示例：

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": "",
  "response_data": "<<DATA>>"
}

数据DATA示例:

[
  {
    "code": "REL001",
    "relationName": "关系名称",
    "startObjectKey": "object_o12j1__cb3o44q",
    "startObjectName": "对象1",
    "startDataId": "37894738243823244",
    "startDataName": "数据1",
    "endObjectKey": "object_o4321__cb3o44q",
    "endObjectName": "对象2",
    "endDataId": "754326754832578432",
    "endDataName": "数据2"
  },
  {
    "code": "REL001",
    "relationName": "关系名称",
    "startObjectKey": "object_o12j1__cb3o44q",
    "startObjectName": "对象1",
    "startDataId": "543789473824383244",
    "startDataName": "数据3",
    "endObjectKey": "object_o4321__cb3o44q",
    "endObjectName": "对象2",
    "endDataId": "254326754832578432",
    "endDataName": "数据4"
  }
]

异常示例：

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "查询失败！"
}

参数说明：

参数 类型 说明
code VARCHAR 关系类型编码
relationName VARCHAR 关系类型名称
startObjectKey VARCHAR 关系起点对象key
startObjectName VARCHAR 关系起点对象名称
startDataId VARCHAR 关系起点数据_id
startDataName VARCHAR 关系起点数据_主属性
endObjectKey VARCHAR 关系终点对象key
endObjectName VARCHAR 关系终点对象名称
endDataId VARCHAR 关系终点数据_id
endDataName VARCHAR 关系终点数据_主属性

← 工作流 →