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

Toggle Pane

• FlowEndpointAlerts
  • getRetrieves a specific flow endpoint alert configuration
  • delDeletes a specific flow endpoint alert configuration
  • getRetrieves alert configurations for a specific flow endpoint
  • postCreates a new flow endpoint alert configuration
  • putUpdates an existing flow endpoint alert configuration
  • putSaves flow endpoint alert configuration (creates new or updates existing)
  • delDeletes all alert configurations for a specific flow endpoint

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

FlowEndpointAlerts

Retrieves a specific flow endpoint alert configuration

Returns alert configuration for a specific flow endpoint including thresholds and notification settings.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointAlertId required

integer <int32> Unique identifier of the flow endpoint alert

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

https://us.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

https://uk.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

https://eu.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

https://au.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific flow endpoint alert configuration

Removes alert configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointAlertId required

integer <int32> Unique identifier of the flow endpoint alert to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

https://uk.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

https://eu.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

https://au.thruinc.com/api/FlowEndpointAlerts/{flowEndpointAlertId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves alert configurations for a specific flow endpoint

Returns alert configuration for a specific flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId required

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

https://us.thruinc.com/api/FlowEndpointAlerts/getByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointAlerts/getByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointAlerts/getByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointAlerts/getByFlowEndpointId

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new flow endpoint alert configuration

Establishes new alert configuration with activity and queue depth thresholds.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint alert configuration details

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

https://us.thruinc.com/api/FlowEndpointAlerts

https://uk.thruinc.com/api/FlowEndpointAlerts

https://eu.thruinc.com/api/FlowEndpointAlerts

https://au.thruinc.com/api/FlowEndpointAlerts

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "activityAlertMinutes": 0,
• "queueDepthIsEnabled": true,
• "queueDepthAlertHours": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "queueDepthAlertCount": 0

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing flow endpoint alert configuration

Modifies existing alert configuration including notification thresholds and settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated flow endpoint alert configuration

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

https://us.thruinc.com/api/FlowEndpointAlerts

https://uk.thruinc.com/api/FlowEndpointAlerts

https://eu.thruinc.com/api/FlowEndpointAlerts

https://au.thruinc.com/api/FlowEndpointAlerts

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "activityAlertMinutes": 0,
• "queueDepthIsEnabled": true,
• "queueDepthAlertHours": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "queueDepthAlertCount": 0

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves flow endpoint alert configuration (creates new or updates existing)

Creates new alert configuration if ID is 0, otherwise updates existing configuration.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint alert configuration to save

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
activityAlertMinutes	integer <int32>
queueDepthIsEnabled	boolean
queueDepthAlertHours	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
queueDepthAlertCount	integer or null <int32>

https://us.thruinc.com/api/FlowEndpointAlerts/save

https://uk.thruinc.com/api/FlowEndpointAlerts/save

https://eu.thruinc.com/api/FlowEndpointAlerts/save

https://au.thruinc.com/api/FlowEndpointAlerts/save

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "activityAlertMinutes": 0,
• "queueDepthIsEnabled": true,
• "queueDepthAlertHours": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "queueDepthAlertCount": 0

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all alert configurations for a specific flow endpoint

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId required

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

any

https://us.thruinc.com/api/FlowEndpointAlerts/deleteByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointAlerts/deleteByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointAlerts/deleteByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointAlerts/deleteByFlowEndpointId

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample