添加数据：openAPI和QS被动字段传值详解

问题描述

在调用openAPI添加数据接口或者QS被动接口添加数据时，会常常遇到有些字段不清楚如何传，比如附件上传字段（传单个如何传，传多个如何传）。

文档作用

对于两个接口中，对于每一个字段做单独拆解，会详细说明如何传值。

接口详解

openAPI添加数据接口

具体接口文档说明：添加应用数据accessToken获取方式获取路径：【轻商城】——【插件中心】——【第三方连接】——「openapi」超级管理员accessToken：拥有工作区创建者权限，可以调用除「code登录接口」外所有openAPI接口。可直接在轻流系统中获取，如下：子管理员accessToken：子管理员accessToken拥有对应子管理员的权限，能调用这个子管理员权限内可调用的接口。获取方式为：首先生成关联子管理员权限secret（如下图），再通过接口，由wsid（下文有详解）和secret获取。重置secret会让已获取过的accessToken失效。appkey获取方式appkey应用id，点击某应用，即可在链接地址中获取，如下图：也可以在应用基本信息中获得（下图）queid获取方式方式1、通过调用获取应用表单信息接口获取应用表单信息接口方式2、通过后台开发者工具去获取，打开浏览器按Fn+12 点击network，然后清除数据safari获取方式 点击打开某条数据，然后点击该条数据的applyid,在预览中找到到该字段的queidGoogle获取方式 通过后台开发者工具去获取，打开浏览器按Fn+12，点击network，然后清除数据点击打开某条数据，然后点击该条数据的applyid,在response中找到到该字段的queid方式3、直接发起一条数据，然后在右侧的apply，右击拷贝为curl，导入到postman中

• 接口所有添加的字段信息都是放在answers数组中，每一个字段都是一个对象，字段之间用逗号分隔

{
    "answers": [
        {
            "queId": 123456,
            "queType": 2, //单行文字字段
            "values": [
                {
                    "value": ""
                }
            ]
        },
        {
            "queId": 34567,
            "queType": 2, //单行文字字段
            "values": [
                {
                    "value": ""
                }
            ]
        }
    ]
}

单行文字

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

注意：单行文字字符上限300字符

{
    "queId": 123456,
    "queType": 2, //单行文字字段
    "values": [
        {
            "value": "单行文字"
        }
    ]
}

多行文字

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

注意：单行文字字符上限5000字符

{
    "queId": 287193939,
    "queType": 3,//多行文字字段
    "values": [
        {
            "value": "多行文字"
        }
    ]
}

数字

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

注意：需要注意传入数字格式和表单设置是否一致。

{
    "queId": 287193940,
    "queType": 8,//数字字段
    "values": [
        {
            "value": "1"
        }
    ]
}

链接

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193941,
    "queType": 9,//链接字段
    "values": [
        {
            "value": "https://qingflow.com"
        }
    ]
}

日期

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

注意：需要注意传入日期格式和轻流格式是否一致。

{
    "queId": 287193942,
    "queType": 4,//日期字段
    "values": [
        {
            "value": "2024-10-15 00:00:00"
        }
    ]
}

起止时间

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193943,
    "queType": 14,//起止时间字段
    "values": [
        {
            "value": "2024-10-15 00:00:00~2024-10-31 00:00:00"
        }
    ]
}

电话

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193944,
    "queType": 7,//电话字段
    "values": [
        {
            "value": "18*****7018"
        }
    ]
}

邮箱

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193945,
    "queType": 6,//邮箱字段
    "values": [
        {
            "value": "18556137018@163.com"
        }
    ]
}

单项选择

单值字段，values数组仅有一个对象，id和value任意其中一个传入即可，id需要传入对应的选项id，value需要传入选项值

{
    "queId": 287193946,
    "queType": 10,//单项选择字段
    "values": [
        {
            "id": 104381596,
            "value": "未命名1"
        }
    ]
}

下拉选择

单值字段，values数组仅有一个对象，id和value任意其中一个传入即可，id需要传入对应的选项id，value需要传入选项值

{
    "queId": 287193947,
    "queType": 11,//下拉选择字段
    "values": [
        {
            "id": 104381600,
            "value": "未命名2"
        }
    ]
}

多项选择

