记录接口 - Udesk | 开发者中心

创建记录

POST /v1/data

请求参数

参数	类型	必填	说明
objectApiName	字符串	是	目标对象api名称.
fieldDataList	数组	是	字段API名称与字段值List.
fieldDataList[].fieldApiName	字符串	是	字段API名称.
fieldDataList[].fieldValue	字符串	否	字段值.
fieldDataList[].foreignExternalFieldApiName	字符串	否	指定查找字段关联对象的外部唯一字段API名称. 字段类型为查找时，非必填当此字段不传时，fieldDataList[].fieldValue要传dataId

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见. true / false .
data	对象	业务对象.
data.id	整型	新创建记录ID.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "objectApiName" : "contact",
  "fieldDataList" : [ {
    "fieldApiName" : "name",
    "fieldValue" : "测试联系人1"
  }, {
    "fieldApiName" : "organization",
    "fieldValue" : "客户",
    "foreignExternalFieldApiName": "sysOrganizationNo"
  } ]
}'

响应示例

{
  "code" : 200,
  "visible" : false,
  "data" : {
    "id" : 61528
  }
}

更新记录

PUT /v1/data

请求参数

参数	类型	必填	说明
objectApiName	字符串	是	目标对象api名称.
id	整型	否	记录ID. 如果ID为空，则uniqueFieldApiName与uniqueFieldValue必填
uniqueFieldApiName	字符串	否	指定外部唯一字段API名称. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
fieldDataList	数组	是	字段API名称与字段值List.
fieldDataList[].fieldApiName	字符串	是	字段API名称.
fieldDataList[].fieldValue	字符串	否	字段值.
fieldDataList[].foreignExternalFieldApiName	字符串	否	指定查找字段关联对象的外部唯一字段API名称. 字段类型为查找时，必填

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见. true / false .

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "objectApiName" : "contact",
  "id" : 61530,
  "fieldDataList" : [ {
    "fieldApiName" : "name",
    "fieldValue" : "测试联系人2"
  }, {
       "fieldApiName" : "organization",
       "fieldValue" : "客户",
       "foreignExternalFieldApiName": "sysOrganizationNo"
  } ]
}'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

查询记录

GET /v1/data

请求参数

参数	类型	必填	说明
objectApiName	字符串	否	对象API_NAME. 使用唯一字段查询时，必填
id	整型	否	记录ID. 如果ID为空，则uniqueFieldApiName与uniqueFieldValue必填
uniqueFieldApiName	字符串	否	外部唯一字段API名称. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见. true / false .
data	对象	业务对象.
data.id	整型	记录ID.
data.fieldDataList	数组	字段信息List.
data.fieldDataList[].fieldApiName	字符串	字段API名称.
data.fieldDataList[].fieldTypeApiName	字符串	字段API名称.
data.fieldDataList[].fieldValue	字符串	字段值.
data.fieldDataList[].foreignDataName	字符串	关联对象记录名称.
data.fieldDataList[].userEmail	字符串	关联员工邮箱.
data.fieldDataList[].optionNameList	数组	选项名称列表(选择类型字段).
data.fieldDataList[].tagValueList	数组	标签字段详细信息(电话或邮箱).
data.fieldDataList[].tagValueList[].tagName	字符串	标签名称.
data.fieldDataList[].tagValueList[].tagValue	字符串	标签值.
data.fieldDataList[].richText	对象	富文本字段详细信息(内容及附件).
data.fieldDataList[].richText.content	字符串	富文本内容.
data.fieldDataList[].richText.attachmentList	数组	附件列表.
data.fieldDataList[].richText.attachmentList[].name	字符串	原始文件名.
data.fieldDataList[].richText.attachmentList[].docAddress	字符串	外链.
data.fieldDataList[].richText.attachmentList[].size	整型	大小.
data.fieldDataList[].ownerResult	对象	所有人.
data.fieldDataList[].ownerResult.ownerType	整型	所有人类型.
data.fieldDataList[].ownerResult.ownerName	字符串	所有人名称.
data.fieldDataList[].signDto	对象	签名信息.
data.fieldDataList[].signDto.url	字符串	签名图片地址.
data.fieldDataList[].signDto.time	字符串	签名时间.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&id=61527' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "visible" : false,
  "data" : {
    "id" : 61527,
    "fieldDataList" : [ {
      "fieldApiName" : "name",
      "fieldTypeApiName" : "field_type_single_line",
      "fieldValue" : "测试联系人03"
    }, {
      "fieldApiName" : "calcFormula",
      "fieldTypeApiName" : "field_type_formular",
      "fieldValue" : "15.00"
    }, {
      "fieldApiName" : "coordinate",
      "fieldTypeApiName" : "field_type_geography",
      "fieldValue" : ""
    } ]
  }
}

