API开放平台

TIP

# 自定义对象接口

# 创建自定义对象数据

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

{
    "object_key":"object_o12j1__cb3o44q",
    "fields":
        {
          "field_t648t__cbjfc8c": "15523652014",
          "field_xjcv4__c1u5edm": "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/v1/updateObjectData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "object_key":"object_o12j1__cb3o44q",
    "fields":
    {
        "field_t648t__cbjfc8c": "15523652014",
        "field_xjcv4__c1u5edm": "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/v1/deleteObjectData/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

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

{
    "object_key":"object_o12j1__cb3o44q",
    "page":"1",
    "rows":"100",
    "sorts":[
        {
            "field_key":"create_tiem",
            "type":"desc"
        }
    ],
    "query_group": 
    [
          {
             "connector": "OR",
             "filters": 
             [
                  {
                    "field_key":"field_t648t__cbjfc8c",
                    "operator":"ISN"
                  }
             ]
          },
          {
             "connector": "OR",
             "filters": 
             [
                  {
                    "field_key":"field_xjcv4__c1u5edm",
                    "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示例:

[
    {
        "owner": "5215552184737348786",
        "create_time": 1632383874102,
        "field_qoj2v__c3b225q": "300.00",
        "modify_time": 1632475944736,
        "modifyier_id__r": "xuejy",
        "department__r": "领导",
        "field_9b4fv__cc0y41g": "300",
        "creator_id__r": "xuejy",
        "modifyier_id": "5215552184737348786",
        "creator_id": "5215552184737348786",
        "name": "1",
        "id": "7985906305389659217",
        "department": "7450815718882716695",
        "owner__r": "xuejy",
        "status": "1"
    },
    {
        "owner": "5215552184737348786",
        "create_time": 1632383874102,
        "field_qoj2v__c3b225q": "300.00",
        "modify_time": 1632475944736,
        "modifyier_id__r": "xuejy",
        "department__r": "领导",
        "field_9b4fv__cc0y41g": "300",
        "creator_id__r": "xuejy",
        "modifyier_id": "5215552184737348786",
        "creator_id": "5215552184737348786",
        "name": "1",
        "id": "7985906305389659217",
        "department": "7450815718882716695",
        "owner__r": "xuejy",
        "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 状态

← 字段依赖关系接口 →