- 基本情報
- 認証
- Swagger の定義
- Orchestrator API
- プラットフォーム管理 API
Orchestrator API ガイド
応答コード
Orchestrator API は、すべての要求に対して適切な HTTP ステータス コードを 返そうとします。
それに加えて、カスタム エラー コードも返します。以下の表で、各エラーと、エラーが発生する条件について説明します。
| コード | テキスト | 説明 |
|---|---|---|
| 1000 | 要求が無効です。 Invalid username/email address or password. OData クエリ オプションが無効です。 | 一般 |
| 1001 |
名前 [CustomNameYouAdded] は既に使用されています。 | データベースに既に存在する名前を持つリソースを作成または編集しようとした場合にスローされるエラー メッセージです。 このエラーは、以下のエンドポイントに対して返されます。
|
| 1002 |
このロボットは存在しません。 | データベースに存在しないリソースに要求を送信した場合にスローされるエラー メッセージです。テナント、アセット、ジョブ、ホスト ライセンス、キューとキュー アイテム、プロセス、設定、ユーザーに対して返されます。 |
| 1003 |
指定した文字列に対する保護の呼び出しに失敗しました。 |
|
| 1004 |
| このメッセージは、データベースに既に存在するアセットまたはロボットを作成しようとした場合にスローされます。パッケージのアップロード時にも適用されます。 |
| 1006 |
|
|
| 1007 |
| このエラーは、/odata/QueueItemComments(Id) エンドポイントに PUT 要求を送信することで、別のユーザーが追加したトランザクション コメントを更新しようとした場合に表示されます。 |
| 1008 |
| /odata/Users エンドポイントに対して POST、PUT、または PATCH 要求を実行したときに、Orchestrator がユーザーにメールを送信できなかった場合にスローされるエラーです。 |
| 1009 |
引数が無効です: '[ArgumentName]' | |
| 1010 |
| |
| 1011 |
ライブラリ フィードを開くことができません。後でもう一度お試しください。 | このメッセージは、さまざまな理由によりライブラリ フィードにアクセスできない場合に表示されます。 このエラーは、以下のエンドポイントから返される可能性があります。
|
| 1012 |
| このエラーは、削除しようとしている組織単位にユーザーが関連付けられている場合にスローされます。/odata/OrganizationUnits エンドポイントに DELETE 呼び出しを送信した場合に表示されるエラーです。 |
| 1013 |
パッケージはアクティブなプロセスで参照されているため削除できません。 | アクティブなパッケージ バージョンを削除しようとした場合に表示されるエラーです。たとえば、https://uipath.platform.com/odata/Processes('input_output_test%3A1.1.0') に DELETE 要求を送信した場合に表示されます。削除できるのは、非アクティブな (ロボット グループに関連付けられていない) パッケージのみです。 |
| 1014 |
パラメーター '[パラメーター名]' がありません。 | 必要なパラメーターが指定されていない場合にスローされる一般的なエラーです。 このエラーは、以下のエンドポイントで表示される可能性があります。
|
| 1015 |
パラメーター [パラメーター名] は無効です。 Value should be between 0 and 168. | このエラーは、次のシナリオで表示されます。
|
| 1016 |
[参照名] の作成エラーです。重複参照。(例: UiPath.Core.Model.Queues.UiQueueItem の作成エラーです。重複参照。) | このエラーは、既に存在する参照を含むキュー アイテムを追加しようとした場合に表示されます。一意の参照でのみ動作するようにキューを設定した場合にのみ発生します。 |
| 1017 |
指定したパッケージのダウンロードは許可されていません。 利用規約を承諾する必要があります。 | 認証に使用したユーザーが、/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='key') または '/odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='{key に対して GET 要求を実行して特定のパッケージまたはライブラリをダウンロードする権限を持っていない場合に表示されるメッセージです。 |
| 1018 |
AD ドメインに接続できません。 そのユーザーは存在しません。 | このエラー メッセージは、指定したドメインのメンバーではない Active Directory ユーザーをインポートしようとした場合に表示されます。 |
| 1050 |
特定の関係を含めることはできません。 | 監査 |
| 1100 |
このユーザーは組織単位に関連付けられていません。 | 組織単位が有効化されている場合にのみ表示されます。 このエラーは、アクセスしようとしている組織単位とは異なる組織単位に関連付けられたユーザーを使用して呼び出しを実行しようとした場合に表示されます。 |
| 1101 |
| Orchestrator インスタンスで組織単位が有効化されている場合にのみ表示されます。 このエラーは、組織単位をパラメーターとして含めずにエンドポイントに POST 要求を送信した場合にスローされます。 |
| 1102 |
組織単位が存在しないか、ユーザーと関連付けられていません。 | 組織単位が有効化されている場合にのみ表示されます。 /odata/Users(Id)/UiPath.Server.Configuration.OData.ToggleOrganizationUnit エンドポイントに POST 要求を送信するとスローされます。 |
| 1200 |
このマシンには既に異なるライセンス キーを持つロボットがあります。 | このエラー メッセージは、指定したマシンに既に異なるライセンス キーを持つロボットが存在する場合に表示されます。以下のエンドポイントに対してスローされます。
|
| 1201 |
| このエラー メッセージは、ジョブを開始しようとしているロボットに対して、Orchestrator にこれ以上ライセンスがない場合にスローされます。 |
| 1202 |
ロボットが接続されているため、マシン [マシン名] を削除することができません。 | このエラー メッセージは、ロボットが定義されているマシンを削除しようとした場合にスローされます。 |
| 1203 |
ライセンス キーが無効です。 このマシン キーは別のマシンに紐づけられています。 | ロボット |
| 1204 |
| ロボット |
| 1205 |
パスワードが設定されている場合は、ユーザー名が必要です。 | |
| 1206 |
ビジーなロボットは変更や削除ができません。 | このメッセージは、現在ジョブを実行しているロボットを削除しようとした場合に表示されます。 |
| 1207 |
| ロボット |
| 1208 | MachineLicenseCannotChange ; InvalidNonProductionMachineSlots ; InvalidUnattendedMachineSlots | ロボット |
| 1209 |
ビジー状態のロボットのユーザー名、マシンまたは種類は更新できません。 | このメッセージは、現在ジョブを実行しているロボットを更新しようとした場合に表示されます。 |
| 1222 |
| ロボットが Orchestrator から切断されたときにトリガーされるアラートです。 |
| 1223 |
| Orchestrator に接続されているロボットのステータスが「応答なし」になったときにトリガーされるアラートです。 |
| 1250 |
| このエラー メッセージは、次の場合にスローされます。
|
| 1300 |
| 競合 (409) |
| 1301 |
| 競合 (409) |
| 1302 |
| 競合 (409) |
| 1400 |
| 認可、ユーザー、ロール |
| 1401 |
| 認可、ユーザー、ロール |
| 1403 |
パスワードを変更 | 認可、ユーザー、ロール |
| 1404 |
パスワードは期限切れです。 | このエラー メッセージは、ログインに使用しているパスワードが期限切れの場合に表示されます。 |
| 1405 |
| 認可、ユーザー、ロール |
| 1406 |
| このメッセージは、Administrator ロールを削除しようとした場合に表示されます。 |
| 1407 |
| 現在認証に使用しているユーザーに、指定したユーザーを編集する権限がありません。 |
| 1408 |
| 認可、ユーザー、ロール |
| 1409 |
| このエラー メッセージは、パスワードのリセット手順が失敗した場合に表示されます。 |
| 1410 |
メールの確認に失敗しました。 | |
| 1411 |
| このエラーは、パスワードのリセット手順で古いパスワードを使用しようとした場合に返されます。 |
| 1412 |
| このメッセージは、Administrator ロールに変更を加えようとした場合に表示されます。Administrator ロールは編集不可です。 |
| 1413 |
| このエラーは、Orchestrator にプロビジョニングしようとしているドメイン ユーザーが、定義された Active Directory に属していない場合にスローされます。 |
| 1414 |
ユーザー名を更新できません。 | 認可、ユーザー、ロール |
| 1415 |
| 認可、ユーザー、ロール |
| 1500 |
新しいユーザーの資格情報にパスワードを設定してください。 | |
| 1501 |
新しいロボットの資格情報にパスワードを設定してください。 | このメッセージは、資格情報アセットを作成するときに併せてパスワードの値を指定していない場合に表示されます。 |
| 1502 |
アセットの種類を更新することはできません。 | このエラーは、PUT 要求を通じてアセットの種類を変更しようとした場合にスローされます。 |
| 1503 |
アセットにこのロボットに関連する値がありません。 | このメッセージは、実行した要求がロボットごとのアセットを対象としていたものの、指定したロボットが指定したアセットに関連付けられていない場合に表示されます。 |
| 1600 |
cron 式の構文が無効です。 | 追加しようとしたスケジュールに有効ではない cron 式が含まれています。 |
| 1601 |
| |
| 1650 |
| プロセス/パッケージ/ジョブ |
| 1651 |
パッケージ フィードに接続できません。URL が無効である可能性があります。 | プロセス/パッケージ/ジョブ |
| 1652 |
外部フィードによってサポートされていません。 | プロセス/パッケージ/ジョブ |
| 1653 |
| プロセス/パッケージ/ジョブ |
| 1654 |
パッケージの詳細が無効です。 | プロセス/パッケージ/ジョブ |
| 1655 |
パッケージ フィードを開くことができません。後でもう一度お試しください。 | プロセス/パッケージ/ジョブ |
| 1656 |
| プロセス/パッケージ/ジョブ |
| 1657 |
| プロセス/パッケージ/ジョブ |
| 1658 |
ステータス [ステータス] のジョブをキャンセルできません。これは、実行中、保留中、または停止中のジョブにのみ適用できます。 | このメッセージは、ステータスが [成功]、[エラー]、[終了中]、[停止] のいずれかであるジョブをキャンセルしようとした場合に表示されます。 |
| 1659 |
ステータス [ステータス] のジョブを終了できません。これは、実行中、保留中、または停止中のジョブにのみ適用できます。 | このエラーは、ステータスが [成功]、[エラー]、[停止] のいずれかであるジョブをキャンセルしようとした場合に表示されます。 |
| 1660 |
ジョブのパッケージ [PackageName]、バージョン [VersionNumber] が見つかりませんでした。 | このエラーは、ジョブを開始しようとしたときに、指定したバージョンのパッケージが NuGet フィードで見つからない場合にスローされます。 |
| 1661 | ProcessNotFound PackageNotFound を入力します。 関連付けられたプロセスは存在しません。 | プロセス/パッケージ/ジョブ |
| 1662 |
| プロセス/パッケージ/ジョブ |
| 1663 |
| プロセス/パッケージ/ジョブ |
| 1664 |
| プロセス/パッケージ/ジョブ |
| 1665 |
| プロセス/パッケージ/ジョブ |
| 1666 |
| プロセス/パッケージ/ジョブ |
| 1667 |
テナントが見つかりません。 | |
| 1670 |
ロボットには既にこのプロセスに対する保留中のジョブがあります。 | このメッセージは、保留中のジョブが既に同じプロセスとロボットにある場合に表示されます。 |
| 1671 |
指定したロボット ID は無効です。 | プロセス/パッケージ/ジョブ |
| 1672 |
ジョブを開始することはできません。有効なライセンスが必要です。 | プロセス/パッケージ/ジョブ |
| 1673 |
ライセンスの有効期限が切れているため、ジョブを開始できません。 | プロセス/パッケージ/ジョブ |
| 1674 |
プロセスが定義されていません。 | ジョブを開始しようとしているプロセスの ID が有効ではありません。 |
| 1675 |
パッケージ バージョンが無効です。 | プロセス/パッケージ/ジョブ |
| 1676 |
テナント [NameOfTenant] は無効です。 | プロセス/パッケージ/ジョブ |
| 1677 | PackageNotFound | |
| 1678 |
| このエラーは、スケジュールで利用可能なロボットがないために、ジョブを作成できない場合にスローされます。 |
| 1679 | PathTooLong | |
| 1680 |
| このアラートは、ジョブが失敗した場合に生成されます。 |
| 1700 |
| サードパーティのコンポーネント |
| 1750 |
| ログ |
| 1800 |
| 構成 |
| 1801 |
設定された暗号化キーが有効な Base64 形式ではありません。 | 構成 |
| 1850 |
| キュー/キュー アイテム |
| 1851 |
| 更新しようとしているトランザクションの進行状況ステータスが、実行する更新に対して正しいステータスではありません。 |
| 1852 |
| キュー/キュー アイテム |
| 1853 |
| レビュー担当者としてトランザクションに割り当てようとしているユーザーに、必要な権限 (トランザクションに対する [表示] 権限と [編集] 権限) がありません。 |
| 1855 |
| キュー/キュー アイテム |
| 1856 |
| このエラー メッセージは、項目に対してアプリケーション エラーがスローされ、これ以上再試行されない場合に表示されます。 |
| 1900 |
ライセンスが見つかりません。 | ライセンス |
| 1901 |
ライセンスが失効しています。 | ライセンス |
| 1902 |
ライセンスは既に使用中です。 | ライセンス |
| 1903 |
ライセンス形式が無効です。 | ライセンス |
| 1904 |
| ライセンス |
| 1905 |
| ライセンス |
| 1906 |
| ライセンス |
| 1907 |
| ライセンス |
| 1908 |
| ライセンス |
| 1909 |
| ライセンス |
| 1910 |
| ライセンス |
| 1911 |
| ライセンス |
| 1912 |
| ライセンス |
| 1913 |
| ライセンス |
| 1914 |
ロボットのライセンス付与に失敗しました。サーバー上に利用可能なライセンスがありません。 | このエラー メッセージは、ライセンスが付与されていないマシンでジョブを実行しようとした場合、ジョブのステートが [保留中] である場合、またはロボットが割り当てられている場合に、[ジョブの詳細] に表示されます。 |
| 1915 |
ロボットのライセンス付与に失敗しました。サーバー上に利用可能なライセンスがありません。 | |
| 1916 |
利用可能なライセンスがありません: 新しいマシンのスロットの数がライセンスの合計数を超えます。 | ライセンス |
| 1917 |
割り当て可能な {0} ライセンスが足りません。 | ライセンス |
| 1918 |
| ライセンス |
| 1919 |
| ライセンス |
| 1920 |
| ライセンス |