Orchestrator API 指南

上次更新日期 2026年5月21日

适用平台：

警示请求

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.

发布

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

所需权限

Alerts.Create

请求标头

密钥	值
授权	承载
X-UIPATH-OrganizationUnitId	文件夹 ID
X-UIPATH-JobKey	Job Key

请求正文

{
    "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"
    }
}

请求正文参数

参数	类型	必填	描述
`processAlert.Message`	字符串	是	The alert message. Maximum 512 characters.
`processAlert.Severity`	枚举	是	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

在此页面上

Raising a process alert
所需权限
请求标头
请求正文
请求正文参数
响应代码

此页面有帮助吗？

前一个管理逻辑资源

下一个应用程序任务请求

Orchestrator API 指南

Raising a process alert​

所需权限​

请求标头​

请求正文​

请求正文参数​

响应代码​