orchestrator
2023.10
false
- 基本情報
- Swagger の定義
- Orchestrator API
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

Orchestrator API ガイド
最終更新日時 2026年3月24日
エンドポイントごとの権限
一般的なタスク
| 操作 | 権限 |
|---|---|
GET - /tasks/GenericTasks/GetTaskDataById | Tasks.View |
POST - /tasks/GenericTasks/CreateTask | Tasks.Create |
POST - /tasks/GenericTasks/CompleteTask | Tasks.Edit |
タスク フォーム
| 操作 | 権限 |
|---|---|
POST - /forms/TaskForms/CreateFormTask | Tasks.Create |
GET - /forms/TaskForms/GetTaskFormById | Tasks.View |
GET - /forms/TaskForms/GetTaskDataById | Tasks.View |
POST - /forms/TaskForms/CompleteTask | Tasks.Edit |
タスク カタログ
| 操作 | 権限 |
|---|---|
GET - /odata/TaskCatalogs | TaskCatalogs.View |
GET - /odata/TaskCatalogs(Id) | TaskCatalogs.View |
POST - /odata/TaskCatalogs/UiPath.Server.Configuration.OData.CreateTaskCatalog | TaskCatalogs.Create |
POST - /odata/TaskCatalogs(Id)/UiPath.Server.Configuration.OData.UpdateTaskCatalog | TaskCatalogs.Edit |
タスク
| 操作 | 権限 |
|---|---|
GET - /odata/Tasks | Tasks.View |
GET /odata/Tasks(Id) | Tasks.View |
POST - /odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks | Tasks.View & Tasks.Edit |
POST - /odata/Tasks/UiPath.Server.Configuration.OData.ReassignTasks | Tasks.View、Tasks.Edit、および TaskAssignment.Create |
POST - /odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks | Tasks.View & Tasks.Edit |
GET - /odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=organizationUnitId) | Tasks.View、Tasks.Edit、および TaskAssignment.Create |
実行メディア
| 操作 | 権限 |
|---|---|
GET - /odata/ExecutionMedia | ExecutionMedia.View |
GET - /odata/ExecutionMedia(Id) | ExecutionMedia.View |
GET - /odata/ExecutionMedia/UiPath.Server.Configuration.OData.DownloadMediaByJobId(jobId={jobId})} | ExecutionMedia.View |
POST - /odata/ExecutionMedia/UiPath.Server.Configuration.OData.DeleteMediaByJobId | ExecutionMedia.View |
フォルダー
| 操作 | 権限 |
|---|---|
GET - /odata/Folders | Folders.View または Subfolders.View |
POST - /odata/Folders | Folders.Create または Subfolders.Create |
DELETE -/odata/Folders{Id} | Folders.Delete または Subfolders.Delete |
GET - /odata/Folders{Id} | Folders.View または Subfolders.View |
PUT - /odata/Folders{Id} | Folders.Edit または Subfolders.Edit |
POST - /odata/Folders/UiPath.Server.Configuration.OData.AssignUsers | Folders.Edit または Subfolders.Edit および Users.View と Roles.View |
GET - /odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={key},includeInherited={includeInherited}) | Folders.View または Subfolders.View および Users.View |
POST - /odata/Folders{Id}/UiPath.Server.Configuration.OData.RemoveUserFromFolder | Folders.Edit または Subfolders.Edit および Users.View |
ライブラリ
| 操作 | 権限 |
|---|---|
GET - /odata/Libraries | Libraries.View |
GET - /odata/Libraries/UiPath.Server.Configuration.OData.GetVersions(packageId='{packageId}') | Libraries.View |
GET - /odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}') | Libraries.View |
DELETE - /odata/Libraries('{Id}') | Libraries.Delete |
POST - /odata/Libraries/UiPath.Server.Configuration.OData.UploadPackage | Libraries.Create |
アラート
| 操作 | 権限 |
|---|---|
GET - /odata/Alerts | Alerts.View |
GET - /odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount() | Alerts.View |
POST - /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead | Alerts.View |
POST - /odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert | Alerts.Create |
アセット
| 操作 | 権限 |
|---|---|
GET - /odata/Assets | Assets.View |
POST - /odata/Assets | Assets.Create |
PUT - /odata/Assets({Id}) | Assets.Edit |
DELETE - /odata/Assets({Id}) | Assets.Delete |
POST - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByNameForRobotKey | Assets.View |
GET - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId={robotId},assetName='{assetName}') | Assets.View |
AuditLogs
| 操作 | 権限 |
|---|---|
GET - /odata/AuditLogs | Audit.View |
GET - /odata/AuditLogs/UiPath.Server.Configuration.OData.Reports() | Audit.View |
GET - /odata/AuditLogs/UiPath.Server.Configuration.OData.GetAuditLogDetails(auditLogId={auditLogId}) | Audit.View |
バケット
| 操作 | 権限 |
|---|---|
GET - /odata/Buckets | Storage Buckets.View |
POST - /odata/Buckets | Storage Buckets.Create |
DELETE - /odata/Buckets({Id}) | Storage Buckets.Delete |
GET - /odata/Buckets({Id}) | Storage Buckets.View |
PUT - /odata/Buckets({Id}) | Storage Buckets.Edit |
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetReadUri | Storage Buckets.View および Storage Files.View |
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri | Storage Buckets.View および Storage Files.Create |
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFiles | Storage Buckets.View および Storage Files.View |
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetDirectories | Storage Buckets.View および Storage Files.View |
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFile | Storage Buckets.View および Storage Files.View |
DELETE - /odata/Buckets({key})/UiPath.Server.Configuration.OData.DeleteFile | Storage Buckets.View および Storage Files.Delete |
環境 (ロボット グループ)
| 操作 | 権限 |
|---|---|
GET - /odata/Environments | Environments.View |
GET - /odata/Environments({Id}) | Environments.View |
GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key={key}) | Environments.View および Robots.View |
GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotIdsForEnvironment(key={key}) | Environments.View および Robots.View |
POST - /odata/Environments | Environments.Create |
PUT - /odata/Environments({Id}) | Environments.Edit |
DELETE - /odata/Environments({Id}) | Environments.Delete |
POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.AddRobot | Environments.Edit |
POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.RemoveRobot | Environments.Edit |
POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.SetRobots | Environments.Edit |
ジョブ
| 操作 | 権限 |
|---|---|
| GetJobs | Jobs.View |
| GetJobs(Id) | Jobs.View |
| StartJobs | Jobs.Create |
| StopJob | Jobs.Edit |
| StopJobs | Jobs.Edit |
ログ
| 操作 | 権限 |
|---|---|
| SubmitLogs | Logs.Create |
| PostLogs | Logs.Create |
権限
| 操作 | 権限 |
|---|---|
| GetPermissions |
プロセス
| 操作 | 権限 |
|---|---|
GET - /odata/Processes | Packages.View |
GET - /odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='{processId}') | Packages.View |
DELETE - /odata/Processes('{Id}') | Packages.Delete |
POST - /odata/Processes/UiPath.Server.Configuration.OData.UploadPackage | Packages.Create |
GET - /odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}') | Packages.View |
GET - /odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='{key}') | Packages.View |
POST - /odata/Processes/UiPath.Server.Configuration.OData.SetArguments | Packages.Edit |
QueueDefinitions
| 操作 | 権限 |
|---|---|
| GetQueueDefinitions | Queues.View |
| GetQueueDefinitions(Id) | Queues.View |
| レポート | Queues.View および Transactions.View |
| PutQueueDefinitions(Id) | Queues.Edit |
| PostQueueDefinitions | Queues.Create |
| DeleteQueueDefinitions(Id) | Queues.Delete |
QueueItemComments
| 操作 | 権限 |
|---|---|
| GetQueueItemComments | Queues.View および Transactions.View |
| GetQueueItemCommentsHistory | Queues.View および Transactions.View |
| GetQueueItemComments(Id) | Queues.View および Transactions.View |
| PostQueueItemComments | Queues.View および Transactions.Edit |
| PutQueueItemComments(Id) | Queues.View および Transactions.Edit |
| DeleteQueueItemComments(Id) | Queues.View および Transactions.Edit |
LicensesNamedUser
| 操作 | 権限 |
|---|---|
GET - /odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='{robotType}') | License.View |
LicensesRuntime
| 操作 | 権限 |
|---|---|
GET - /odata/LicensesRuntime/UiPath.Server.Configuration.OData.GetLicensesRuntime(robotType='robotType') | License.View |
POST - /odata/LicensesRuntime('{Key}')/UiPath.Server.Configuration.OData.ToggleEnabled | Machines.Edit |
QueueItem イベント
| 操作 | 権限 |
|---|---|
GET - /odata/QueueItemEvents | Queues.View および Transactions.View |
GET - /odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=queueItemId) | Queues.View および Transactions.View |
GET - /odata/QueueItemEvents(Id) | Queues.View および Transactions.View |
QueueItems
| 操作 | 権限 |
|---|---|
| GetQueueItems | Queues.View および Transactions.View |
| GetQueueItems(Id) | Queues.View および Transactions.View |
| SetTransactionProgress | Queues.View および Transactions.Edit |
| GetItemProcessingHistory | Queues.View および Transactions.View |
| SetItemReviewStatus | Queues.View および Transactions.Edit |
| DeleteQueueItems(Id) | Queues.View および Transactions.Delete |
| DeleteBulk | Queues.View および Transactions.Delete |
| SetItemReviewer | Queues.View および Transactions.Edit |
| UnsetItemReviewer | Queues.View および Transactions.Edit |
| GetReviewers | Queues.View および Transactions.Edit |
QueueProcessingRecords
| 操作 | 権限 |
|---|---|
| RetrieveLastDaysProcessingRecords | Queues.View および Transactions.View |
| RetrieveQueuesProcessingStatus | Queues.View |
キュー
| 操作 | 権限 |
|---|---|
| SetTransactionResult | Queues.View および Transactions.Edit |
| AddQueueItem | Queues.View および Transactions.Create |
| StartTransaction | Queues.View および Transactions.View および Transactions.Create および Transactions.Edit |
| BulkAddQueueItems | Queues.View および Transactions.Create |
リリース
| 操作 | 権限 |
|---|---|
GET - /odata/Releases({Id}) | Processes.View |
GET - /odata/Releases | Processes.View |
POST - /odata/Releases | Processes.Create |
DELETE - /odata/Releases({Id}) | Processes.Delete |
PATCH - /odata/Releases({Id}) | Processes.Edit |
PUT - /odata/Releases({Id}) | Processes.Edit |
POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersion | Processes.Edit |
POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersion | Processes.Edit |
POST - /odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionBulk | Processes.Edit |
POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersion | Processes.Edit |
UserLoginAttempts
| 操作 | 権限 |
|---|---|
GET - /odata/UserLoginAttempts({Id}) | 認証が必要です。 |
RobotLogs
| 操作 | 権限 |
|---|---|
| GetRobotLogs | Logs.View |
| GetTotalCount | Logs.View |
| レポート | Logs.View |
ロボット
| 操作 | 権限 |
|---|---|
GET - /odata/Robots | Robots.View |
GET - /odata/Robots({Id}) | Robots.View |
POST - /odata/Robots | Robots.Create |
PUT - /odata/Robots({Id}) | Robots.Edit |
PATCH - /odata/Robots({Id}) | Robots.Edit |
DELETE - /odata/Robots({Id}) | Robots.Delete |
POST - /odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk | Robots.Delete |
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetMachineNameToLicenseKeyMappings() | Robots.Create および Machines.View |
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetUsernames() | Robots.View |
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='{processId}') | Robots.View および Environments.View および Processes.View |
POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating | Robots.Edit |
ProcessSchedules
| 操作 | 権限 |
|---|---|
| GetProcessSchedules | Schedules.View |
| GetProcessSchedules(Id) | Schedules.View |
| GetRobotIdsForSchedule | Schedules.View |
| PostProcessSchedules | Schedules.Create |
| PutProcessSchedules(Id) | Schedules.Edit |
| SetEnabled | Schedules.Edit |
| DeleteProcessSchedules(Id) | Schedules.Delete |
セッション
| 操作 | 権限 |
|---|---|
| GetSessions | Robots.View |
ロール
| 操作 | 権限 |
|---|---|
| GetRoles | Roles.View |
| GetRoles(Id) | Roles.View |
| PostRoles | Roles.Create |
| PutRoles(Id) | Roles.Edit |
| DeleteRoles(Id) | Roles.Delete |
| SetUsers | Users.Edit |
| GetUsersForRole | Roles.View および Users.View |
| GetUserIdsForRole | Roles.View or Users.View |
設定
| 操作 | 権限 |
|---|---|
| GetSettings | Settings.View |
| GetSettings(Id) | Settings.View |
| PutSettings(Id) | Settings.Edit |
| UpdateBulk | Settings.Edit |
| GetWebSettings | 認証が必要です。 |
| GetExecutionSettingsConfiguration | Settings.Edit または Robots.Create または Robots.Edit |
| UploadLicense | License.Create or License.Edit |
| DeleteLicense | License.Deletes |
| GetLicense | 認証が必要です。 |
Stats
| 操作 | 権限 |
|---|---|
| GetSessionsStats | Robots.View |
| GetJobsStats | Jobs.View |
ユーザー
| 操作 | 権限 |
|---|---|
| GetUsers | Users.View |
| GetUsers(Id) | Users.View |
| PostUsers | Users.Create |
| PutUsers | Users.Edit |
| PatchUsers(Id) | Users.Edit |
| DeleteUsers(Id) | Users.Delete |
| GetCurrentPermissions | 認証が必要です。 |
| ToggleRole | Users.Edit |
| ImportUsers | Users.Create |
| SetActive | Users.Edit |
| ChangeCulture | 認証が必要です。 |
マシン
| 操作 | 権限 |
|---|---|
GET - /odata/Machines | Machines.View |
GET - /odata/Machines({Id}) | Machines.View |
POST - /odata/Machines | Machines.Create |
PUT - /odata/Machines({Id}) | Machines.Edit |
DELETE - /odata/Machines({Id}) | Machines.Delete |
POST - /odata/Machines/UiPath.Server.Configuration.OData.DeleteBulk | Machines.Delete |
PATCH - /odata/Machines({Id}) | Machines.Edit |
Webhook
| 操作 | 権限 |
|---|---|
| GetWebhooks | Webhooks.View |
| GetWebhooks(Id) | Webhooks.View |
| PostWebhooks | Webhooks.Create |
| PutWebhooks(Id) | Webhooks.Edit |
| PatchWebhooks(Id) | Webhooks.Edit |
| DeleteWebhooks | Webhooks.Delete |
| Ping | Webhooks.View |
| GetEventTypes | Webhooks.View |
| TriggerCustom | Webhooks.View |
テスト オートメーション
| 操作 | 権限 |
|---|---|
POST - /api/TestAutomation/StartTestSetExecution | TestSetExecutions.Create |
POST - /api/TestAutomation/CancelTestSetExecution | TestSetExecutions.Edit |
POST - /api/TestAutomation/CancelTestCaseExecution | TestSetExecutions.Edit |
GET - /api/TestAutomation/GetAssertionScreenshot | TestSetExecutions.View |
POST - /api/TestAutomation/CreateTestSetForReleaseVersion | TestSets.Create |
GET - /odata/TestCaseDefinitions | TestSets.View |
GET - /odata/TestCaseExecutions | TestSetExecutions.View |
GET - /odata/TestCaseExecutions({Id}) | TestSetExecutions.View |
GET - /odata/TestSetExecutions | TestSetExecutions.View |
GET - /odata/TestCaseExecutions({Id}) | TestSetExecutions.View |
GET - /odata/TestSets | TestSets.View |
POST - /odata/TestSets | TestSets.Create |
DELETE - /odata/TestSets({Id}) | TestSets.Delete |
GET - /odata/TestSets({Id}) | TestSets.View |
PUT - /odata/TestSets({Id}) | TestSets.Edit |
GET - /odata/TestSetSchedules | TestSetSchedules.View |
POST - /odata/TestSetSchedules | TestSetSchedules.Create |
DELETE - /odata/TestSetSchedules({Id}) | TestSetSchedules.Delete |
GET - /odata/TestSetSchedules({Id}) | TestSetSchedules.View |
PUT - /odata/TestSetSchedules({Id}) | TestSetSchedules.Edit |
POST - /odata/TestSetSchedules/UiPath.Server.Configuration.OData.SetEnabled | TestSetSchedules.Edit |
- 一般的なタスク
- タスク フォーム
- タスク カタログ
- タスク
- 実行メディア
- フォルダー
- ライブラリ
- アラート
- アセット
- AuditLogs
- バケット
- 環境 (ロボット グループ)
- ジョブ
- ログ
- 権限
- プロセス
- QueueDefinitions
- QueueItemComments
- LicensesNamedUser
- LicensesRuntime
- QueueItem イベント
- QueueItems
- QueueProcessingRecords
- キュー
- リリース
- UserLoginAttempts
- RobotLogs
- ロボット
- ProcessSchedules
- セッション
- ロール
- 設定
- Stats
- ユーザー
- マシン
- Webhook
- テスト オートメーション