多值字段，values数组有多个对象，每个对象中id和value任意其中一个传入即可，id需要传入对应的选项id，value需要传入选项值

{
    "queId": 287193948,
    "queType": 12,//多项选择字段
    "values": [
        {
            "id": 104381602,
            "value": "未命名1"
        },
        {
            "id": 104381603,
            "value": "未命名2"
        }
    ]
}

图片选择

多值字段，values数组有多个对象，每个对象中id和value任意其中一个传入即可，id需要传入对应的选项id，value需要传入选项值

{
    "queId": 287193949,
    "queType": 15,//图片选择字段
    "values": [
        {
            "id": 104381605,
            "value": "未命名1"
        },
        {
            "id": 104381606,
            "value": "未命名2"
        },
        {
            "id": 104381607,
            "value": "未命名3"
        }
    ]
}

附件上传

多值字段，values数组有多个对象，每个对象中有value和otherInfo，

其中value需要必传，需要传入上传文件的URL链接，需要是轻流服务可以进行正常访问的URL链接，比如公有云环境需要传入公有读的链接。

otherInfo可以选择传，otherInfo表示上传文件的文件名，不传入，文件名会是以乱码展示。

{
    "queId": 287193950,
    "queType": 13,//附件上传字段
    "values": [
        {
            "value": "https://file.qingflow.com/documents/data/invite/8ncvlohjdc021273BCC/c144e495c4ac82503e7.png",
            "otherInfo": "L2认证证书-1.png"
        },
        {
            "value": "https://file.qingflow.com/documents/data/invite/8ncvlohjdc021273BCC/a34545cfa70a144.png",
            "otherInfo": "L2认证证书-2.png"
        }
    ]
}

地址字段

多值字段，values数组有多个对象，每个对象中传入value即可

{
    "queId": 287193951,
    "queType": 21,//地址字段
    "values": [
        {
            "value": "北京市"
        },
        {
            "value": "北京市"
        },
        {
            "value": "西城区"
        },
        {
            "value": "1111"
        }
    ]
}

富文本

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193953,
    "queType": 16,//富文本字段
    "values": [
        {
            "value": "<p>富文本</p>"
        }
    ]
}

表格

数组多值字段，传入值传入tableValues数组中的每一个数组中，其中每一个数组代表表格的一行，然后表格中的子字段按照上述字段传入规则传入。

{
    "queId": 287193955,
    "queType": 18,//表格字段
    "tableValues": [
        [
            {
                "queId": 287193956,
                "queType": 2,
                "values": [
                    {
                        "value": "表格单行文字"
                    }
                ]
            },
            {
                "queId": 287193957,
                "queType": 2,
                "values": [
                    {
                        "value": "表格单行文字2"
                    }
                ]
            }
        ],
        [
            {
                "queId": 287193956,
                "queType": 2,
                "values": [
                    {
                        "value": "表格单行文字3"
                    }
                ]
            },
            {
                "queId": 287193957,
                "queType": 2,
                "values": [
                    {
                        "value": "表格单行文字4"
                    }
                ]
            }
        ]
        
    ]
}

定位

单值字段，传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193958,
    "queType": 17,//定位字段
    "values": [
        {
            "value": "北京市北京市西城区1111"
        }
    ]
}

数据关联

传入值传入values数组中的value中，values数组仅有一个对象

{
    "queId": 287193959,
    "queType": 19,//数据关联
    "values": [
        {
            "value": "李四"
        }
    ]
}

引用

多值字段，values数组有多个对象，每个对象中传入applyId即可，applyId为引用应用中的数据ID

{
    "queId": 287193960,
    "queType": 25,//引用字段
    "referValues": [
        {
            "applyId": 452167458
        },
        {
            "applyId": 452167104
        }
    ]
}

成员

多值字段，values数组有多个对象，每个对象中id和optionId任意其中一个传入即可，id和optionId都传入成员在通讯录中的userid。如果遇到传id或者传optionId都不行，麻烦联系轻流技术支持。

{
    "queId": 287193961,
    "queType": 5,//成员字段
    "values": [
        {
            "id": 754667,
            "optionId": "754667"
        },
        {
            "id": 1692729,
            "optionId": "1692729"
        }
    ]
}

部门