删除记录

DELETE /v1/data

请求参数

参数	类型	必填	说明
objectApiName	字符串	是	对象API_NAME.
id	整型	否	记录ID. 如果ID为空，则uniqueFieldApiName与uniqueFieldValue必填
uniqueFieldApiName	字符串	否	外部唯一字段API名称. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见. true / false .

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&id=61529' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

查询记录列表

GET /v1/datas

此接口查询数据集依赖于过滤器，查询到的数据结果集，可保持与实际过滤器排序一致。适合小数据量查询，数据量阈值小于等于10000时有效。如有大数据量查询需求，推荐使用GET /v1/datas/scroll接口。

请求参数

参数	类型	必填	说明
pageNum	整型	否	页码 Min: 1 , 默认：1.
pageSize	整型	否	页大小 Min: 1 , Max: 100 , 默认：20.
filterId	整型	是	过滤器ID.
objectApiName	字符串	是	对象API_NAME.

响应数据

标准分页对象分页

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
paging	对象	分页对象.
paging.pageNum	整型	分页页码.
paging.pageSize	整型	分页页大小.
paging.total	整型	分页查询命中总数.
data	数组	业务对象.
data[].id	整型	记录ID.
data[].createUser	字符串	创建人名称.
data[].createTime	字符串	创建时间.
data[].updateUser	字符串	最后修改人名称.
data[].updateTime	字符串	最后修改时间.
data[].owner	字符串	所有人名称.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/datas?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&filterId=2&pageSize=20&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "paging": {
    "pageNum": 1,
    "pageSize": 20,
    "total": 50
  },
  "data" : [ {
    "id" : 46480,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-12 15:52",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-12 15:52",
    "owner" : "zhangsan"
  }, {
    "id" : 46476,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-12 15:04",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-12 15:08",
    "owner" : "zhangsan"
  }, {
    "id" : 46477,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-12 15:04",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-12 15:09",
    "owner" : "zhangsan"
  } ]
}

滚动查询记录列表

GET /v1/datas/scroll

此接口查询数据集依赖于过滤器，仅仅使用过滤器的条件，会忽略过滤器的排序，适合大数据量查询。

请求参数

参数	类型	必填	说明
scrollId	整型	否	滚动记录ID Min: 0 , 默认: 0.
pageSize	整型	否	页大小 Min: 1 , Max: 100 , 默认: 20.
filterId	整型	是	过滤器ID.
objectApiName	字符串	是	对象API_NAME.

响应数据

标准分页对象分页

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
paging	对象	分页对象.
paging.pageNum	整型	分页页码.
paging.pageSize	整型	分页页大小.
paging.total	整型	分页查询命中总数.
data	数组	业务对象.
data[].id	整型	记录ID.
data[].createUser	字符串	创建人.
data[].createTime	字符串	创建时间.
data[].updateUser	字符串	最后更新人.
data[].updateTime	字符串	最后更新时间.
data[].owner	字符串	所有人.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/datas/scroll?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&filterId=2&pageSize=20' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "paging": {
    "pageNum": 1,
    "pageSize": 20,
    "total": 50
  },
  "data" : [ {
    "id" : 46433,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-11 14:23",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-11 14:23",
    "owner" : "zhangsan"
  }, {
    "id" : 46434,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-11 16:52",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-11 16:52",
    "owner" : "zhangsan"
  }, {
    "id" : 46436,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-11 17:00",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-11 17:00",
    "owner" : "zhangsan"
  } ]
}

搜索查询记录

POST /v1/datas/search

此接口可以通过多个条件（字段ApiName、操作符、字段值和搜索逻辑）进行搜索，返回匹配的记录列表。适合小数据量查询，数据量阈值小于等于10000时有效。如有大数据量查询需求，推荐使用GET /v1/datas/scroll接口。

此接口支持的字段类型和字段支持的操作符见下表。

操作符介绍

