本产品（
ITag/2022-06-16）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
租户
| API | 标题 | API概述 |
|---|---|---|
| ListTenants | 租户列表查询 | 展示阿里云账号下的iTAG租户。 |
| GetTenant | 查询租户信息 | 查询iTAG租户的相关信息。 |
| UpdateTenant | 修改租户信息 | 修改iTAG租户的相关信息。 |
标注模板
| API | 标题 | API概述 |
|---|---|---|
| ListTemplates | 模板列表展示 | 展示当前租户的模板列表。 |
| CreateTemplate | 新增模板 | 您可以为当前租户添加新的模板，并根据自身的业务需求自定义标注模板。 |
| UpdateTemplate | 修改模版 | 修改当前租户下的模板。 |
| DeleteTemplate | 删除模板 | 删除当前租户下的模板。 |
| GetTemplateView | 查询模板展示信息 | 查询模版中图片、文本、音频等展示信息。 |
| GetTemplateQuestions | 查询模板题目信息 | 查询模版中的单选、多选等题目信息。 |
| GetTemplate | 查询模板信息 | 查询租户下的模版信息。 |
标注任务
| API | 标题 | API概述 |
|---|---|---|
| AppendAllDataToTask | 追加数据 | 任务追加数据。 |
| ListTasks | 任务列表查询 | 展示当前租户标注任务列表。 |
| CreateTask | 新增任务 | 为当前租户新增标注任务。 |
| GetTask | 单个任务信息 | 查询单个标注任务信息。 |
| UpdateTask | 修改任务 | 修改当前租户下的任务。 |
| DeleteTask | 删除任务 | 删除当前租户下的某个任务。 |
| GetTaskTemplateViews | 查询任务展示 | 查询任务模版中的数据展示信息。 |
| GetTaskTemplateQuestions | 查询任务题目 | 查询任务模板题目。 |
| GetTaskTemplate | 查询任务模板信息 | 查询任务当前的模板信息。 |
| GetTaskStatus | 查询任务状态 | 查询任务当前的状态。 |
| GetTaskStatistics | 查询任务统计 | 查询任务当前的统计信息。 |
子任务包
| API | 标题 | API概述 |
|---|---|---|
| ListSubtasks | 子任务列表查询 | 展示子任务包列表。 |
| GetSubtask | 单个任务包信息 | 查询单个子任务包信息。 |
| ListSubtaskItems | 获取任务包标注数据 | 展示单个子任务包的标注数据。 |
| GetSubtaskItem | 查询单个标注数据 | 查询子任务包中的单个标注数据。 |
标注结果
| API | 标题 | API概述 |
|---|---|---|
| ExportAnnotations | 导出标注结果 | 导出标注任务的结果数据。 |
| ListJobs | 导出的标注结果列表展示 | 展示所有导出的标注结果的列表。 |
| GetJob | 单个标注结果 | 查询单个标注导出结果的信息。 |
标注人员管理
| API | 标题 | API概述 |
|---|---|---|
| ListUsers | 展示标注成员 | 展示当前租户下的全部标注成员。 |
| GetUser | 查询单个成员信息 | 查询租户里单个成员的详细信息。 |
| CreateUser | 新增成员 | 租户内新增成员。 |
| UpdateUser | 更新成员 | 更新租户内成员信息。 |
| DeleteUser | 删除成员 | 删除租户内某个成员。 |
任务人员
| API | 标题 | API概述 |
|---|---|---|
| GetTaskWorkforce | 查询任务人员配置信息 | 查询任务中各个结点配置的人员信息。 |
| AddWorkNodeWorkforce | 增加成员 | 为标注任务的工作节点（标注、质检和验收）进行人员分配。 |
| GetTaskWorkforceStatistic | 查询任务成员统计 | 查询任务中各成员的统计数据。 |
| UpdateTaskWorkforce | 更新成员 | 更新任务成员。 |
| RemoveWorkNodeWorkforce | 删除成员 | 删除任务中某个工作结点（包括标注、质检或验收）的成员。 |