Waiting for engine...
Skip to main content

Boomi MFT - AFT Management API Reference (v1) - Alerts

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Alerts

Retrieves an alert history record by ID

Authorizations:
ApiKeyBearer
query Parameters
alertHistoryId
integer <int64>

Unique identifier of the alert history record to retrieve

Responses

Response Schema:
id
integer <int64>
tenantId
integer <int32>
activeAlertId
integer <int64>
referenceId
integer <int64>
referenceType
string or null
alertTypeId
integer <int32>
alertSeverityId
integer <int32>
message
string or null
flowCode
string or null
endpointCode
string or null
organizationCode
string or null
createdDate
string <date-time>
acknowledgedDate
string or null <date-time>
acknowledgedBy
integer or null <int32>
clearedDate
string or null <date-time>
clearedBy
integer or null <int32>

Response samples

Content type
No sample

Retrieves a formatted view of alert history for display purposes

Authorizations:
ApiKeyBearer
query Parameters
alertHistoryId
integer <int64>

Unique identifier of the alert history record

Responses

Response Schema:
id
integer <int64>
tenantId
integer <int32>
activeAlertId
integer <int64>
referenceId
integer <int64>
referenceType
string or null
alertTypeId
integer <int32>
alertType
string or null
alertSeverityId
integer <int32>
severityName
string or null
message
string or null
flowCode
string or null
flowName
string or null
flowId
integer or null <int32>
isFlowDeleted
boolean
endpointCode
string or null
endpointName
string or null
endpointId
integer or null <int32>
isEndpointDeleted
boolean
organizationCode
string or null
organizationName
string or null
organizationId
integer or null <int32>
isOrganizationDeleted
boolean
nodeName
string or null
nodeId
integer <int32>
thruNodeId
string or null
isNodeDeleted
boolean
createdDate
string or null
acknowledgedDate
string or null
acknowledgedBy
integer or null <int32>
clearedDate
string or null
clearedBy
integer or null <int32>
state
string or null

Response samples

Content type
No sample

Retrieves a specific active alert by ID

Authorizations:
ApiKeyBearer
query Parameters
activeAlertId
integer <int64>

Unique identifier of the active alert to retrieve

Responses

Response Schema:
id
integer <int32>
tenantId
integer <int32>
referenceId
integer <int64>
referenceType
string or null
alertTypeId
integer <int32>
alertSeverityId
integer <int32>
message
string or null
flowCode
string or null
endpointCode
string or null
organizationCode
string or null
createdDate
string <date-time>
acknowledgedDate
string or null <date-time>
acknowledgedBy
integer or null <int32>
clearedDate
string or null <date-time>
clearedBy
integer or null <int32>

Response samples

Content type
No sample

Retrieves a filtered list of active alerts

Supports filtering by date range, alert type, severity level, and affected components

Authorizations:
ApiKeyBearer
Request Body schema:

Filter criteria for active alerts including date range, severity, and affected components

tenantId
integer <int32>
alertTypeId
integer <int32>
state
string or null
flowCode
string or null
endpointCode
string or null
organizationCode
string or null
fromDate
string or null
toDate
string or null

Responses

Response Schema:
Array
id
integer <int32>
tenantId
integer <int32>
referenceId
integer <int64>
referenceType
string or null
alertTypeId
integer <int32>
alertSeverityId
integer <int32>
message
string or null
flowCode
string or null
endpointCode
string or null
organizationCode
string or null
createdDate
string <date-time>
acknowledgedDate
string or null <date-time>
acknowledgedBy
integer or null <int32>
clearedDate
string or null <date-time>
clearedBy
integer or null <int32>

Request samples

Content type
{
  • "tenantId": 0,
  • "alertTypeId": 0,
  • "state": "string",
  • "flowCode": "string",
  • "endpointCode": "string",
  • "organizationCode": "string",
  • "fromDate": "string",
  • "toDate": "string"
}

Response samples

Content type
No sample

Retrieves historical alert records with filtering capabilities

Provides comprehensive alert history for monitoring and audit purposes

Authorizations:
ApiKeyBearer
Request Body schema:

Filter criteria for alert history including date range, state, severity, and alert type

tenantId
integer <int32>
alertTypeId
integer <int32>
state
string or null
flowCode
string or null
endpointCode
string or null
organizationCode
string or null
fromDate
string or null
toDate
string or null

Responses

Response Schema:
Array
id
integer <int64>
tenantId
integer <int32>
activeAlertId
integer <int64>
referenceId
integer <int64>
referenceType
string or null
alertTypeId
integer <int32>
alertType
string or null
alertSeverityId
integer <int32>
severityName
string or null
message
string or null
flowCode
string or null
flowName
string or null
flowId
integer or null <int32>
isFlowDeleted
boolean
endpointCode
string or null
endpointName
string or null
endpointId
integer or null <int32>
isEndpointDeleted
boolean
organizationCode
string or null
organizationName
string or null
organizationId
integer or null <int32>
isOrganizationDeleted
boolean
nodeName
string or null
nodeId
integer <int32>
thruNodeId
string or null
isNodeDeleted
boolean
createdDate
string or null
acknowledgedDate
string or null
acknowledgedBy
integer or null <int32>
clearedDate
string or null
clearedBy
integer or null <int32>
state
string or null

Request samples

Content type
{
  • "tenantId": 0,
  • "alertTypeId": 0,
  • "state": "string",
  • "flowCode": "string",
  • "endpointCode": "string",
  • "organizationCode": "string",
  • "fromDate": "string",
  • "toDate": "string"
}

Response samples

Content type
No sample

Retrieves the total count of active alerts

Authorizations:
ApiKeyBearer

Responses

Response Schema:
integer <int32>

Response samples

Content type
No sample

Acknowledges an active alert to indicate it has been reviewed

Authorizations:
ApiKeyBearer
query Parameters
alertId
integer <int64>

Unique identifier of the active alert to acknowledge

Responses

Response Schema:
object (thruStatus)
data
any or null

Response samples

Content type
No sample

Acknowledges a historical alert to indicate it has been reviewed

Authorizations:
ApiKeyBearer
query Parameters
alertId
integer <int64>

Unique identifier of the historical alert to acknowledge

Responses

Response Schema:
object (thruStatus)
data
any or null

Response samples

Content type
No sample

Clears an active alert from the system

Authorizations:
ApiKeyBearer
query Parameters
alertId
integer <int64>

Unique identifier of the active alert to clear

Responses

Response Schema:
object (thruStatus)
data
any or null

Response samples

Content type
No sample

Clears a historical alert record from the system

Authorizations:
ApiKeyBearer
query Parameters
alertId
integer <int64>

Unique identifier of the historical alert to clear

Responses

Response Schema:
object (thruStatus)
data
any or null

Response samples

Content type
No sample

Clears multiple historical alert records in bulk operation

Authorizations:
ApiKeyBearer
Request Body schema:

List of unique identifiers for historical alerts to clear

Array
integer <int64>

Responses

Response Schema:
object (thruStatus)
data
any or null

Request samples

Content type
[
  • 0
]

Response samples

Content type
No sample

Clears all alerts from the system (both active and historical)

Authorizations:
ApiKeyBearer

Responses

Response Schema:
object (thruStatus)
data
any or null

Response samples

Content type
No sample