orchestrator
latest
false
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。
Orchestrator API 指南
上次更新日期 2025年4月8日
此请求使您能够检索用户有权访问的传统文件夹中的所有任务。
备注：
此端点仅检索传统文件夹中的操作，并且将来会弃用。
无论文件夹类型如何，都可以使用以下方法检索操作：
odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersodata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin
获取
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks?$top=2
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks",
"@odata.count": 21,
"value": [
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:39:30.41Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 63
},
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:40:24.88Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 64
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks",
"@odata.count": 21,
"value": [
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:39:30.41Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 63
},
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:40:24.88Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 64
}此请求使您能够根据
TaskId检索任务详细信息。 请求中必须包含 TaskId 。 例如 https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194)。
获取
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194)
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks/$entity",
"Title": "Verify Credentials",
"Type": "FormTask",
"Priority": "Critical",
"Status": "Unassigned",
"CreationTime": "2019-12-12T17:25:03.02Z",
"TaskCatalogName": "Auth",
"OrganizationUnitId": 828,
"IsCompleted": false,
"Id": 194
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks/$entity",
"Title": "Verify Credentials",
"Type": "FormTask",
"Priority": "Critical",
"Status": "Unassigned",
"CreationTime": "2019-12-12T17:25:03.02Z",
"TaskCatalogName": "Auth",
"OrganizationUnitId": 828,
"IsCompleted": false,
"Id": 194
}此请求使您能够根据
TaskId 和 UserId将任务分配给用户。 单个请求可以处理将多个任务分配给不同用户的问题。
发布
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
请求正文
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}响应代码
200 OK
响应正文
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}此请求使您能够根据提供的
taskIds 清除一个或多个任务的分配。
发布
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
请求正文
{
"taskIds": [
194,177
]
}{
"taskIds": [
194,177
]
}响应代码
200 OK
响应正文
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}此请求使您能够检索对任务具有 查看 和 编辑 权限的用户。 请求中必须包含文件夹 ID。
获取
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "[email protected]",
"EmailAddress": "[email protected]",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "[email protected]",
"Id": 52917
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "[email protected]",
"EmailAddress": "[email protected]",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "[email protected]",
"Id": 52917
}此请求使您能够按 ID 删除一个或多个任务。
发布
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
请求正文
{
"taskIds": [
104177
]
}{
"taskIds": [
104177
]
}响应代码
200 OK
响应正文
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 104177,
"UserId": null,
"ErrorCode": 2427,
"ErrorMessage": "You do not have the required permissions to delete this action"
}
]
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 104177,
"UserId": null,
"ErrorCode": 2427,
"ErrorMessage": "You do not have the required permissions to delete this action"
}
]
}
