调用外部接口的触发数据结构

2022-04-06 更新
101 次浏览

功能简介

在工作流“调用外部接口”的执行操作中,如选择向指定的接口POST数据,则可选将“当前触发数据的全部信息”提交给接口。可运用于将伙伴云与外部应用进行打通。

数据结构

提交的数据结构如下:

{

"user\_id": 11012,

"table": {

"table\_id": 12345678,

"name": "表格名称",

"icon": {

"id": "6aa",

"color": "d",

"rgb": "#26A69A"

},

"item\_name": "数据名称"

},

"item": {

"item\_id": 2300001001001000,

"table\_id": 12345678,

"created\_on": "2021-04-15 10:30:23",

"updated\_on": "2021-04-15 10:34:07",

"last\_activity\_on": "2021-04-15 10:34:07"

"created\_by": {

"user\_id": 10000,

"name": "姓名",

"avatar": "https://hb-v4-public-img.huoban.com/user\_avatar/10000/0@128w\_128h\_1l",

"phone": "18612345678",

"email": "",

"name\_conf": {

"type": "real"

}

},

"updated\_by": {

"user\_id": 10000,

"name": "姓名",

"avatar": "https://hb-v4-public-img.huoban.com/user\_avatar/10000/0@128w\_128h\_1l",

"phone": "18612345678",

"email": "",

"name\_conf": {

"type": "real"

}

},

"created\_by\_union\_id": null,

"created\_by\_wechat\_nickname": null,

"title": "数据标题",

"summary": "",

"fields": \[

{

"alias": "",

"field\_id": 10000001,

"type": "text",

"values": \[

{

"value": "文本内容\\n文本内容",

"display\_value": "文本内容<br&文本内容"

}

\],

},

{

"alias": "",

"field\_id": 10000002,

"type": "number",

"values": \[

{

"value": 234.56

}

\],

},

{

"alias": "",

"field\_id": 10000003,

"type": "date",

"values": \[

{

"value": "2021-04-15 10:30"

}

\],

},

{

"alias": "",

"field\_id": 10000004,

"type": "calculation",

"values": \[

{

"value": 246.91

}

\],

},

{

"alias": "",

"field\_id": 10000005,

"type": "calculation",

"values": \[

{

"value": "2021-04-25 20:40"

}

\],

},

{

"alias": "",

"field\_id": 10000006,

"type": "category",

"values": \[

{

"status": "active",

"name": "A",

"id": 1,

"color": "h"

},

{

"status": "active",

"name": "B",

"id": 2,

"color": "e"

}

\],

},

{

"alias": "",

"field\_id": 10000007,

"type": "user",

"values": \[

{

"user\_id": 11012,

"name": "吴杨",

"avatar": "https://hb-v4-public-img.huoban.com/user\_avatar/4491474/0@128w\_128h\_1l",

"name\_conf": {

"type": "real"

}

}

\],

}

\],

},

"old\_item": {

...

}

}
字段名 说明
user_id 触发用户ID
table 数据所属表格
├ table.table_id 表格ID
├ table.name 表格名称,如“客户管理”
├ table.icon 表格图标
├ table.icon.id 表格图标的ID,对应 appicon 字体文件的文字编码
├ table.icon.color 表格图标颜色编号
└ table.icon.rgb 表格图标颜色的HEX色值,如“#26A69A”
└ table.item_name 表格数据名称,如“客户”
item 当前数据
├ item.item_id 数据ID
├ item.table_id 所属表格ID
├ item.created_on 创建时间,格式为“YYYY-MM-DD HH:ii:ss”
├ item.updated_on 修改时间,格式为“YYYY-MM-DD HH:ii:ss”
├ item.last_activity_on 最后活动时间(修改时间+最后评论时间),格式为“YYYY-MM-DD HH:ii:ss”
├ item.created_by 创建人(用户对象)
├ item.created_by.user_id 用户ID
├ item.created_by.name 用户名称
├ item.created_by.avatar 用户头像链接
├ item.created_by.phone 用户手机号
├ item.created_by.email 用户邮箱
└ item.created_by.name_conf.type 用户姓名是否为真实名称,real 表示真实名称,virtual 表示不具有可读性的虚拟名称
├ item.updated_by 修改人(用户对象,不再赘述)
├ item.created_by_union_id 创建人为微信用户时,提供该微信用户基于伙伴云开放平台的union_id
├ item.created_by_wechat_nickname 创建人为微信用户时,提供该微信用户的昵称
├ item.title 数据标题,根据表格“自定义标题设置”,返回第一个字段或多字段拼接而成的标题
├ item.summary 数据摘要,根据表格“移动端列表设置”,返回多字段拼接而成的摘要
├ item.fields[] 数据字段值列表
├ item.fields[].alias 字段别名,可在工作区中设置
├ item.fields[].field_id 字段ID
├ item.fields[].type 字段类型:text 文本,number 数字,date 日期,calculation 计算(实际返回值为数字或日期类型),category 选项,user 用户,relation 关联,location 位置,signature 签名,image 图片,file 文件
├ item.fields[].values[] 字段值
├ item.fields[].values['text'] 文本
├ item.fields[].values[].value 文本内容,多行文本会使用“\n”作为换行,富文本中会带有HTML标签
└ item.fields[].values[].display_value 文本内容,多行文本会使用“<br&”作为换行,富文本中会带有HTML标签
├ item.fields[].values['number'] 数字
└ item.fields[].values[].value 数字的数值,百分比会转成小数显示
├ item.fields[].values['date'] 日期
└ item.fields[].values[].value 日期的值,格式为“YYYY-MM-DD HH:ii”或“YYYY-MM-DD”
├ item.fields[].values['category'] 选项
├ item.fields[].values[].name 已选选项名称
├ item.fields[].values[].id 已选选项ID,字段内唯一
└ item.fields[].values[].color 已选选项颜色ID
├ item.fields[].values['user'] 用户
├ item.fields[].values[].user_id 已选用户ID
├ item.fields[].values[].name 已选用户名称
├ item.fields[].values[].avatar 已选用户头像链接
└ item.fields[].values[].name_conf.type 已选用户姓名是否为真实名称
├ item.fields[].values['relation'] 关联
├ item.fields[].values[].item_id 已选数据ID
├ item.fields[].values[].table_id 已选数据所属表格ID
└ item.fields[].values[].title 已选数据标题
├ item.fields[].values['location'] 位置
├ item.fields[].values[].value.adcode 位置编号
├ item.fields[].values[].value.address 地址
├ item.fields[].values[].value.city 城市
├ item.fields[].values[].value.citycode 城市编号
├ item.fields[].values[].value.name 地址全称:兴趣点名称+地址
├ item.fields[].values[].value.poi 兴趣点名称
├ item.fields[].values[].value.coordinate.lat 经度
└ item.fields[].values[].value.coordinate.lon 纬度
├ item.fields[].values['signature'] 签名
├ item.fields[].values[].file 签名图片文件(文件对象)
├ item.fields[].values[].file.created_by 创建人(用户对象)
├ item.fields[].values[].file.created_on 创建时间,格式为“YYYY-MM-DD HH:ii:ss”
├ item.fields[].values[].file.file_id 文件ID
├ item.fields[].values[].file.name 文件名
├ item.fields[].values[].file.size 文件大小,单位:B
└ item.fields[].values[].file.link 文件链接,30分钟内有效,提供5种尺寸:large 等比最大 1000 × 3000,medium 等比最大 540 × 3000,small 等比最大 120 × 120,square 方形最大 320 × 320,source 原图
├ item.fields[].values[].time 签名时间,格式为“YYYY-MM-DD HH:ii:ss”
└ item.fields[].values[].user 签名用户
├ item.fields[].values[].user.user_id 签名用户ID
├ item.fields[].values[].user.name 签名用户名称
├ item.fields[].values[].user.avatar 签名用户头像链接
└ item.fields[].values[].user.name_conf.type 签名用户姓名是否为真实名称
└ item.fields[].values['file'] 文件(文件对象)
├ item.fields[].values[].created_by 创建人(用户对象)
├ item.fields[].values[].created_on 创建时间,格式为“YYYY-MM-DD HH:ii:ss”
├ item.fields[].values[].file_id 文件ID
├ item.fields[].values[].name 文件名
├ item.fields[].values[].size 文件大小,单位:B
└ item.fields[].values[].link 文件链接,30分钟内有效,非图片只提供 source 原文件
old_item 修改前的数据,仅修改数据触发会提供,结构同“item”一样
0 0