public api 卡片导出 - 观远数据开放平台

接口简介

通过指定卡片，筛选条件生成卡片导出任务

筛选器参考 filter 说明. 其他都是不同类型的筛选器.

请求参数

Body 参数application/json

cdId

string

卡片ID

必需

typeOp

enum<string>

必需

typeOp： PIVOT: 表格数据 EXCEL: excel �CSV: csv

枚举值:

PIVOTEXCELCSV

token

string

应用Token

必需

应用token

loginId

string

用户登录账号

必需

filters

array [object {8}]

普通筛选器

可选

name

string

字段名称

可选

fdId

string

字段id

可选

dsId

string

数据集id

可选

cdId

string

筛选器卡片id

可选

fdType

string

字段类型

可选

filterType

enum<string>

过滤类型

可选

枚举值:

GTGELTLEEQNEINNISTARTSWITHNOT_STARTSWITHENDSWITHNOT_ENDSWITHCONTAINSNOT_CONTAINSIS_NULLNOT_NULL

sourceCdId

string

可选

filterValue

array[string]

过滤值

可选

treeFilters

array [object {5}]

可选

树状筛选器, 字段含义详细参考普通筛选器, 有问题找对应研发

cdId

string

可选

filterType

string

可选

fields

array [object {5}]

可选

values

array [array]

可选

sourceCdId

string

可选

dynamicParams

array [object {9}]

可选

参数筛选器, 字段含义详细参考普通筛选器, 有问题找对应研发

dpId

string

可选

name

string

可选

valueType

string

可选

defaultValue

string

可选

customize

boolean

可选

multiple

boolean

可选

optionValue

array[string]

可选

inheritParent

boolean

可选

sourceCdId

string

可选

combinationFilters

array [object {3}]

可选

组合筛选器, 字段含义详细参考普通筛选器, 有问题找对应研发

condition

array [object {2}]

可选

sourceCdId

string

可选

name

string

可选

dynamicFieldFilters

array [object {3}]

可选

动态维度, 动态数值, 字段含义详细参考普通筛选器, 有问题找对应研发

key

string

必需

sourceCdId

string

必需

dzId

string

必需

saveFilters

boolean

是否保存筛选条件

可选

drillFilters

array [object {8}]

可选

下钻筛选条件, 字段含义详细参考普通筛选器, 有问题找对应研发

fdId

string

可选

fdType

string

可选

name

string

可选

alias

null

可选

granularity

null

可选

parentFdName

null

可选

filterType

string

可选

filterValue

array[string]

可选

childTreeFilters

array [object {2}]

可选

子视图数据筛选-, 字段含义详细参考普通筛选器, 有问题找对应研发

cdId

string

子视图卡片ID

必需

treeFilters

array [object {5}]

树状筛选器

可选

childCombinationFilters

array [object {2}]

可选

子视图数据筛选-, 字段含义详细参考普通筛选器, 有问题找对应研发

cdId

string

子视图卡片ID

必需

combinationFilters

array [object {3}]

组合筛选器

可选

childFilters

array [object {2}]

可选

子视图数据筛选-, 字段含义详细参考普通筛选器, 有问题找对应研发

cdId

string

子视图卡片ID

必需

filters

array [object {8}]

普通筛选器

必需

headerSortings

array [object {5}]

可选

表头排序-需要配合页面点击使用, 可以不传使用默认即可

zoneId

string

可选

sortField

string

排序字段

可选

mIndex

integer

排序的数值idx

可选

index

integer

可选

order

string

可选

示例

