API开放平台

TIP

# 自定义对象接口

# 创建自定义对象数据

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

{
    "object_key":"object_o12j1__c",
    "fields":
        {
          "field_t648t__c": "15523652014",
          "field_xjcv4__c": "1"
        }
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
objectKey VARCHAR(32) 是 对象key
fields VARCHAR 否 JSON格式字符串。格式：{字段key:value}
fields.is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
fields.trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id

响应示例：

{
    "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/v2/updateObjectData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "object_key":"object_o12j1__c",
    "fields":
    {
        "field_t648t__c": "15523652014",
        "field_xjcv4__c": "1"
    },
    "data_id": "7985906305389659217"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
objectKey VARCHAR(32) 是 对象key
fields VARCHAR 是 JSON格式字符串。格式：{字段key:value}
data_id VARCHAR(32) 是 数据id
fields.is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
fields.trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id

响应示例：

{
    "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/v2/deleteObjectData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "object_key":"object_o12j1__c",
    "data_id": "7985906305389659217"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
objectKey VARCHAR(32) 是 对象key
data_id VARCHAR(32) 是 数据id
is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id

响应示例：

{
    "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/v2/queryObjectData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "object_key":"object_o12j1__c",
    "page":"1",
    "rows":"100",
    "sorts":[
        {
            "field_key":"create_time",
            "type":"desc"
        }
    ],
    "query_group": 
    [
          {
             "connector": "OR",
             "filters": 
             [
                  {
                    "field_key":"field_t648t__c",
                    "operator":"ISN"
                  }
             ]
          },
          {
             "connector": "OR",
             "filters": 
             [
                  {
                    "field_key":"field_xjcv4__c",
                    "operator":"NQ",
                    "field_values":["1"]
                  }
             ]
          }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
objectKey VARCHAR(32) 是 对象key
page INT 是 页数，默认值为1
rows INT 是 条数，默认值为100
sorts List 是 排序，默认按创建时间倒序排序
sorts.field_key VARCHAR(30) 是 排序字段
sorts.type VARCHAR(4) 是 排序类型：asc 正序，desc 倒序
query_group List 是 查询条件列表
query_group.connector List 是 组内查询条件，条件AND或OR
query_group.filters VARCHAR(4) 是 组内查询条件
query_group.filters.field_key VARCHAR(32) 是 字段key
query_group.filters.operator VARCHAR(10) 是 操作符，详见附录操作符说明 (opens new window)
query_group.filters.field_values List 是 字段值集合

响应示例：

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

数据DATA示例:

[
    {
        "field_gpUBl__c": [
            {
                "path": "apaas/object_xwefy__ckesbwz/20240820163804416_f83a59c9_video_2.mp4",
                "name": "20240820163804416_f83a59c9_video_2.mp4",
                "url": "https://image-test.waiqin365.com/6482640261733170790/apaas/object_xwefy__ckesbwz/20240820163804416_f83a59c9_video_2.mp4"
            }
        ],
        "field_kO9Jj__c": {
            "objectKey": "bas_cm_customer",
            "name": "ytXQ26855",
            "objectName": "客户",
            "id": "4611807954003656104",
            "status": "1"
        },
        "field_MSYat__c": {
            "code": "false",
            "label": "否"
        },
        "field_Eko20__c": {
            "field_H0NmB__c": {
                "code": "86",
                "name": "中国"
            },
            "field_EmCU2__c": {
                "code": "320102005",
                "name": "玄武门街道"
            },
            "field_VaL7t__c": {
                "code": "320000",
                "name": "江苏省"
            },
            "field_khtSw__c": "江苏省南京市玄武区北京东路和平公园",
            "field_svfns__c": {
                "code": "320102",
                "name": "玄武区"
            },
            "field_oenzb__c": {
                "code": "320100",
                "name": "南京市"
            }
        },
        "field_FfIvq__c": [
            {
                "path": "apaas/object_xwefy__ckesbwz/6bcb088d-a667-4944-b65b-56b42ec8659d.jpg",
                "name": "6bcb088d-a667-4944-b65b-56b42ec8659d.jpg",
                "url": "https://image-test.waiqin365.com/6482640261733170790/apaas/object_xwefy__ckesbwz/6bcb088d-a667-4944-b65b-56b42ec8659d.jpg"
            }
        ],
        "field_WAIl2__c": "123321",
        "id": "5077952023722762711",
        "field_41L8M__c": {
            "biz_id": "8355751579367915903",
            "all_path": [
                {
                    "path": "apaas/object_xwefy__ckesbwz/e8125ddc-7685-409a-b650-c8c3433d0e63.jpg",
                    "name": "e8125ddc-7685-409a-b650-c8c3433d0e63.jpg",
                    "url": "https://image-test.waiqin365.com/6482640261733170790/apaas/object_xwefy__ckesbwz/e8125ddc-7685-409a-b650-c8c3433d0e63.jpg"
                }
            ]
        },
        "lock_status": {
            "code": "UNLOCK",
            "label": "未锁定"
        },
        "create_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2024-09-11 10:27:51"
        },
        "approval_status": {
            "code": "APPROVED",
            "label": "已通过"
        },
        "source_type": {
            "code": "VAXRLKZN",
            "label": "外部系统"
        },
        "field_rX29G__c": {
            "name": "三级部门",
            "id": "4664710066844793358",
            "status": "1"
        },
        "field_lZkWD__c": {
            "code": "86",
            "phone": "15874853655"
        },
        "field_RZskC__c": "862554441@qq.com",
        "field_Gs0Ff__c": "89.00",
        "field_gFeGC__c": "00043",
        "name": "0911002-接口创建",
        "creator_id": {
            "name": "外部系统",
            "id": "998"
        },
        "field_2c5Bs__c": "1020001001111012",
        "field_sNkYx__c": [
            {
                "path": "apaas/object_xwefy__ckesbwz/202409051040575_b6d33ded945a400b8b074321a28f99d9.png",
                "name": "202409051040575_b6d33ded945a400b8b074321a28f99d9.png",
                "url": "https://image-test.waiqin365.com/6482640261733170790/apaas/object_xwefy__ckesbwz/202409051040575_b6d33ded945a400b8b074321a28f99d9.png"
            }
        ],
        "field_JoTHn__c": {
            "name": "cs(全版本)",
            "id": "7673942957020836640",
            "status": "1"
        },
        "field_OcqT4__c": {
            "format": "YYYY-MM-DD HH:mm",
            "value": "2024-09-06 15:03"
        },
        "status": {
            "code": "NORMAL",
            "label": "正常"
        },
        "field_M4vnm__c": "99.00",
        "field_J9T6y__c": [
            {
                "id": "7673942957020836640",
                "name": "cs(全版本)",
                "status": "1"
            }
        ],
        "modify_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2024-10-09 14:05:22"
        },
        "field_AkJAv__c": {
            "name": "cs(全版本)",
            "id": "7673942957020836640",
            "status": "1"
        },
        "field_aY8MY__c": "接口新增单行文本",
        "field_El2d9__c": [
            {
                "id": "7673942957020836640",
                "name": "cs(全版本)",
                "status": "1"
            }
        ],
        "field_2j3ZD__c": "188.00",
        "field_ME3b2__c": [
            {
                "path": "apaas/object_xwefy__ckesbwz/640 (1).jpg",
                "name": "640 (1).jpg",
                "url": "https://image-test.waiqin365.com/6482640261733170790/apaas/object_xwefy__ckesbwz/640 (1).jpg"
            }
        ],
        "modifyier_id": {
            "name": "系统",
            "id": "-10000"
        },
        "business_type": {
            "code": "busitype_laEnXq__c",
            "id": "6104351327745702856",
            "label": "全字段展示业务类型",
            "status": "1"
        },
        "field_aKuCs__c": "0.6594",
        "field_b364V__c": "接口新增多行\n接口新增多行\n接口新增多行",
        "field_1wabs__c": {
            "format": "YYYY-MM-DD",
            "value": "2024-09-06"
        },
        "owner": {
            "name": "外部系统",
            "id": "998"
        },
        "field_ROHtC__c": [
            {
                "path": "apaas/object_xwefy__ckesbwz/b514d504-191d-4c8e-9797-ce2ec5455606.jpg",
                "name": "b514d504-191d-4c8e-9797-ce2ec5455606.jpg",
                "url": "https://image-test.waiqin365.com/6482640261733170790/apaas/object_xwefy__ckesbwz/b514d504-191d-4c8e-9797-ce2ec5455606.jpg"
            }
        ],
        "field_j6OEk__c": "接口新增单行文本",
        "field_UBKjD__c": "0",
        "field_dNpqA__c": [
            {
                "code": "L3jTYWJw",
                "label": "选项1",
                "status": "1"
            },
            {
                "code": "yXvySkzu",
                "label": "选项3",
                "status": "1"
            }
        ],
        "field_Wx6IC__c": {
            "format": "HH:mm",
            "value": "15:30"
        },
        "field_LQUXb__c": "https://apidev.waiqin365.com",
        "field_QGlYL__c": {
            "code": "AXGsWOO0",
            "pId": "9124172926008723899",
            "label": "第三层级",
            "id": "7921950961726770480",
            "status": "1"
        },
        "field_3e0EO__c": {
            "code": "svcISBFJ",
            "label": "选项1"
        },
        "field_P4D7V__c": {
            "name": "002",
            "id": "8124285021471404627",
            "status": "1"
        },
        "field_NlFdi__c": {
            "name": "cs(全版本)",
            "id": "7673942957020836640",
            "status": "1"
        }
    }
]

异常示例：

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

参数说明：

参数 类型 说明
id VARCHAR(32) 数据id
owner VARCHAR(32) 负责人
create_time long 创建时间
creator_id long 创建人
modify_time long 修改时间
modifyier_id long 修改人
name long 主属性
status long 状态

← 字段依赖关系接口 →