确认结果API

cybozu发表于:2020年04月29日 16:47:21更新于:2021年04月20日 16:55:44

确认结果API

它是用于检查CSV导入处理结果的API。


HTTP 方法

GET

URI

https://(子域名).cybozu.cn/v1/csv/result.json

参数值要指定的值必须说明
id数值必须

指定每个CSV导入API执行结果的ID。

请求头部示例

GET /v1/csv/result.json?id=1 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

不需要 Content-Type 头部。

应答

与执行确认结果ID对应的处理结果以JSON格式返回。

参数值要指定的值说明
done布尔值如果导入过程完成,则输出“true”,如果正在处理中,则输出“false”。
success布尔值如果正常结束,则输出“true”;如果发生错误,则输出“false”。
errorCode字符串错误结束后,将显示错误的内容。
在正常结束和处理中的情况下,输出“null”。


导入处理中的示例

{
    "done" : false,
    "success" : false,
    "errorCode" : null
}

正常结束的示例

{
    "done" : true,
    "success" : true,
    "errorCode" : null
}

发生错误示例

{
    "done" : true,
    "success" : false,
    "errorCode" : "SLASH_IL15: 第一行的项目数目不正确。"
}

访问权限

cybozu.cn共通管理员可执行。

    注意:贴代码时请注意格式并使用"代码语言",与本文无关的问题请至“讨论社区”提问。