{
    "cdId": "44",
    "typeOp": "pivot",
    "token": "in do incididunt Excepteur eiusmod",
    "loginId": "23",
    "filters": [
        {
            "name": "大区",
            "fdId": "c2bde870290b74630ab53fb9",
            "dsId": "s4912f495dd134e5fbd77407",
            "cdId": "lb800995dd291414d9a2adbd",
            "fdType": "STRING",
            "filterType": "IN",
            "sourceCdId": "m0cd9c39fa89d475cb56f1b5",
            "filterValue": [
                "其它"
            ]
        }
    ],
    "treeFilters": [
        {
            "cdId": "45",
            "filterType": "enim Ut ullamco",
            "fields": [
                {
                    "name": "识却导点有越",
                    "fdId": "66",
                    "dsId": "61",
                    "cdId": "55",
                    "fdType": "non Excepteur"
                },
                {
                    "name": "消众起装家酸",
                    "fdId": "7",
                    "dsId": "15",
                    "cdId": "59",
                    "fdType": "et tempor ad reprehenderit dolore"
                }
            ],
            "values": [
                [
                    "anim"
                ],
                [
                    "dolor nisi eu deserunt",
                    "deserunt incididunt minim"
                ],
                [
                    "labore dolore ut non"
                ]
            ],
            "sourceCdId": "53"
        }
    ],
    "dynamicParams": [
        {
            "dpId": "35",
            "name": "水千飞实这",
            "valueType": "voluptate nulla velit est dolor",
            "defaultValue": "exercitation quis et",
            "customize": false,
            "multiple": false,
            "optionValue": [
                "adipisicing labore reprehenderit fugiat cillum"
            ],
            "inheritParent": true,
            "sourceCdId": "41"
        }
    ],
    "combinationFilters": [
        {
            "condition": [
                {
                    "type": "Excepteur pariatur ullamco",
                    "value": [
                        {
                            "id": "44",
                            "type": "proident velit adipisicing ut",
                            "parentId": "89",
                            "value": {
                                "name": "种政达总件今",
                                "fdType": "laboris velit sed eiusmod commodo",
                                "dsId": "28",
                                "fdId": "91",
                                "metaType": "id anim laboris",
                                "seqNo": 16,
                                "isAggregated": true,
                                "calculationType": "sed dolor irure",
                                "level": "culpa proident",
                                "annotation": "anim consectetur occaecat irure laboris",
                                "isDetectionSensitive": true,
                                "isSensitive": false,
                                "filterType": "proident sunt mollit quis",
                                "filterValue": [
                                    "do commodo in",
                                    "dolore ea"
                                ],
                                "cdId": "66"
                            }
                        }
                    ]
                },
                {
                    "type": "voluptate",
                    "value": [
                        {
                            "id": "29",
                            "type": "laborum sed ad",
                            "parentId": "99",
                            "value": {
                                "name": "压强是不条县斗",
                                "fdType": "Duis dolor Ut",
                                "dsId": "31",
                                "fdId": "35",
                                "metaType": "fugiat deserunt Duis proident ut",
                                "seqNo": 63,
                                "isAggregated": false,
                                "calculationType": "aliquip pariatur magna dolore",
                                "level": "Excepteur eiusmod occaecat",
                                "annotation": "ex dolore sed sit",
                                "isDetectionSensitive": true,
                                "isSensitive": false,
                                "filterType": "velit",
                                "filterValue": [
                                    "laboris",
                                    "fugiat eiusmod nostrud reprehenderit tempor",
                                    "laboris"
                                ],
                                "cdId": "15"
                            }
                        },
                        {
                            "id": "74",
                            "type": "cillum enim nisi",

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/write/cardData/file' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cdId": "44",
    "typeOp": "pivot",
    "token": "in do incididunt Excepteur eiusmod",
    "loginId": "23",
    "filters": [
        {
            "name": "大区",
            "fdId": "c2bde870290b74630ab53fb9",
            "dsId": "s4912f495dd134e5fbd77407",
            "cdId": "lb800995dd291414d9a2adbd",
            "fdType": "STRING",
            "filterType": "IN",
            "sourceCdId": "m0cd9c39fa89d475cb56f1b5",
            "filterValue": [
                "其它"
            ]
        }
    ],
    "treeFilters": [
        {
            "cdId": "45",
            "filterType": "enim Ut ullamco",
            "fields": [
                {
                    "name": "识却导点有越",
                    "fdId": "66",
                    "dsId": "61",
                    "cdId": "55",
                    "fdType": "non Excepteur"
                },
                {
                    "name": "消众起装家酸",
                    "fdId": "7",
                    "dsId": "15",
                    "cdId": "59",
                    "fdType": "et tempor ad reprehenderit dolore"
                }
            ],
            "values": [
                [
                    "anim"
                ],
                [
                    "dolor nisi eu deserunt",
                    "deserunt incididunt minim"
                ],
                [
                    "labore dolore ut non"
                ]
            ],
            "sourceCdId": "53"
        }
    ],
    "dynamicParams": [
        {
            "dpId": "35",
            "name": "水千飞实这",
            "valueType": "voluptate nulla velit est dolor",
            "defaultValue": "exercitation quis et",
            "customize": false,
            "multiple": false,
            "optionValue": [
                "adipisicing labore reprehenderit fugiat cillum"
            ],
            "inheritParent": true,
            "sourceCdId": "41"
        }
    ],
    "combinationFilters": [
        {
            "condition": [
                {
                    "type": "Excepteur pariatur ullamco",
                    "value": [
                        {
                            "id": "44",
                            "type": "proident velit adipisicing ut",
                            "parentId": "89",
                            "value": {
                                "name": "种政达总件今",
                                "fdType": "laboris velit sed eiusmod commodo",
                                "dsId": "28",
                                "fdId": "91",
                                "metaType": "id anim laboris",
                                "seqNo": 16,
                                "isAggregated": true,
                                "calculationType": "sed dolor irure",
                                "level": "culpa proident",
                                "annotation": "anim consectetur occaecat irure laboris",
                                "isDetectionSensitive": true,
                                "isSensitive": false,
                                "filterType": "proident sunt mollit quis",
                                "filterValue": [
                                    "do commodo in",
                                    "dolore ea"
                                ],
                                "cdId": "66"
                            }
                        }
                    ]
                },
                {
                    "type": "voluptate",
                    "value": [
                        {
                            "id": "29",
                            "type": "laborum sed ad",
                            "parentId": "99",
                            "value": {
                                "name": "压强是不条县斗",
                                "fdType": "Duis dolor Ut",
                                "dsId": "31",
                                "fdId": "35",
                                "metaType": "fugiat deserunt Duis proident ut",
                                "seqNo": 63,
                                "isAggregated": false,
                                "calculationType": "aliquip pariatur magna dolore",
                                "level": "Excepteur eiusmod occaecat",
                                "annotation": "ex dolore sed sit",
                                "isDetectionSensitive": true,
                                "isSensitive": false,
                                "filterType": "velit",
                                "filterValue": [
                                    "laboris",
                                    "fugiat eiusmod nostrud reprehenderit tempor",
                                    "laboris"
                                ],
                                "cdId": "15"
                            }
                        },

返回响应

🟢200成功

application/json

Body

taskId

string

任务id

必需

status

string

状态

必需

result

string

请求状态

必需

枚举值: ok、fail

fileName

string

文件名称

必需

示例

{
    "taskId": "string",
    "status": "string",
    "result": "string",
    "fileName": "string"
}