文档

API概览

更新时间:
本产品(ITag/2022-06-16)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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删除成员删除任务中某个工作结点(包括标注、质检或验收)的成员。