查询外联盟字段ID - 尘锋SCRM开放平台

POST https://qw-openapi-tx.dustess.com/external_partner/fieldList?accessToken=

Content-Type: application/json

接口限制:每分钟调用600次;

Query:

字段	类型	描述	是否必须
accessToken	`String`	accessToken	是

成功响应:

响应参数名	类型	说明
success	`Bool`	请求状态，true:成功，false:失败
code	`Int`	响应代码，错误时存在
msg	`String`	消息提示
data	`Object`	数据信息
data.udf	`Object[]`	自定义字段
data.udf.column_name	`String`	字段业务ID，新增编辑时使用该ID对字段进行操作
data.udf.column_type	`String`	字段类型：string 单行文本；float 数字；datetime 日期时间；date 日期；text 多行文本；single_choice 单选项；multiple_choice 多选项；file 附件；single_cascader 多级联选-单选；multiple_cascader 多级联选-多选
data.udf.column_name_full	`String`	字段显示名称
data.udf.column_description	`String`	提示文案
data.udf.column_required	`Bool`	是否启用, true: 必填, false: 非必填
data.udf.column_indexed	`Bool`	是否索引, true: 启用, false: 未启用
data.udf.column_is_del	`Bool`	是否被删除, true: 已删除, false: 未删除
data.udf.column_closed	`Bool`	是否被停用, true: 已停用, false: 未停用
data.udf.column_verify_rule	`String`	校验规则
data.udf.column_order	`Int`	模版中字段排序位置
data.udf.column_field_enums	`Object[]`	单选/多选字段选项
data.udf.column_field_enums.enum_name	`String`	选项显示名称
data.udf.column_field_enums.enum_value	`String`	选项ID，编辑存储时传递
data.udf.column_field_enums.is_del	`Bool`	选项是否被删除, true: 已删除, false: 未删除
data.udf.column_type_constraint	`Map[String]Object`	字段约束
data.udf.column_type_constraint.multiple_cascader	`Map[String]Object`	字段约束-多级联选多选相关约束
data.udf.column_type_constraint.multiple_cascader.parent_can_select	`Bool`	字段约束-多级联选多选父级是否可选父级, true: 可选父级, false/或字段key不存在: 仅选最后一级
data.udf.column_type_constraint.multiple_cascader	`Map[String]Object`	字段约束-多级联选单选相关约束
data.udf.column_type_constraint.single_cascader.parent_can_select	`Bool`	字段约束-多级联选单选父级是否可选父级, true: 可选父级, false/或字段key不存在: 仅选最后一级

成功响应示例:

{
    "success": true,
    "msg": "",
    "trace_id": "2f8d9734-a77a-907d-8077-2b4d147ff2b0",
    "data": {
        "udf": [
            {
                "columnName": "6adpqc-ll4uqr23",
                "columnType": "string",
                "columnNameFull": "lys1-单行文本",
                "columnTypeConstraint": {}
            },
            {
                "columnName": "pj67io-ll4uqr23",
                "columnType": "text",
                "columnNameFull": "lys1-多行文本",
                "columnOrder": 1,
                "columnTypeConstraint": {}
            },
            {
                "columnName": "ytwhyh-ll4uqr23",
                "columnType": "float",
                "columnNameFull": "lys1-数字",
                "columnOrder": 2,
                "columnTypeConstraint": {
                    "float": {
                        "type": "no_limit"
                    }
                }
            },
            {
                "columnName": "wbwsja-ll4uqr23",
                "columnType": "single_choice",
                "columnNameFull": "lys1-单选项",
                "columnOrder": 3,
                "columnFieldEnums": [
                    {
                        "name": "选项1",
                        "value": "1"
                    },
                    {
                        "name": "选项2",
                        "value": "2"
                    },
                    {
                        "name": "选项3",
                        "value": "3"
                    }
                ],
                "columnTypeConstraint": {}
            },
            {
                "columnName": "2rph93-ll4uqr23",
                "columnType": "multiple_choice",
                "columnNameFull": "lys1-多选项",
                "columnRequired": true,
                "columnOrder": 4,
                "columnFieldEnums": [
                    {
                        "name": "选项1",
                        "value": "1"
                    },
                    {
                        "name": "选项2",
                        "value": "2"
                    },
                    {
                        "name": "选项3",
                        "value": "3"
                    }
                ],
                "columnTypeConstraint": {}
            },
            {
                "columnName": "tqlcsb-ll4uqr23",
                "columnType": "date",
                "columnNameFull": "lys1-日期",
                "columnOrder": 5,
                "columnTypeConstraint": {}
            },
            {
                "columnName": "mzoc7c-ll4uqr23",
                "columnType": "datetime",
                "columnNameFull": "lys1-日期时间",
                "columnOrder": 6,
                "columnTypeConstraint": {
                    "datetime": {
                        "type": "yyyy-MM-dd HH:mm"
                    }
                }
            },
            {
                "columnName": "d2v12d-ll4uqr23",
                "columnType": "file",
                "columnNameFull": "lys1-附件",
                "columnOrder": 7,
                "columnTypeConstraint": {}
            },
            {
                "columnName": "yanyve-ll4uqr23",
                "columnType": "single_cascader",
                "columnNameFull": "lys1-级联-单选",
                "columnOrder": 8,
                "columnTypeConstraint": {
                    "single_cascader": {}
                }
            },
            {
                "columnName": "dum07u-ll4uqr23",
                "columnType": "multiple_cascader",
                "columnNameFull": "lys1-级联-多选",
                "columnOrder": 9,
                "columnTypeConstraint": {
                    "multiple_cascader": {}
                }
            }
        ]
    }
}