操作符	解释
is	等于
not	不等于
contains	包含
not_contains	不包含
is_null	为空
is_not_null	不为空
is_any	任意等于
not_any	任意不等于
contains_any	任意包含
not_contains_any	任意不包含
greater_than	大于
greater_than_eq	大于或等于
less_than	小于
less_than_eq	小于或等于
greater_than_current	大于当前
greater_than_eq_current	大于等于当前
eq_current	等于当前
less_than_current	小于当前
less_than_eq_current	小于等于当前

字段支持的操作符枚举

字段	支持的操作符
自动编号	is、not、contains、not_contains、is_null、is_not_null
单行文本	is、not、contains、not_contains、is_null、is_not_null
多行文本	is、not、contains、not_contains、is_null、is_not_null
单选	is、not、is_any、not_any、is_null、is_not_null
多选	is、not、is_any、not_any、is_null、is_not_null
级联字段	is、not、is_null、is_not_null、contains、not_contains
电话	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
邮箱	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
日期	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
日期时间	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
数字	is、not、greater_than、greater_than_eq、less_than、less_than_eq、is_null、is_not_null
查找型	is、not、is_null、is_not_null
查找员工	is、not、is_null、is_not_null
查找多员工	is、not、is_null、is_not_null、is_any、not_any、contains_all、not_contains_all
所有人	is、not、is_null、is_not_null

请求参数

参数	类型	必填	说明
pageNum	整型	否	页码 Min: 1 , 默认：1.
pageSize	整型	否	页大小 Min: 1 , Max: 100 , 默认：20.
filterId	整型	是	过滤器ID(特殊过滤器不支持).
objectApiName	字符串	是	对象API_NAME.
judgeStrategy	整型	否	高级公式类型。1: 满足所有条件； 2: 满足任何一个； 3:自定义逻辑。默认:1
customJudgeLogic	字符串	否	高级公式。当judgeStrategy为 3 时，需要设置该字段.
conditionList	数组	否	条件数组.
conditionList[].fieldApiName	字符串	是	字段ApiName.
conditionList[].operator	字符串	是	字段操作符.
conditionList[].value	字符串	否	字段值,如果多个用逗号隔开.
keyword	字符串	否	检索字符串，最长支持30个字符，超出后将被截取.

响应数据

标准分页对象分页

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
paging	对象	分页对象.
paging.pageNum	整型	分页页码.
paging.pageSize	整型	分页页大小.
paging.total	整型	分页查询命中总数.
data	数组	业务对象.
data[].id	整型	记录ID.
data[].fieldDataList	数组	字段信息List.
data[].fieldDataList[].fieldApiName	字符串	字段API名称.
data[].fieldDataList[].fieldTypeApiName	字符串	字段API名称.
data[].fieldDataList[].fieldValue	字符串	字段值.
data[].fieldDataList[].foreignDataName	字符串	关联对象记录名称.
data[].fieldDataList[].userEmail	字符串	关联员工邮箱.
data[].fieldDataList[].optionNameList	数组	选项名称列表(选择类型字段).
data[].fieldDataList[].tagValueList	数组	标签字段详细信息(电话或邮箱).
data[].fieldDataList[].tagValueList[].tagName	字符串	标签名称.
data[].fieldDataList[].tagValueList[].tagValue	字符串	标签值.
data[].fieldDataList[].richText	对象	富文本字段详细信息(内容及附件).
data[].fieldDataList[].richText.content	字符串	富文本内容.
data[].fieldDataList[].richText.attachmentList	数组	附件列表.
data[].fieldDataList[].richText.attachmentList[].name	字符串	原始文件名.
data[].fieldDataList[].richText.attachmentList[].docAddress	字符串	外链.
data[].fieldDataList[].richText.attachmentList[].size	整型	大小.
data[].fieldDataList[].ownerResult	对象	所有人.
data[].fieldDataList[].ownerResult.ownerType	整型	所有人类型.
data[].fieldDataList[].ownerResult.ownerName	字符串	所有人名称.
data[].fieldDataList[].signDto	对象	签名信息.
data[].fieldDataList[].signDto.url	字符串	签名图片地址.
data[].fieldDataList[].signDto.time	字符串	签名时间.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/datas/search?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -d
{
    "pageNum": 1,
    "pageSize": 20,
    "filterId": 2,
    "objectApiName": "contact",
    "judgeStrategy": 3,
    "customJudgeLogic":"1 or 2 and 3",
    "conditionList": [
        {
            "fieldApiName": "name",
            "operator": "is",
            "value": "test"
        },
        {
            "fieldApiName": "weiyibiaoshi",
            "operator": "contains",
            "value": "13"
        },
         {
             "fieldApiName": "youxiang",
             "operator": "contains_any",
             "value": "test@qq.com"
         }
    ]
}

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 5826,
            "fieldDataList": [
                {
                    "fieldApiName": "name",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "test"
                },
                {
                    "fieldApiName": "calcFormula",
                    "fieldTypeApiName": "field_type_formular",
                    "fieldValue": "15.00"
                },
                {
                    "fieldApiName": "coordinate",
                    "fieldTypeApiName": "field_type_geography",
                    "fieldValue": ""
                }
            ]
        }
    ]
}

