上传数据集 - 观远数据开放平台

请求参数

Header 参数

X-Auth-Token

string

个人Token

必需

Body 参数application/json

tableName

string

数据集名称

必需

若tableName有重名可以指定dsId

dsId

string

数据集ID

可选

overwriteExistingData

boolean

是否覆盖原始数据

可选

默认为false，设置为true时，先删除原来的数据，再上传。

columns

array [object {3}]

可选

设置上传数据集各列属性，支持传入alias字段别名

name

string

字段名

必需

type

string

字段类型

可选

如果没有设置, 则系统会自动读取前1000行来推测其列的数据类型, string, integer, double, timestamp, long, short, float, date

isPrimaryKey

boolean

设置主键

可选

默认为false，设置主键，设置了primaryKey后，多次上传时会更新原有数据，否则，会追加到原有数据后

allColumnsSpecified

boolean

是否选择所有列

可选

默认false。为false时，会自动检查data中的字段并推测类型上传到数据集，为true时，表示columns中指定了所有字段，那么，data中的多余字段会过滤掉。

data

array [object]

data 待上传的数据

必需

displayType

string

标识的格式

已废弃

标示数据集的显示格式，包括 CSV, EXCEL, DATAFUSION, DATAFLOW, MYSQL, KR3000, PUBLIC, WEIXIN, POSTGRESQL, GREENPLUM, CARD。建议不传！

batchFinish

boolean

批量上传完成标识

可选

默认为false，分批上传时，表示是否是最后一批。设置为false时，不更新数据集数据，也不刷新卡片缓存

isAsync

boolean

是否异步上传

必需

默认为false，表示是采用同步还是异步方式上传文件

示例

{
    "tableName": "string",
    "dsId": "string",
    "overwriteExistingData": true,
    "columns": [
        {
            "name": "string",
            "type": "string",
            "isPrimaryKey": true
        }
    ],
    "allColumnsSpecified": true,
    "data": [
        {}
    ],
    "displayType": "string",
    "batchFinish": true,
    "isAsync": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/public-api/upload-dataset/v2' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tableName": "string",
    "dsId": "string",
    "overwriteExistingData": true,
    "columns": [
        {
            "name": "string",
            "type": "string",
            "isPrimaryKey": true
        }
    ],
    "allColumnsSpecified": true,
    "data": [
        {}
    ],
    "displayType": "string",
    "batchFinish": true,
    "isAsync": true
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

object

响应结果

必需

status

string

状态

必需

dsId

string

数据集ID

必需

taskId

string

任务ID

必需

示例

{
    "result": "ok",
    "response": {
        "status": "finish",
        "dsId": "v2a769c4be17d4ec8b77b2b2",
        "taskId": "cc9f7b00-8772-11ef-85a1-1b083e3b1c6e"
    }
}