接入前需要确认
接入前请核对
生成目标内容前,请检查分隔符、引号内换行与编号列。
接入前请核对
Jira Wiki文本不同于Atlassian Document Format,未必能在所有现代字段中渲染。
代码示例
这些示例以 multipart/form-data 发送样例,并原样保存响应字节。请先设置环境变量 TABLECONVERT_API_KEY。
CSV 转 Jira Wiki表格 API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/csv-to-jira' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data="issue","status","assignee"
"APP101","In progress","Alice"
"APP102","Done","Bob"' \
--form-string 'output[escape]=true' \
--form-string 'output[rowHeader]=true' \
--form-string 'output[colHeader]=false' \
--output 'csv-to-jira.txt'需要 cURL。若示例采用文件上传,请先下载输入样例。
CSV 转 Jira Wiki表格 API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/csv-to-jira"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "\"issue\",\"status\",\"assignee\"\r\n\"APP101\",\"In progress\",\"Alice\"\r\n\"APP102\",\"Done\",\"Bob\""),
"output[escape]": (None, "true"),
"output[rowHeader]": (None, "true"),
"output[colHeader]": (None, "false"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("csv-to-jira.txt").write_bytes(response.content)需要 Python 3 与 requests,可通过 pip install requests 安装。
CSV 转 Jira Wiki表格 API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "\"issue\",\"status\",\"assignee\"\r\n\"APP101\",\"In progress\",\"Alice\"\r\n\"APP102\",\"Done\",\"Bob\"");
form.set("output[escape]", "true");
form.set("output[rowHeader]", "true");
form.set("output[colHeader]", "false");
const response = await fetch("https://api.tableconvert.com/v2/convert/csv-to-jira", {
method: "POST",
headers: { Authorization: "Bearer " + process.env.TABLECONVERT_API_KEY },
body: form,
signal: AbortSignal.timeout(40_000),
});
if (!response.ok) {
throw new Error("HTTP " + response.status + ": " + await response.text());
}
await writeFile("csv-to-jira.txt", Buffer.from(await response.arrayBuffer()));需要 Node.js 20 或更新版本,使用内置 fetch、FormData 和 Blob。
身份验证
发送 Authorization: Bearer YOUR_API_KEY。请让 HTTP 客户端设置 multipart 边界,不要手动指定 Content-Type。
生产环境的 API Key 请保存在服务端环境变量中。
请求参数
先将分隔文本解析为矩形表格,再生成目标输出。清晰的首行表头与一致的分隔符有助于确定字段映射。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
data | string | — | 直接发送 CSV 表格内容;data、file、url 三种来源任选其一。 |
file | binary | — | 通过 multipart/form-data 上传 csv 文件。 |
url | string | — | 可公开访问的受支持文件 HTTP 或 HTTPS URL。 |
使用 data、file 或 url 提供一种输入来源。页面示例使用适合该格式的来源模式。
输出选项
生成可选行表头、列表头的旧版Jira Wiki表格语法;这不是Jira工单创建API或富文本编辑器API。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
output[escape] | boolean | true | 单元格应保持纯文本时,转义目标标记中具有特殊含义的字符。 |
output[rowHeader] | boolean | true | 使用目标表格语法将首行标为表头。 |
output[colHeader] | boolean | false | 使用目标表格语法将首列标为表头单元格。 |
转换规则
| 情况 | 处理方式 |
|---|---|
| 映射规则 1 | CSV表头成为表格首行,后续分隔记录成为数据行。 |
| 映射规则 2 | 使用单竖线或双竖线分隔数据行及表头。 |
| 映射规则 3 | 提取后CSV分隔符不再参与展示;请转义单元格中的目标表格分隔符。 |
输入读取方式
- 若目标输出使用命名记录或schema字段,请在首行提供列名。
- 带引号的分隔符、双引号转义与引号内换行按单元格内容解析;短行会补齐到表格宽度。
- 请先统一混用的分隔符;自动识别分隔符使用启发式规则。
- CSV单元格进入转换后为文本;看起来像数字的编号不等同于数值类型。
输出生成方式
- 表头单元格使用Jira Wiki竖线语法。
- 请根据目标渲染器要求转义字面竖线。
- 请确认Jira字段是否支持Wiki语法;新版编辑器文档可能需要其他表示。
适用场景
此转换的实际用途
以分隔文本导出文件为起始数据,准备旧版Jira Wiki字段。生成目标内容前,请检查分隔符、引号内换行与编号列。
Jira Wiki表格
为使用旧版Wiki渲染的工单描述准备表格。
响应与错误
| HTTP 状态 | 说明 |
|---|---|
200 | text/plain; charset=utf-8 |
400 | 输入或转换参数无效。 |
402 | 积分不足,无法处理此请求。 |
403 | API Key 缺失或无效。 |
413 | 输入超过已配置的请求限制。 |
415 | 不支持的输入媒体类型。 |
429 | 请求超过频率限制。 |
500 | 转换未能完成。 |
503 | 渲染服务不可用或请求超时。 |
重试前请先检查响应。新的 HTTP 请求属于新的转换,可能再次消耗积分。
限制、计费与版本
本地预览最多接受 200 KB。当前 API 实现允许上传一个不超过 50 MiB 的文件,multipart 中每个文本字段限制为 1 MiB,v2 转换任务的截止时间为 30 秒。部署环境可能设置更严格的限制。重试前请先检查错误内容;部分解析或渲染失败会返回 HTTP 500。
真实调用遵循 API 积分规则。转换失败会返还积分;若转换已完成,随后下载连接中断不会撤销该次成功转换。
查看 API 定价与积分参考资料与格式规范
格式参考资料用于说明底层语法;上方转换规则与样例描述 TableConvert 的实际实现。