滚动搜索查询记录

POST /v1/datas/scrollSearch

此接口可以通过多个条件（字段ApiName、操作符、字段值和搜索逻辑）进行搜索，返回匹配的记录列表。接口默认使用实际创建时间升序排列目标结果集，scrollId字段可用来分页，默认0查询第一页，后续查询设置值为上一次查询返回的最大ID即可。(简单搜索查询需求，推荐使用GET /v1/datas/search接口)

此接口支持的字段类型和字段支持的操作符见下表。

操作符介绍

操作符	解释
is	等于
not	不等于
contains	包含
not_contains	不包含
is_null	为空
is_not_null	不为空
is_any	任意等于
not_any	任意不等于
contains_any	任意包含
not_contains_any	任意不包含
greater_than	大于
greater_than_eq	大于或等于
less_than	小于
less_than_eq	小于或等于
greater_than_current	大于当前
greater_than_eq_current	大于等于当前
eq_current	等于当前
less_than_current	小于当前
less_than_eq_current	小于等于当前

字段支持的操作符枚举

字段	支持的操作符
自动编号	is、not、contains、not_contains、is_null、is_not_null
单行文本	is、not、contains、not_contains、is_null、is_not_null
多行文本	is、not、contains、not_contains、is_null、is_not_null
单选	is、not、is_any、not_any、is_null、is_not_null
多选	is、not、is_any、not_any、is_null、is_not_null
电话	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
邮箱	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
日期	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
日期时间	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
数字	is、not、greater_than、greater_than_eq、less_than、less_than_eq、is_null、is_not_null
查找型	is、not、is_null、is_not_null
查找员工	is、not、is_null、is_not_null
所有人	is、not、is_null、is_not_null

请求参数

参数	类型	必填	说明
scrollId	整型	否	滚动记录ID Min: 0 , 默认: 0.
pageSize	整型	否	页大小 Min: 1 , Max: 100 , 默认：20.
filterId	整型	是	过滤器ID(特殊过滤器不支持).
objectApiName	字符串	是	对象API_NAME.
judgeStrategy	整型	否	高级公式类型。1: 满足所有条件； 2: 满足任何一个； 3:自定义逻辑。默认:1
customJudgeLogic	字符串	否	高级公式。当judgeStrategy为 3 时，需要设置该字段.
conditionList	数组	否	条件数组.
conditionList[].fieldApiName	字符串	是	字段ApiName.
conditionList[].operator	字符串	是	字段操作符.
conditionList[].value	字符串	否	字段值,如果多个用逗号隔开.

响应数据

