openQcTaskReport/addTaskReports API接口文档
1.
openQcTaskReport/addTaskReports
是一个用于添加任务报告的API接口,用户可以通过此接口将任务报告添加到系统中。
2. 请求URL
POST /openQcTaskReport/addTaskReports
3. 请求参数
参数名 | 类型 | 是否必须 | 描述 |
taskId | String | 是 | 任务ID |
reportContent | String | 是 | 报告内容 |
reportType | String | 是 | 报告类型 |
reportStatus | String | 是 | 报告状态 |
createTime | Date | 是 | 创建时间 |
updateTime | Date | 是 | 更新时间 |
4. 返回结果
成功时,返回一个包含以下字段的JSON对象:
字段名 | 类型 | 描述 |
resultCode | String | 结果代码,成功为"0000",失败为其他值 |
resultMessage | String | 结果信息,成功为"操作成功",失败为具体的错误信息 |
data | Object | 返回的数据,包含任务报告的详细信息 |
失败时,返回一个包含以下字段的JSON对象:
字段名 | 类型 | 描述 |
resultCode | String | 结果代码,成功为"0000",失败为其他值 |
resultMessage | String | 结果信息,成功为"操作成功",失败为具体的错误信息 |
5. 示例请求
{ "taskId": "123456", "reportContent": "这是一份测试报告", "reportType": "测试报告", "reportStatus": "已完成", "createTime": "20220101T00:00:00", "updateTime": "20220101T01:00:00" }
6. 示例响应
成功时:
{ "resultCode": "0000", "resultMessage": "操作成功", "data": { "taskId": "123456", "reportContent": "这是一份测试报告", "reportType": "测试报告", "reportStatus": "已完成", "createTime": "20220101T00:00:00", "updateTime": "20220101T01:00:00" } }
失败时:
{ "resultCode": "9999", "resultMessage": "任务ID不存在" }
下面是一个简化的介绍形式,展示了 API 接口文档中openQcTaskReport/addTaskReports
接口的信息:
参数名称 | 类型 | 是否必须 | 描述 | 示例值 |
api_name | string | 是 | API名称 | openQcTaskReport |
method | string | 是 | 方法名称 | addTaskReports |
请求参数 | ||||
reportData | object | 是 | 要添加的质量检查任务报告数据 | |
reportData[].taskId | string | 是 | 任务ID | "task123" |
reportData[].status | string | 是 | 报告状态 | "success", "error", "in_progress" |
reportData[].data | object | 是 | 报告内容 | 根据具体报告结构而定 |
reportData[].timestamp | string | 是 | 报告时间戳 | "20230401T12:00:00Z" |
响应参数 | ||||
code | int | 是 | 响应代码 | 200, 400, 500 等 |
message | string | 是 | 响应信息 | "操作成功" 或 "错误信息" |
data | object | 否 | 返回数据 | 根据实际响应内容而定 |
data.taskReports | array | 否 | 新添加的任务报告列表 | |
data.taskReports[].taskId | string | 否 | 任务ID | "task123" |
注意:
介绍中的reportData
通常是一个数组,可以包含多个质量检查任务报告的对象。
data
字段的内容通常取决于 API 的具体设计,这里假设它可能包含taskReports
数组。
示例值只是用于演示可能的输入或输出,实际值应根据具体的 API 规范来确定。
timestamp
通常为 UTC 时间格式。
“是否必须”列指示了该参数是否在请求中是必需的。
在具体实现时,请根据实际的 API 接口文档来填充以上介绍的内容。
下一篇:查看数组信息_数组