- 基本情報
- Swagger の定義
- Orchestrator API
Orchestrator API ガイド
タスクの要求
この要求では、ユーザーがアクセスできるクラシック フォルダー内のすべてのアクションを取得できます。
このエンドポイントはクラシック フォルダーのアクションのみを取得するもので、今後非推奨となる予定です。
フォルダーの種類に関係なくアクションを取得するには、次のエンドポイントを使用します。
odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders
odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin
GET
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks?$top=2
{
"@odata.context": "https://cloud.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://cloud.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://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194)
です。
GET
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194)
{
"@odata.context": "https://cloud.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://cloud.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
に基づいてユーザーにアクションを割り当てることができます。1 つの要求で、異なるユーザーへの複数のアクションの割り当てを処理することができます。
POST
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}
{
"@odata.context": "https://cloud.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://cloud.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
に基づいて 1 つ以上のタスクの割り当てを解除することができます。
POST
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks
{
"@odata.context": "https://cloud.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://cloud.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 が含まれている必要があります。
GET
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)
{
"@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "harry.potter@uipath.com",
"EmailAddress": "harry.potter@uipath.com",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "severus.snape@uipath.com",
"Id": 52917
}
{
"@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "harry.potter@uipath.com",
"EmailAddress": "harry.potter@uipath.com",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "severus.snape@uipath.com",
"Id": 52917
}
この要求では、1 つ以上のタスクをその ID で削除できます。
POST
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks
{
"@odata.context": "https://cloud.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://cloud.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"
}
]
}