标准分页对象分页

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
paging	对象	分页对象.
paging.pageNum	整型	分页页码.
paging.pageSize	整型	分页页大小.
paging.total	整型	分页查询命中总数.
data	数组	业务对象.
data[].id	整型	记录ID.
data[].fieldDataList	数组	字段信息List.
data[].fieldDataList[].fieldApiName	字符串	字段API名称.
data[].fieldDataList[].fieldTypeApiName	字符串	字段API名称.
data[].fieldDataList[].fieldValue	字符串	字段值.
data[].fieldDataList[].foreignDataName	字符串	关联对象记录名称.
data[].fieldDataList[].userEmail	字符串	关联员工邮箱.
data[].fieldDataList[].optionNameList	数组	选项名称列表(选择类型字段).
data[].fieldDataList[].tagValueList	数组	标签字段详细信息(电话或邮箱).
data[].fieldDataList[].tagValueList[].tagName	字符串	标签名称.
data[].fieldDataList[].tagValueList[].tagValue	字符串	标签值.
data[].fieldDataList[].richText	对象	富文本字段详细信息(内容及附件).
data[].fieldDataList[].richText.content	字符串	富文本内容.
data[].fieldDataList[].richText.attachmentList	数组	附件列表.
data[].fieldDataList[].richText.attachmentList[].name	字符串	原始文件名.
data[].fieldDataList[].richText.attachmentList[].docAddress	字符串	外链.
data[].fieldDataList[].richText.attachmentList[].size	整型	大小.
data[].fieldDataList[].ownerResult	对象	所有人.
data[].fieldDataList[].ownerResult.ownerType	整型	所有人类型.
data[].fieldDataList[].ownerResult.ownerName	字符串	所有人名称.
data[].fieldDataList[].signDto	对象	签名信息.
data[].fieldDataList[].signDto.url	字符串	签名图片地址.
data[].fieldDataList[].signDto.time	字符串	签名时间.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/datas/scrollSearch?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -d
{
    "scrollId": 0,
    "pageSize": 20,
    "filterId": 2,
    "objectApiName": "contact",
    "judgeStrategy": 3,
    "customJudgeLogic":"1 or 2 and 3",
    "conditionList": [
        {
            "fieldApiName": "name",
            "operator": "is",
            "value": "test"
        },
        {
            "fieldApiName": "weiyibiaoshi",
            "operator": "contains",
            "value": "13"
        },
         {
             "fieldApiName": "youxiang",
             "operator": "contains_any",
             "value": "test@qq.com"
         }
    ]
}

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 5826,
            "fieldDataList": [
                {
                    "fieldApiName": "name",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "test"
                },
                {
                    "fieldApiName": "calcFormula",
                    "fieldTypeApiName": "field_type_formular",
                    "fieldValue": "15.00"
                },
                {
                    "fieldApiName": "coordinate",
                    "fieldTypeApiName": "field_type_geography",
                    "fieldValue": ""
                }
            ]
        }
    ]
}

查询相关记录列表

GET /v1/data/relatedDatas

此接口查询数据集依赖于界面过滤器，查询到的数据结果集，可保持与界面过滤器排序一致。

请求参数

参数	类型	必填	说明
pageNum	整型	否	页码 Min: 1 , 默认：1.
pageSize	整型	否	页大小 Min: 1 , Max: 100 , 默认：20.
dataId	整型	是	父对象记录ID.
filterId	整型	是	界面过滤器ID.
objectApiName	字符串	是	子对象API_NAME.
parentObjectApiName	字符串	是	父对象API_NAME.

响应数据

标准分页对象分页

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
paging	对象	分页对象.
paging.pageNum	整型	分页页码.
paging.pageSize	整型	分页页大小.
paging.total	整型	分页查询命中总数.
data	数组	业务对象.
data[].id	整型	记录ID.
data[].fieldDataList	数组	字段信息List.
data[].fieldDataList[].fieldApiName	字符串	字段API名称.
data[].fieldDataList[].fieldTypeApiName	字符串	字段API名称.
data[].fieldDataList[].fieldValue	字符串	字段值.
data[].fieldDataList[].foreignDataName	字符串	关联对象记录名称.
data[].fieldDataList[].userEmail	字符串	关联员工邮箱.
data[].fieldDataList[].optionNameList	数组	选项名称列表(选择类型字段).
data[].fieldDataList[].tagValueList	数组	标签字段详细信息(电话或邮箱).
data[].fieldDataList[].tagValueList[].tagName	字符串	标签名称.
data[].fieldDataList[].tagValueList[].tagValue	字符串	标签值.
data[].fieldDataList[].richText	对象	富文本字段详细信息(内容及附件).
data[].fieldDataList[].richText.content	字符串	富文本内容.
data[].fieldDataList[].richText.attachmentList	数组	附件列表.
data[].fieldDataList[].richText.attachmentList[].name	字符串	原始文件名.
data[].fieldDataList[].richText.attachmentList[].docAddress	字符串	外链.
data[].fieldDataList[].richText.attachmentList[].size	整型	大小.
data[].fieldDataList[].ownerResult	对象	所有人.
data[].fieldDataList[].ownerResult.ownerType	整型	所有人类型.
data[].fieldDataList[].ownerResult.ownerName	字符串	所有人名称.
data[].fieldDataList[].signDto	对象	签名信息.
data[].fieldDataList[].signDto.url	字符串	签名图片地址.
data[].fieldDataList[].signDto.time	字符串	签名时间.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data/relatedDatas?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageSize=20&pageNum=1&dataId=213306&filterId=2&objectApiName=contact&parentObjectApiName=case' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 20,
        "total": 1
    },
    "data": [
        {
            "id": 5826,
            "fieldDataList": [
                {
                    "fieldApiName": "name",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "test"
                },
                {
                    "fieldApiName": "zidongbianhao",
                    "fieldTypeApiName": "field_type_auto_number",
                    "fieldValue": "2023-01"
                },
                {
                    "fieldApiName": "coordinate",
                    "fieldTypeApiName": "field_type_geography",
                    "fieldValue": ""
                }
            ]
        }
    ]
}

