跳转到主要内容
POST
通过 CSV 上传映射数据

限制说明

使用说明

  • 请求为 multipart/form-data,CSV 放在 file 字段;schema_id 和 do_not_truncate_first 是查询参数。文件最大 100 MB。
  • CSV 首行为表头,必须包含全部来源标签和结果标签,其他列会被丢弃。值超过 2,048 字节会被拒绝;BOM 会被去除。没有数据行的文件返回 InvalidParameter。
  • 默认导入前先删除全部现有数据行。传 do_not_truncate_first=TRUE 时保留现有数据,来源标签值相同的行会被替换。
  • 来源标签值相同的多行会合并,以后出现的行为准。
  • 按导入后的行数检查行数上限(默认 10,000 行,部分账户更高),超出返回 InvalidParameter。
  • 数据每 100 行一批写入;某一批失败时,之前的清空和已写入的批次不会回滚。
  • 映射规则必须存在且未被删除,否则返回 InvalidParameter。
  • 仅账户管理员、映射规则创建者或映射规则所属团队的成员可以调用,其他人返回 AccessDenied。
  • 同一映射规则的数据写操作(写入、删除、清空、CSV 上传)串行执行;另一个写操作进行中时调用会返回 RequestTooFrequently。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

查询参数

schema_id
string
必填

目标映射 schema 的 ID(ObjectID hex)。

Pattern: ^[0-9a-fA-F]{24}$
do_not_truncate_first
string

传 TRUE(大小写不敏感)时追加导入;不传且 schema 已有数据时,服务端先清空再导入。

请求体

multipart/form-data
file
file
必填

CSV 文件,最大 100 MB。表头必须包含 schema 的全部 source/result label 名称。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。