Solicitações de alertas

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.

Para obter detalhes, consulte a seção Alertas no guia da API do Automation Cloud.

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.

Postar

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

Permissões necessárias

Alerts.Create

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador
X-UIPATH-OrganizationUnitId	ID da Pasta
X-UIPATH-JobKey	Job Key

Corpo da Solicitação

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

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Required	Description
processAlert.Message	String	Sim	The alert message. Maximum 512 characters.
processAlert.Severity	ENUM	Sim	The severity level of the alert: Info, Success, Warn, Error, Fatal.
processAlert.RobotName	String	Sim	The name of the robot that executed the process. Maximum 512 characters.
processAlert.ProcessName	String	Sim	The name of the process that generated the alert. Maximum 512 characters.

Código de resposta

200 OK