富文本字段上传附件

POST /v1/data/field/attachments

此接口用于上传富文本字段附件,支持一次上传多个文件,请求体采用multipart/form-data类型.
目前支持:pdf、doc(docx)、xls(xlsx)、ppt(pptx)、txt、png、jpg、jpeg和gif格式文件.

请求参数

参数	类型	必填	说明
id	整型	否	记录ID. 如果ID为空，则objectApiName、uniqueFieldApiName与uniqueFieldValue必填.
objectApiName	字符串	否	记录对象api名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
uniqueFieldApiName	字符串	否	指定外部唯一字段API名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
fieldApiName	字符串	是	字段ApiName名称.

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&id=1234&fieldApiName=description' -i -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F 'file=helloWorld.pdf'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

富文本字段删除附件

PUT /v1/data/field/attachments

此接口用于删除富文本字段记录附件,支持一次删除多个记录富文本字段的多个文件。

请求参数

参数	类型	必填	说明
deleteAttachmentList	数组	是	包含：记录ID、对象API名称、唯一字段API名称、唯一字段值、富文本字段API名称与待删除附件ID数组.
deleteAttachmentList[].dataId	整型	否	记录ID. 如果ID为空，则objectApiName、uniqueFieldApiName与uniqueFieldValue必填.
deleteAttachmentList[].objectApiName	字符串	否	记录对象api名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
deleteAttachmentList[].uniqueFieldApiName	字符串	否	指定外部唯一字段API名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
deleteAttachmentList[].uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
deleteAttachmentList[].richTextFieldApiName	字符串	是	富文本字段ApiName名称.
deleteAttachmentList[].docIdList	字符串数组	否	要删除的附件ID数组.

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	对象	删除结果
data.successList	整型数组	执行成功的记录ID集合
data.failMap	对象	删除失败的数据集合，包括删除失败的原因
data.total	整型	数据总数
data.failTotal	整型	删除失败的数据总数
data.successTotal	整型	删除成功的数据总数

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments?email=1@test.cn&timestamp=1581673901&sign=34e94a54a8c1191df3663aa4168461d58c0fe03c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "deleteAttachmentList" : [ {
    "dataId" : 56643,
    "richTextFieldApiName" : "description",
    "docIdList" : ["361"]
  } ]
}'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "successList" : [],
    "failMap" : {},
    "total" : 1,
    "failTotal" : 0,
    "successTotal" : 1
  }
}

查询富文本字段上传的附件列表

GET /v1/data/field/attachments

此接口查询富文本字段已上传的附件列表

请求参数

参数	类型	必填	说明
id	整型	否	记录ID. 如果ID为空，则objectApiName、uniqueFieldApiName与uniqueFieldValue必填.
objectApiName	字符串	否	记录对象api名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
uniqueFieldApiName	字符串	否	指定外部唯一字段API名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
fieldApiName	字符串	是	字段ApiName名称.

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	数组	业务对象.
data[].docId	字符串	附件ID标识.
data[].name	字符串	附件文件名.
data[].size	字符串	附件大小.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&id=1234&fieldApiName=description' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
  "data" : [ {
    "docId" : "4f6adc8e1866f7dba9cd722c03b78d72",
    "name" : "helloWorld.pdf",
    "size" : 11
  } ]
}

查询富文本字段附件的下载链接

GET /v1/data/field/attachments/url

