# API列表（V1）
{service}为标注平台实际部署实例地址,访问时不需要带上端口。
| 序号 | 接口名称 | 请求路径 | 请求方式 |
|---|---|---|---|
| 1 | 数据集创建 | {service}/api/v1/datasets | POST |
| 2 | 查询数据集列表 | {service}/api/v1/datasets | GET |
| 3 | 查询数据集详情 | {service}/api/v1/datasets/{dataset-id} | GET |
| 4 | 删除数据集 | {service}/api/v1/datasets/{dataset-id} | DELETE |
| 5 | 更新数据集 | {service}/api/v1/datasets | PATCH |
| 6 | 数据集上传 | {service}/api/v1/datasets/{dataset-id}/batchs | POST |
| 7 | 数据集上传进度查询 | {service}/api/v1/datasets/process/{upload-id} | GET |
| 8 | 数据集下载 | {{service}/api/v1/datasets/exports | POST |
| 9 | 数据集下载进度查询 | {service}/api/v1/datasets/exports/{export-id} | GET |
| 10 | 获取任务列表 | {service}/api/v1/tasks | GET |
| 11 | 任务创建（复制） | {service}/api/v1/tasks | POST |
| 12 | 任务详情查询 | {service}/api/v1/tasks/task-id | GET |
| 13 | 任务标注结果导出 | {service}/api/v1/exports | POST |
| 14 | 任务标注结果导出进度查询 | {service}/api/v1/exports/{export-id} | GET |
# 专业术语
| 序号 | 术语 | 说明 |
|---|---|---|
| 1 | 任务 | 标注的组织形式，通过一个既存的任务复制创建一个新的任务。 在标注平台管理后台对一个任务的创建，需要如下要素，缺一不可： • 归属项目 • 基本信息 • 模板工具 • 使用流程 • 执行人员 |
| 2 | 数据集 | 标注平台的数据组织形式，一个任务只能关联绑定一个数据集。 |
| 3 | 数据集批次 | 一个数据集可包含多个批次，批次可以简单类比数据集的一个根目录。 |
| 4 | 任务状态 | 任务状态包括四种： • 未开始: 任务未创建完毕，未开始状态的任务无法进行标注。 • 进行中: 任务标注中。 • 暂停中: 因某些特定原因，管理员可通过管理后台将任务设定为“暂停中”，该状态下，标注活动暂停，不能进行标注、质检和验收工作。 • 已完成: 管理员在任务列表中，通过“操作”中的“完成”按钮手动将该任务置为“已完成”时的任务状态，此状态代表项目经理确认该标注任务完成，可以将该任务标注结果导出。 |
| 5 | 文件导出地址 | 是指客户端将标注文件导出到标注平台以外的地址进行存储。使用标注平台外部导出地址时，需要确保标注平台与外部文件存储地址的网络连通性。 |