アラートの要求

Orchestrator integrates with Notification Service and uses the Automation Cloud Alerts framework. As a result, most alert operations, such as listing alerts and marking them as read, are exposed through the Automation Cloud Alerts API rather than a dedicated Orchestrator API.

詳しくは、『Automation Cloud API ガイド』の「アラート」をご覧ください。

Orchestrator does expose a dedicated endpoint for raising process alerts.

Raising a process alert

The following request enables you to create a process alert tied to a specific process and robot, with a chosen severity.

POST

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert

必要なアクセス許可

Alerts.Create

要求ヘッダー

キー	値 (Value)
認可	Bearer
X-UIPATH-OrganizationUnitId	フォルダー ID
X-UIPATH-JobKey	Job Key

要求本文

{
    "processAlert": {
        "Message": "The invoice processing job stopped unexpectedly.",
        "Severity": "Error",
        "ProcessName": "InvoiceProcessing",
        "RobotName": "FinanceBot01"
    }
}

要求本文のパラメーター

パラメーター	入力	Required	説明
processAlert.Message	文字列	はい	The alert message. Maximum 512 characters.
processAlert.Severity	ENUM	はい	The severity level of the alert: Info, Success, Warn, Error, Fatal.
processAlert.RobotName	文字列	はい	The name of the robot that executed the process. Maximum 512 characters.
processAlert.ProcessName	文字列	はい	The name of the process that generated the alert. Maximum 512 characters.

応答コード

200 OK