此接口查询富文本字段附件的下载链接，访问下载链接即可下载附件，注意：下载链接一段时间后会失效，失效后要重新请求该接口获取新的下载链接。

请求参数

参数	类型	必填	说明
id	整型	否	记录ID. 如果ID为空，则objectApiName、uniqueFieldApiName与uniqueFieldValue必填.
objectApiName	字符串	否	记录对象api名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
uniqueFieldApiName	字符串	否	指定外部唯一字段API名称. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果objectApiName、uniqueFieldApiName与uniqueFieldValue为空，则ID必填.
fieldApiName	字符串	是	字段ApiName名称.
docId	字符串	是	附件ID标识，由查询字段上传的附件列表获取.

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	对象	业务对象.
data.docUrl	字符串	下载链接，注意一段时间会失效，失效后需重新请求该接口获取新的下载链接.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments/url?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&id=1234&fieldApiName=description&docId=4f6adc8e1866f7dba9cd722c03b78d72' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
  "data": {
          "docUrl": "https://xxx.xxx.com/url/xxx/helloWorld.pdf"
  }
}

文件上传

POST /v1/data/file/upload

此接口用于上传文件,支持一次上传多个文件,请求体采用multipart/form-data类型.其中key是文件的序号或者唯一标识，返回时使用该标识作为key，value为生成的链接目前支持:pdf、doc(docx)、xls(xlsx)、ppt(pptx)、txt、png、jpg、jpeg和gif格式文件.

请求参数

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	Object	数据
data.urlMap	Object	key为唯一标识，value为生成的链接

请求示例

curl --location --request POST 'https://servicego.udesk.cn/api/v1/data/file/upload?email=1@test.cn&timestamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'a=@/home/user/1/1.png' \
--form 'b=@/home/user/1/2.png'

响应示例

{
    "code": 200,
    "visible": false,
    "data": {
        "urlMap": {
            "a": "https://servicego.udesk.cn/backend/storage/resource/8bfc9fc1-d3c3-4726-a765-6b1d9674c8c5",
            "b": "https://servicego.udesk.cn/backend/storage/resource/ae85940e-fe1f-4a0c-9ffd-d5ea885540de"
        }
    }
}

上传到文件对象

POST /v1/data/file/object

此接口用于上传文件到文件对象,支持一次上传多个文件,请求体采用multipart/form-data类型.其中key是文件的序号或者唯一标识，返回时后使用该标识作为key，value为生成的记录ID 目前支持:pdf、doc(docx)、xls(xlsx)、ppt(pptx)、txt、png、jpg、jpeg、gif、mkv、mp4、avi、swf、wmv、rmvb、mov、mpg格式文件.

请求参数

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	Object	数据
data.idMap	Object	key为唯一标识，value为保存的文件对象ID

请求示例

curl --location --request POST 'https://servicego.udesk.cn/api/v1/data/file/object?email=1@test.cn&timestamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'a=@/home/user/1/1.png' \
--form 'b=@/home/user/1/2.png'

响应示例

{
    "code": 200,
    "visible": false,
    "data": {
        "idMap": {
            "a": 58342,
            "b": 58341
        }
    }
}

关联文件对象到记录附件组件

POST /v1/data/file/relate

此接口用于文件对象关联到指定对象的某个记录的附件组件上

请求参数

属性名	类型	必填	说明
fileId	整型	是	文件对象ID
relateObjectApiName	字符串	是	目标对象api名称
relateDataId	整型	否	目标记录ID. 如果ID为空则uniqueFieldApiName与uniqueFieldValue必填
uniqueFieldApiName	字符串	否	指定外部唯一字段API名称. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
tag	字符串	否	附件标签

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .

请求示例

curl --location --request POST 'https://servicego.udesk.cn/api/v1/data/file/relate?email={{account}}&timestamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileId": 1,
    "relateObjectApiName": "case",
    "relateDataId":2
}'

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false
}

查询记录附件组件

GET /v1/data/file/relate

此接口用于查询记录附件组件中的组件列表信息.

请求参数

参数	类型	必填	说明
objectApiName	字符串	否	对象API_NAME. 使用唯一字段查询时，必填
id	整型	否	记录ID. 如果ID为空，则uniqueFieldApiName与uniqueFieldValue必填
uniqueFieldApiName	字符串	否	外部唯一字段API名称. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填
uniqueFieldValue	字符串	否	uniqueFieldApiName对应的外部唯一字段值. 如果uniqueFieldApiName与uniqueFieldValue为空，则ID必填

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data[]	Object	数据
data[].name	字符串	文件名称
data[].size	整型	文件大小
data[].url	字符串	文件访问链接

