API开放平台

TIP

# 自定义对象接口

# 创建自定义对象数据

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

{
    "object_key":"object_o12j1__c",
    "fields":
        {
          "field_t648t__c": "15523652014",
          "field_xjcv4__c": "1"
        },
    "slave_fields": {
        "object_fABuI__c": [
            {
               "field_ten280__c": "文本内容",
               "name": "名称"
            }     
       ],
        "object_A6lji__c": [
            {
               "field_W9tYN__c": "文本内容",
               "name": "名称2"
            }     
       ]
    },
    "is_trigger": false,
    "check_rule": false
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
objectKey VARCHAR(32) 是 对象key
fields VARCHAR 否 JSON格式字符串。格式：{字段key:value}
is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id
check_rule boolean 否 是否校验验证规则和查重规则；true:校验，false:不校验
slave_fields VARCHAR 否 JSON格式字符串。数据中传入id为编辑，无id为新增，格式：{对象key:[{字段key:字段值}]}

响应示例：

{
    "msg_id":"X000001",
    "return_code":0,
    "return_msg":"",
    "response_data": "{\"id\":7985906305389659217}"
}

异常示例：

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

{
    "object_key":"object_o12j1__c",
    "fields":
    {
        "field_t648t__c": "15523652014",
        "field_xjcv4__c": "1"
    },
    "slave_fields": {
            "object_fABuI__c": [
                {
                   "field_ten280__c": "文本内容",
                   "name": "名称"
                }     
           ],
            "object_A6lji__c": [
                {
                   "field_W9tYN__c": "文本内容",
                   "name": "名称2"
                }     
           ]
        },
    "data_id": "7985906305389659217",
    "is_trigger": false,
    "check_rule": false
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
objectKey VARCHAR(32) 是 对象key
fields VARCHAR 是 JSON格式字符串。格式：{字段key:value}
data_id VARCHAR(32) 是 数据id
is_trigger boolean 否 是否触发工作流；true:触发，false:不触发
trigger_employee VARCHAR(32) 否 是否触发工作流为true的时候必填，员工id
check_rule boolean 否 是否校验验证规则和查重规则；true:校验，false:不校验
slave_fields VARCHAR 否 JSON格式字符串。数据中传入id为编辑，无id为新增，格式：{对象key:[{字段key:字段值}]}

响应示例：

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

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

参数说明：

参数 类型 必填 说明
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.qince.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":"name",
                    "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_QxaDA__c": {
            "format": "YYYY-MM-DD",
            "value": "2025-03-13"
        },
        "field_T08db__c": "222",
        "field_TtFXb__c": "222",
        "field_dWPHL__c": [
            {
                "code": "91CIFbjO",
                "label": "选项1",
                "status": "1"
            }
        ],
        "id": "9222626961451321265",
        "field_pOceu__c": "1",
        "lock_status": {
            "code": "UNLOCK",
            "label": "未锁定"
        },
        "field_whz1e__c": "222",
        "create_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2025-03-13 15:23:46"
        },
        "approval_status": {
            "code": "APPROVED",
            "label": "已通过"
        },
        "source_type": {
            "code": "LROPFXCJ",
            "label": "自建"
        },
        "field_3kgN5__c": {
            "code": "nPFlJR4S",
            "label": "选项1"
        },
        "name": "0313cs02",
        "creator_id": {
            "name": "x1",
            "id": "6611719441804418541",
            "status": "1"
        },
        "field_GOITb__c": {
            "format": "YYYY-MM-DD",
            "value": "2025-03-13"
        },
        "field_8JouQ__c": {
            "code": "true",
            "label": "是"
        },
        "status": {
            "code": "NORMAL",
            "label": "正常"
        },
        "modify_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2025-03-13 15:23:46"
        },
        "field_Dxf38__c": "1.00",
        "field_Y4dFC__c": "00005",
        "business_type": {
            "code": "busitype_default__c",
            "id": "8438431948543484993"
        },
        "modifyier_id": {
            "name": "x1",
            "id": "6611719441804418541",
            "status": "1"
        },
        "department": {
            "name": "IP16",
            "id": "10",
            "status": "1"
        },
        "owner": {
            "name": "x1",
            "id": "6611719441804418541",
            "status": "1"
        },
        "field_MhfYa__c": {
            "format": "YYYY-MM-DD HH:mm",
            "value": "2025-03-13 15:23"
        },
        "field_ujceN__c": "222"
    }
]

异常示例：

{
    "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 状态

# 批量删除自定义对象数据接口

# 接口描述

批量删除自定义对象数据接口，支持一次性删除多条自定义对象数据记录。该接口适用于需要批量删除数据的场景，提高删除操作的效率。

接口路径： /v2/batchDeleteObjectData/{openid}/{timestamp}/{digest}/{msgid}

请求方式： POST

Content-Type： application/json

# 请求示例

{
    "object_key": "object_o12j1__c",
    "data_ids": [12345, 12346, 12347],
    "is_trigger": false,
    "trigger_employee": null
}

说明： 本示例仅供参考，具体以参数说明为准。

# 参数说明

参数 类型 必填 说明
object_key String 是 对象code，需要删除数据的对象标识
data_ids List 是 数据id列表，需要删除的数据唯一标识集合
is_trigger Boolean 否 是否触发工作流，默认为false。如果为true，则删除操作会触发相关的工作流
trigger_employee Long 否 触发人ID，当is_trigger为true时必填。指定触发工作流的员工唯一标识

# 参数校验规则

  1. 对象标识校验: object_key 不能为空
  2. 数据ID列表校验: data_ids 不能为空，且必须包含至少一个数据ID
  3. 工作流触发校验:
    • 当 is_trigger 为 true 时，trigger_employee 必填
    • trigger_employee 对应的员工必须存在且状态为正常（未删除、未停用）
  4. 对象类型校验: 传入的对象必须是自定义对象，或者是预置对象（竞品、医院、医生、医院类型、医生类型）
  5. 数据存在性校验:
    • 所有 data_ids 中的数据必须存在
    • 所有数据必须未删除（status不为删除状态）
    • 如果存在已删除的数据，将返回错误提示

# 响应示例

成功响应：

{
    "return_code": "0",
    "return_msg": "批量删除成功",
    "msg_id": "{ msg_id }",
    "response_data": null
}

异常响应示例：

{
    "msg_id": "{ msg_id }",
    "return_code": "1",
    "return_msg": "数据id列表不能为空！",
    "response_data": null
}

# 响应参数说明

参数 类型 说明
msg_id String 请求消息ID
return_code String 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据（JSON字符串）。批量删除成功时，此字段为null

# 注意事项

  1. 对象类型限制: 仅支持自定义对象和预置对象（竞品、医院、医生、医院类型、医生类型）的批量删除操作
  2. 数据状态检查: 接口会自动检查所有待删除数据的 existence 和 status，确保数据存在且未删除
  3. 批量操作: 支持一次性删除多条数据，提高操作效率
  4. 工作流支持: 当 is_trigger 为 true 时，删除操作会触发相关的工作流，需要提供有效的 trigger_employee
  5. 事务性: 批量删除操作具有事务性，如果其中任何一条数据删除失败，整个批量操作将回滚
  6. 从对象处理: 如果删除的是主对象数据，系统会自动处理相关的从对象数据删除
  7. 关联数据: 删除操作会同时处理相关的协作关系、相关团队等关联数据
  8. 性能考虑: 建议单次批量删除的数据量不超过1000条，以保证接口响应性能

← 字段依赖关系接口 →