多值字段，values数组有多个对象，每个对象中有id和otherInfo，

其中id需要必传，需要传入上传部门的部门ID。

otherInfo可以选择传，otherInfo表示上传部门的部门图标和父部门的名称。

{
    "queId": 287193962,
    "queType": 22,//部门字段
    "values": [
        {
            "id": 201623,
            "otherInfo": "{\"deptIcon\":\"\",\"parentDeptNames\":[\"g\",\"f\",\"333\",\"222\",\"1111\",\"部门142\"]}"
        },
        {
            "id": 137816,
            "otherInfo": "{\"deptIcon\":\"\",\"parentDeptNames\":[\"传递测试\"]}"
        }
    ]
}

QS被动接口

QS被动仅仅是用于接收第三方系统推送过来的JSON格式的数据。所以不存在对于参数名称的要求限制。

这里我参数名就定义为value

单行文字

单值字段，直接传入value中即可，不要超过300字符。

{
  "value":"单行文字值"
}

多行文字

单值字段，直接传入value中即可，不要超过5000字符。

{
  "value":"多行文字值"
}

数字

单值字段，直接传入value中即可。

注意：需要注意传入数字格式和表单设置是否一致。

{
  "value":"9"
}

或者

{
  "value":9
}

链接

单值字段，直接传入value中即可。

{
  "value":"https://qingflow.com"
}

日期

单值字段，直接传入value中即可。

注意：需要注意传入日期格式和轻流格式是否一致。

{
  "value":"2024-10-15 00:00:00"
}

起止时间

单值字段，直接传入value中即可。

{
  "value":"2024-10-15 00:00:00~2024-10-31 00:00:00"
}

电话

单值字段，直接传入value中即可。

{
  "value":"18766*******"
}

邮箱

单值字段，直接传入value中即可。

{
  "value":"18766*****@163.com"
}

单项选择

单值字段，直接传入value中即可。

{
  "value":"未命名1"
}

下拉选择

单值字段，直接传入value中即可。

{
  "value":"未命名1"
}

多项选择

多值字段，value传入数组格式即可。

{
  "value":[
    "未命名1",
    "未命名2"
  ]
}

图片选择

多值字段，value传入数组格式即可。

{
  "value":[
    "未命名1",
    "未命名2"
  ]
}

附件上传

如果传单个附件，以字符串格式或者以数组格式传入均可，如果多个附件，value传入数组格式即可。

{
  "value":"https://file.qingflow.com/documents/data/invite/8ncvlohjdc021273BCC/c144e495c4ac82503e7.png"
}

{
  "value":[
    "https://file.qingflow.com/documents/data/invite/8ncvlohjdc021273BCC/c144e495c4ac82503e7.png",
    "https://file.qingflow.com/documents/data/invite/8ncvlohjdc021273BCC/c144e495c4ac.png"
  ]
}

地址字段

单值字段，直接传入value中即可。中间需要用空格分隔

{
    "value": "北京市 北京市 西城区 1111"
}

富文本

不支持传

表格

数组多值字段，value传入数组格式，并且每一个对象代表表格一行。

{
    "value":[
        {
            "字段1":"",
            "字段2":""
        },
        {
            "字段1":"",
            "字段2":""
        }
    ]
}

定位

不支持传

数据关联

单值字段，直接传入value中即可。

注意：如果传入值不在数据关联选项中，会强制传入。

如果传入值不在数据关联选项中，但是数据关联字段开启了提交重计算，会默认将关联的第一个值填充进去。

{
    "value": "数据关联值"
}

引用

不支持传

成员

如果传单个成员，以字符串格式或者以数组格式传入均可，如果多个成员，value传入数组格式即可。

传入格式需要为成员邮箱。

申请人也需要传入成员邮箱。

{
    "value": "zhang11@163.com"
}

{
    "value":[
      "zhang11@163.com",
      "wang22@163.com"
    ]
}

部门

如果传单个部门，以字符串格式或者以数组格式传入均可，如果多个部门，value传入数组格式即可。

传入格式需要为部门名称。

如果通讯录存在部门重名情况，会全部添加到字段中。建议使用openAPI进行添加部门。

{
    "value":"部门142"
}

{
    "value": [
        "部门142",
        "传递测试"
    ]
}