orchestrator
latest
false
- 基本情報
- Swagger の定義
- Orchestrator API
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。
Orchestrator API ガイド
Orchestrator は通知サービスと連携し、Automation Cloud のアラート フレームワークを使用します。そのため、アラートのリスト表示や既読のマークなどのほとんどのアラート操作は、専用の Orchestrator API ではなく、Automation Cloud のアラート API を介して公開されます。
詳しくは、『Automation Cloud API ガイド』の「アラート」をご覧ください。
Orchestrator では、プロセス アラートを発生させるための専用のエンドポイントが公開されています。
プロセス アラートを生成する
次のリクエストでは、特定のプロセスとロボットに関連付けられた、重要度を設定したプロセス アラートを作成できます。
POST
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
必要なアクセス許可
Alerts.Create
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
| X-UIPATH-OrganizationUnitId | フォルダー ID |
| X-UIPATH-ジョブ キー | ジョブ キー |
要求本文
{
"processAlert": {
"Message": "The invoice processing job stopped unexpectedly.",
"Severity": "Error",
"ProcessName": "InvoiceProcessing",
"RobotName": "FinanceBot01"
}
}
{
"processAlert": {
"Message": "The invoice processing job stopped unexpectedly.",
"Severity": "Error",
"ProcessName": "InvoiceProcessing",
"RobotName": "FinanceBot01"
}
}
要求本文のパラメーター
| パラメーター | 入力 | Required | 説明 |
|---|---|---|---|
processAlert.Message | 文字列 | はい | アラートメッセージです。 最大 512 文字です。 |
processAlert.Severity | ENUM | はい | アラートの重大度レベルです。 Info、 Success、 Warn、 Error、 Fatalです。 |
processAlert.RobotName | 文字列 | はい | プロセスを実行したロボットの名前です。最大 512 文字です。 |
processAlert.ProcessName | 文字列 | はい | アラートを生成したプロセスの名前です。最大 512 文字です。 |
応答コード
200 OK