Orchestrator
2021.10
Orchestrator API ガイド
Last updated 2024年6月22日

タスクの要求

フォルダー内のタスクを取得する

この要求では、ユーザーがアクセスできるクラシック フォルダー内のすべてのアクションを取得できます。

注:

このエンドポイントはクラシック フォルダーのアクションのみを取得するもので、今後非推奨となる予定です。

フォルダーの種類に関係なくアクションを取得するには、次のエンドポイントを使用します。

  • odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders
  • odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin

GET

{OrchestratorURL}/odata/Tasks?$top=2

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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 が含まれている必要があります。たとえば {OrchestratorURL}/odata/Tasks(194) です。

GET

{OrchestratorURL}/odata/Tasks(194)

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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

{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks

要求ヘッダー

キー

値 (Value)

認可

Bearer

要求本文

{
"taskAssignments": 
[   
 {
      "TaskId": 194,
      "UserId": 52454
    }
]
}{
"taskAssignments": 
[   
 {
      "TaskId": 194,
      "UserId": 52454
    }
]
}

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 195,
            "UserId": 52454,
            "ErrorCode": 2400,
            "ErrorMessage": "Task is already assigned"
        }
    ]
}{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 195,
            "UserId": 52454,
            "ErrorCode": 2400,
            "ErrorMessage": "Task is already assigned"
        }
    ]
}

タスクの割り当てを解除する

この要求では、指定された taskIds に基づいて 1 つ以上のタスクの割り当てを解除することができます。

POST

{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks

要求ヘッダー

キー

値 (Value)

認可

Bearer

要求本文

{
  "taskIds": [
    194,177
  ]
}{
  "taskIds": [
    194,177
  ]
}

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 177,
            "UserId": null,
            "ErrorCode": 2400,
            "ErrorMessage": "This task is in completed state"
        }
    ]
}{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 177,
            "UserId": null,
            "ErrorCode": 2400,
            "ErrorMessage": "This task is in completed state"
        }
    ]
}

タスクに対して表示および編集権限を持つユーザーを返す

この要求では、タスクに対して表示および編集権限を持つユーザーを取得することができます。要求にはフォルダー ID が含まれている必要があります。

GET

{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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

{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks

要求ヘッダー

キー

値 (Value)

認可

Bearer

要求本文

{
  "taskIds": [
     104177
  ]
}{
  "taskIds": [
     104177
  ]
}

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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"
        }
    ]
}

Was this page helpful?

サポートを受ける
RPA について学ぶ - オートメーション コース
UiPath コミュニティ フォーラム
UiPath ロゴ (白)
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.