请求示例

curl --location --request GET 'https://servicego.udesk.cn/api/v1/data/file/relate?email=1@test.cn&timestamp={{timestamp}}&sign={{sign}}&id=57054' \
--header 'Content-Type: application/json'

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 2
    },
    "data": [
        {
            "name": "产品.png",
            "size": 8847,
            "url": "https://servicego.udesk.cn/backend/storage/resource?req=1194"
        },
        {
            "name": "产品.png",
            "size": 8847,
            "url": "https://servicego.udesk.cn/backend/storage/resource?req=1195"
        }
    ]
}

创建关联关系

POST /v1/record/{majorDataId:^[1-9]\\d*$}

嵌入请求参数

参数	类型	必填	说明	限制
majorDataId	整型	是	主记录Id	必须大于1

请求参数

参数	类型	必填	说明
objectRelationId	整型	是	关联关系类型Id.
relatedDataIdList	整型数组	是	关联关系记录id集合.

响应数据

属性名	类型	说明
code	整型	响应编码.
visible	布尔型	是否可见, true / false .
data	字符串	响应消息.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/record/435033?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "objectRelationId": 8,
    "relatedDataIdList": [431048,430909]
}'

响应示例

{
    "code": 200,
    "visible": false,
    "data": "ok"
}

删除关联关系

DELETE /v1/selfObjectRelationData

请求参数

参数	类型	必填	说明
majorDataId	整型	是	主记录Id.
relateDataId	整型	是	关联关系记录id.

响应数据

属性名	类型	说明
code	整型	响应编码.
visible	布尔型	是否可见, true / false .
data	字符串	响应消息.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/selfObjectRelationData?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&majorDataId=430906&relateDataId=435033' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
    "code": 200,
    "visible": false,
    "data": "ok"
}

查询关联关系

GET /v1/selfObjectRelationData

请求参数

参数	类型	必填	说明
majorDataId	整型	是	主记录Id.
uiId	整型	是	界面id.
pageNum	整型	是	分页页码.
pageSize	整型	是	分页页大小.

响应数据

属性名	类型	说明
code	整型	响应编码.
visible	布尔型	是否可见, true / false .
data	Object	数据.
data.total	整型	关联记录数量.
data.pageNum	整型	分页页码.
data.pageSize	整型	分页页大小.
data.showFieldList	数组	展示的字段集合.
data.showFieldList[].id	整型	字段id.
data.showFieldList[].label	字符串	字段名称.
data.showFieldList[].fieldName	字符串	字段api名称.
data.showFieldList[].fieldType	整型	字段类型.
data.fieldDataList	数组	记录的数据集合.
data.fieldDataList[].dataId	整型	记录Id.
data.fieldDataList[].dataName	字符串	主字段名称.
data.fieldDataList[].relationId	整型	关联关系类型Id.
data.fieldDataList[].relationName	字符串	关联关系类型名称.
data.fieldDataList[].fieldValueMap	Map集合	key:字段id,value:字段值.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/selfObjectRelationData?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageNum=1&pageSize=20&majorDataId=435033&uiId=4809' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
    "code": 200,
    "visible": false,
    "data": {
        "showFieldList": [
            {
                "id": 4184,
                "label": "编号",
                "fieldName": "bianhao",
                "fieldType": 16
            },
            {
                "id": 4314,
                "label": "省",
                "fieldName": "province",
                "fieldType": 14
            },
            {
                "id": 6390,
                "label": "电话",
                "fieldName": "dianhua",
                "fieldType": 10
            }
        ],
        "total": 4,
        "pageNum": 1,
        "pageSize": 20,
        "fieldDataList": [
            {
                "dataId": 430907,
                "dataName": "测试1-6-8",
                "relationId": 8,
                "relationName": "巨量",
                "fieldValueMap": {
                    "4184": "01-06-003"
                }
            },
            {
                "dataId": 430909,
                "dataName": "#819",
                "relationId": 8,
                "relationName": "巨量",
                "fieldValueMap": {
                    "4184": "7165"
                }
            }
        ]
    }
}

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search