Import business process
  • 12 Mar 2024
  • 22 Minutes to read
  • Dark
    Light
  • PDF

Import business process

  • Dark
    Light
  • PDF

Article summary

Post
/BusinessActivityMonitoring/BusinessProcess/Import
Security
API Key
Header parameter nameAPIKey

API key which has access for your API

Query parameters
businessProcessGroupId
string (uuid)
Body parameters
Expand All
object
businessProcesses
Array of object (BusinessProcess)
object
id
string (uuid)
workspaceId
string (uuid)
businessProcessGroupId
string (uuid)
name
string
trackingName
string
description
string
path
string
isTrackingEnabled
boolean
isMonitoringEnabled
boolean
createdAt
string (date-time)
updatedAt
string (date-time)
additionalSettings
object (AdditionalSettings)
archiveMessage
boolean
purgeDays
integer (int32)
businessTransactions
Array of object (BusinessTransaction)
object
id
string (uuid)
name
string
trackingName
string
description
string
order
integer (int32)
direction
integer (int32)
Valid values[ 1, 2, 3 ]
stages
Array of object (Stage)
object
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
businessProcessId
string (uuid)
defaultReprocessStageName
string
allowedTrackingStatusForReprocess
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
configuration
object (Configuration)
class
string
nodeDataArray
Array of object (StageNode)
object
name
string
trackingName
string
key
string
id
string
category
string
iconPath
string
location
object (NodeLocation)
class
string
x
number (float)
y
number (float)
stage
object (Stage)
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
linkDataArray
Array of object (StageLink)
object
from
string
to
string
label
string
visible
boolean
updateTransactionStatusConfiguration
object (UpdateTransactionStatusConfiguration)
isUpdateTransactionStatus
boolean
isUpdatingTransactionStatus
boolean
lastUpdatedAt
string (date-time)
from
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
to
integer (int32)
Valid values[ 0, 1, 2, 3 ]
value
integer (int32)
timeGrain
string
serializedConfig
string
purgeDays
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
status
integer (int32)
Valid values[ 1, 2, 3, 4 ]
monitorConfiguration
object (MonitorConfiguration)
queryAlertSettings
object (QueryAlertSettings)
evaluationFrequency
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
maxAlertsPerHour
integer (int32)
notificationCount
integer (int32)
notificationChannelMapping
string
exceptionAlertSettings
object (ExceptionAlertSettings)
notificationChannelMapping
string
sendExceptionAlerts
boolean
maximumNumberOfAlerts
integer (int32)
duration
integer (int32)
durationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
perTransaction
boolean
perExceptionCode
boolean
note
string
exceptionMonitorConfigurations
Array of object (ExceptionMonitorConfiguration)
object
id
string (uuid)
exceptionType
string
condition
string
value
string
isEnabled
boolean
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
durationAlertSettings
object (DurationAlertSettings)
notificationChannelMapping
string
durationMonitorConfigurations
Array of object (DurationMonitorConfiguration)
object
id
string (uuid)
parentId
string (uuid)
name
string
type
integer (int32)
Valid values[ 0, 1, 2 ]
warningDuration
integer (int32)
warningDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
errorDuration
integer (int32)
errorDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
currentAlertHour
string (date-time)
lastRunAt
string (date-time)
isMonitorProcessing
boolean
monitorProcessingStartedAt
string (date-time)
qM_EscalationPolicyId
string (uuid)
dM_EscalationPolicyId
string (uuid)
eM_EscalationPolicyId
string (uuid)
eM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
qM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
dM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
escalationPolicyMappings
Array of object (EscalationPolicyMapping)
object
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
ruleRecipientMappings
Array of object (RuleRecipientMapping)
object
escalationRuleId
string (uuid)
customMailTemplateId
string (uuid)
recipients
string
id
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
alertIncidents
Array of object (AlertIncident)
object
id
string (uuid)
createdAt
string (date-time)
alertDescription
string
incidentStatus
integer (int32)
Valid values[ 1, 2, 3 ]
bA_AlertType
integer (int32)
Valid values[ 0, 1, 2, -1 ]
baMonitorConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
baM_AlertType
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
bamChannelConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
healthStatus
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
containerId
string (uuid)
templateMappingId
string (uuid)
incidentDetails
object (IncidentConfiguration)
assignmentInfo
Array of object (AssignmentInfo)
object
assignedRuleOrder
integer (int32)
assignedAt
string (date-time)
currentIteration
integer (int32)
transmittedNotificationChannels
Array of object (TransmittedNotificationChannel)
object
name
string
channelType
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
exception
string
transmittedAt
string (date-time)
userAssignmentInfo
Array of object (UserAssignmentInfo)
object
performedAt
string (date-time)
performedBy
string
description
string
oldState
integer (int32)
Valid values[ 1, 2, 3 ]
newState
integer (int32)
Valid values[ 1, 2, 3 ]
incidentStatusCountDetails
object (IncidentStatusCountDetails)
healthy
integer (int32)
warning
integer (int32)
error
integer (int32)
currentEscalationRuleOrder
integer (int32)
waitTillTime
string (date-time)
escalationPolicyId
string (uuid)
currentIteration
integer (int32)
globalProperties
Array of object (GlobalProperty)
object
id
string (uuid)
workspaceId
string (uuid)
name
string
dataType
string
dateFormat
string
createdAt
string (date-time)
updatedAt
string (date-time)
enabled
boolean
mappedBusinessProcesses
Array of object (MappedBusinessProcess)
object
id
string (uuid)
globalPropertyId
string (uuid)
businessProcessId
string (uuid)
configuration
object (MappedBusinessProcessConfiguration)
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
value
string
extractValueRegEx
string
Expand All
object
businessProcesses
Array of object (BusinessProcess)
object
id
string (uuid)
workspaceId
string (uuid)
businessProcessGroupId
string (uuid)
name
string
trackingName
string
description
string
path
string
isTrackingEnabled
boolean
isMonitoringEnabled
boolean
createdAt
string (date-time)
updatedAt
string (date-time)
additionalSettings
object (AdditionalSettings)
archiveMessage
boolean
purgeDays
integer (int32)
businessTransactions
Array of object (BusinessTransaction)
object
id
string (uuid)
name
string
trackingName
string
description
string
order
integer (int32)
direction
integer (int32)
Valid values[ 1, 2, 3 ]
stages
Array of object (Stage)
object
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
businessProcessId
string (uuid)
defaultReprocessStageName
string
allowedTrackingStatusForReprocess
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
configuration
object (Configuration)
class
string
nodeDataArray
Array of object (StageNode)
object
name
string
trackingName
string
key
string
id
string
category
string
iconPath
string
location
object (NodeLocation)
class
string
x
number (float)
y
number (float)
stage
object (Stage)
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
linkDataArray
Array of object (StageLink)
object
from
string
to
string
label
string
visible
boolean
updateTransactionStatusConfiguration
object (UpdateTransactionStatusConfiguration)
isUpdateTransactionStatus
boolean
isUpdatingTransactionStatus
boolean
lastUpdatedAt
string (date-time)
from
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
to
integer (int32)
Valid values[ 0, 1, 2, 3 ]
value
integer (int32)
timeGrain
string
serializedConfig
string
purgeDays
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
status
integer (int32)
Valid values[ 1, 2, 3, 4 ]
monitorConfiguration
object (MonitorConfiguration)
queryAlertSettings
object (QueryAlertSettings)
evaluationFrequency
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
maxAlertsPerHour
integer (int32)
notificationCount
integer (int32)
notificationChannelMapping
string
exceptionAlertSettings
object (ExceptionAlertSettings)
notificationChannelMapping
string
sendExceptionAlerts
boolean
maximumNumberOfAlerts
integer (int32)
duration
integer (int32)
durationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
perTransaction
boolean
perExceptionCode
boolean
note
string
exceptionMonitorConfigurations
Array of object (ExceptionMonitorConfiguration)
object
id
string (uuid)
exceptionType
string
condition
string
value
string
isEnabled
boolean
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
durationAlertSettings
object (DurationAlertSettings)
notificationChannelMapping
string
durationMonitorConfigurations
Array of object (DurationMonitorConfiguration)
object
id
string (uuid)
parentId
string (uuid)
name
string
type
integer (int32)
Valid values[ 0, 1, 2 ]
warningDuration
integer (int32)
warningDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
errorDuration
integer (int32)
errorDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
currentAlertHour
string (date-time)
lastRunAt
string (date-time)
isMonitorProcessing
boolean
monitorProcessingStartedAt
string (date-time)
qM_EscalationPolicyId
string (uuid)
dM_EscalationPolicyId
string (uuid)
eM_EscalationPolicyId
string (uuid)
eM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
qM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
dM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
escalationPolicyMappings
Array of object (EscalationPolicyMapping)
object
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
ruleRecipientMappings
Array of object (RuleRecipientMapping)
object
escalationRuleId
string (uuid)
customMailTemplateId
string (uuid)
recipients
string
id
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
alertIncidents
Array of object (AlertIncident)
object
id
string (uuid)
createdAt
string (date-time)
alertDescription
string
incidentStatus
integer (int32)
Valid values[ 1, 2, 3 ]
bA_AlertType
integer (int32)
Valid values[ 0, 1, 2, -1 ]
baMonitorConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
baM_AlertType
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
bamChannelConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
healthStatus
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
containerId
string (uuid)
templateMappingId
string (uuid)
incidentDetails
object (IncidentConfiguration)
assignmentInfo
Array of object (AssignmentInfo)
object
assignedRuleOrder
integer (int32)
assignedAt
string (date-time)
currentIteration
integer (int32)
transmittedNotificationChannels
Array of object (TransmittedNotificationChannel)
object
name
string
channelType
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
exception
string
transmittedAt
string (date-time)
userAssignmentInfo
Array of object (UserAssignmentInfo)
object
performedAt
string (date-time)
performedBy
string
description
string
oldState
integer (int32)
Valid values[ 1, 2, 3 ]
newState
integer (int32)
Valid values[ 1, 2, 3 ]
incidentStatusCountDetails
object (IncidentStatusCountDetails)
healthy
integer (int32)
warning
integer (int32)
error
integer (int32)
currentEscalationRuleOrder
integer (int32)
waitTillTime
string (date-time)
escalationPolicyId
string (uuid)
currentIteration
integer (int32)
globalProperties
Array of object (GlobalProperty)
object
id
string (uuid)
workspaceId
string (uuid)
name
string
dataType
string
dateFormat
string
createdAt
string (date-time)
updatedAt
string (date-time)
enabled
boolean
mappedBusinessProcesses
Array of object (MappedBusinessProcess)
object
id
string (uuid)
globalPropertyId
string (uuid)
businessProcessId
string (uuid)
configuration
object (MappedBusinessProcessConfiguration)
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
value
string
extractValueRegEx
string
Expand All
object
businessProcesses
Array of object (BusinessProcess)
object
id
string (uuid)
workspaceId
string (uuid)
businessProcessGroupId
string (uuid)
name
string
trackingName
string
description
string
path
string
isTrackingEnabled
boolean
isMonitoringEnabled
boolean
createdAt
string (date-time)
updatedAt
string (date-time)
additionalSettings
object (AdditionalSettings)
archiveMessage
boolean
purgeDays
integer (int32)
businessTransactions
Array of object (BusinessTransaction)
object
id
string (uuid)
name
string
trackingName
string
description
string
order
integer (int32)
direction
integer (int32)
Valid values[ 1, 2, 3 ]
stages
Array of object (Stage)
object
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
businessProcessId
string (uuid)
defaultReprocessStageName
string
allowedTrackingStatusForReprocess
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
configuration
object (Configuration)
class
string
nodeDataArray
Array of object (StageNode)
object
name
string
trackingName
string
key
string
id
string
category
string
iconPath
string
location
object (NodeLocation)
class
string
x
number (float)
y
number (float)
stage
object (Stage)
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
linkDataArray
Array of object (StageLink)
object
from
string
to
string
label
string
visible
boolean
updateTransactionStatusConfiguration
object (UpdateTransactionStatusConfiguration)
isUpdateTransactionStatus
boolean
isUpdatingTransactionStatus
boolean
lastUpdatedAt
string (date-time)
from
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
to
integer (int32)
Valid values[ 0, 1, 2, 3 ]
value
integer (int32)
timeGrain
string
serializedConfig
string
purgeDays
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
status
integer (int32)
Valid values[ 1, 2, 3, 4 ]
monitorConfiguration
object (MonitorConfiguration)
queryAlertSettings
object (QueryAlertSettings)
evaluationFrequency
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
maxAlertsPerHour
integer (int32)
notificationCount
integer (int32)
notificationChannelMapping
string
exceptionAlertSettings
object (ExceptionAlertSettings)
notificationChannelMapping
string
sendExceptionAlerts
boolean
maximumNumberOfAlerts
integer (int32)
duration
integer (int32)
durationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
perTransaction
boolean
perExceptionCode
boolean
note
string
exceptionMonitorConfigurations
Array of object (ExceptionMonitorConfiguration)
object
id
string (uuid)
exceptionType
string
condition
string
value
string
isEnabled
boolean
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
durationAlertSettings
object (DurationAlertSettings)
notificationChannelMapping
string
durationMonitorConfigurations
Array of object (DurationMonitorConfiguration)
object
id
string (uuid)
parentId
string (uuid)
name
string
type
integer (int32)
Valid values[ 0, 1, 2 ]
warningDuration
integer (int32)
warningDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
errorDuration
integer (int32)
errorDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
currentAlertHour
string (date-time)
lastRunAt
string (date-time)
isMonitorProcessing
boolean
monitorProcessingStartedAt
string (date-time)
qM_EscalationPolicyId
string (uuid)
dM_EscalationPolicyId
string (uuid)
eM_EscalationPolicyId
string (uuid)
eM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
qM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
dM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
escalationPolicyMappings
Array of object (EscalationPolicyMapping)
object
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
ruleRecipientMappings
Array of object (RuleRecipientMapping)
object
escalationRuleId
string (uuid)
customMailTemplateId
string (uuid)
recipients
string
id
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
alertIncidents
Array of object (AlertIncident)
object
id
string (uuid)
createdAt
string (date-time)
alertDescription
string
incidentStatus
integer (int32)
Valid values[ 1, 2, 3 ]
bA_AlertType
integer (int32)
Valid values[ 0, 1, 2, -1 ]
baMonitorConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
baM_AlertType
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
bamChannelConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
healthStatus
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
containerId
string (uuid)
templateMappingId
string (uuid)
incidentDetails
object (IncidentConfiguration)
assignmentInfo
Array of object (AssignmentInfo)
object
assignedRuleOrder
integer (int32)
assignedAt
string (date-time)
currentIteration
integer (int32)
transmittedNotificationChannels
Array of object (TransmittedNotificationChannel)
object
name
string
channelType
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
exception
string
transmittedAt
string (date-time)
userAssignmentInfo
Array of object (UserAssignmentInfo)
object
performedAt
string (date-time)
performedBy
string
description
string
oldState
integer (int32)
Valid values[ 1, 2, 3 ]
newState
integer (int32)
Valid values[ 1, 2, 3 ]
incidentStatusCountDetails
object (IncidentStatusCountDetails)
healthy
integer (int32)
warning
integer (int32)
error
integer (int32)
currentEscalationRuleOrder
integer (int32)
waitTillTime
string (date-time)
escalationPolicyId
string (uuid)
currentIteration
integer (int32)
globalProperties
Array of object (GlobalProperty)
object
id
string (uuid)
workspaceId
string (uuid)
name
string
dataType
string
dateFormat
string
createdAt
string (date-time)
updatedAt
string (date-time)
enabled
boolean
mappedBusinessProcesses
Array of object (MappedBusinessProcess)
object
id
string (uuid)
globalPropertyId
string (uuid)
businessProcessId
string (uuid)
configuration
object (MappedBusinessProcessConfiguration)
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
value
string
extractValueRegEx
string
Expand All
object
businessProcesses
Array of object (BusinessProcess)
object
id
string (uuid)
workspaceId
string (uuid)
businessProcessGroupId
string (uuid)
name
string
trackingName
string
description
string
path
string
isTrackingEnabled
boolean
isMonitoringEnabled
boolean
createdAt
string (date-time)
updatedAt
string (date-time)
additionalSettings
object (AdditionalSettings)
archiveMessage
boolean
purgeDays
integer (int32)
businessTransactions
Array of object (BusinessTransaction)
object
id
string (uuid)
name
string
trackingName
string
description
string
order
integer (int32)
direction
integer (int32)
Valid values[ 1, 2, 3 ]
stages
Array of object (Stage)
object
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
businessProcessId
string (uuid)
defaultReprocessStageName
string
allowedTrackingStatusForReprocess
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
configuration
object (Configuration)
class
string
nodeDataArray
Array of object (StageNode)
object
name
string
trackingName
string
key
string
id
string
category
string
iconPath
string
location
object (NodeLocation)
class
string
x
number (float)
y
number (float)
stage
object (Stage)
id
string (uuid)
name
string
trackingName
string
eventSource
string (uuid)
eventSourceName
string
isConditional
boolean
markTransactionAsComplete
boolean
markTransactionAsFailed
boolean
autoCompleteConditionalStage
boolean
stageProperties
Array of object (StageProperty)
object
id
string (uuid)
name
string
dataType
string
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
namespace
string
value
string
extractValueRegEx
string
isGlobalProperty
boolean
dateFormat
string
stageId
string (uuid)
globalPropertyId
string (uuid)
isIndexed
boolean
businessTransactionId
string (uuid)
reprocessConfiguration
object (ReprocessConfiguration)
endPointType
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6 ]
eventGridSettings
object (EventGridSettings)
topicEndPoint
string
topicKey
string
subject
string
dataVersion
string
eventType
string
serviceBusSettings
object (ServiceBusSettings)
serviceBusConnectionString
string
entityName
string
sessionId
string
messageId
string
to
string
contentType
string
correlationId
string
label
string
replyTo
string
replyToSessionId
string
viaPartitionKey
string
timeToLive
integer (int32)
customProperties
Array of object (StringObjectKeyValuePair)
object
key
string
value
httpEndPointSettings
object (HttpEndPointSettings)
methodType
integer (int32)
Valid values[ 1, 2 ]
defaultHeaders
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
uri
string
authorization
object (HttpEndpointAuthorization)
type
integer (int32)
Valid values[ 0, 1, 2, 3, 4 ]
apiKeyAuth
object (ApiKeyAuth)
key
string
value
string
basicAuth
object (BasicAuth)
userName
string
password
string
bearerToken
string
oAuth
object (OAuth)
url
string
methodType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
body
string
headers
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
queryParams
Array of object (DefaultHeaders)
object
key
string
value
isSensitive
boolean
id
string (uuid)
responseType
integer (int32)
Valid values[ 0, 1, 2 ]
responseExpression
string
tokenPrefix
string
sftpEndPointSettings
object (SftpEndPointSettings)
host
string
userName
string
password
string
path
string
port
integer (int32)
azureBlobStorageSettings
object (AzureBlobStorageSettings)
connectionString
string
isCreateNewContainer
boolean
containerName
string
blobNamePrefix
string
linkDataArray
Array of object (StageLink)
object
from
string
to
string
label
string
visible
boolean
updateTransactionStatusConfiguration
object (UpdateTransactionStatusConfiguration)
isUpdateTransactionStatus
boolean
isUpdatingTransactionStatus
boolean
lastUpdatedAt
string (date-time)
from
Array of integer (TrackingStatus)
integer (int32)
Valid values[ 0, 1, 2, 3 ]
to
integer (int32)
Valid values[ 0, 1, 2, 3 ]
value
integer (int32)
timeGrain
string
serializedConfig
string
purgeDays
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
status
integer (int32)
Valid values[ 1, 2, 3, 4 ]
monitorConfiguration
object (MonitorConfiguration)
queryAlertSettings
object (QueryAlertSettings)
evaluationFrequency
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
maxAlertsPerHour
integer (int32)
notificationCount
integer (int32)
notificationChannelMapping
string
exceptionAlertSettings
object (ExceptionAlertSettings)
notificationChannelMapping
string
sendExceptionAlerts
boolean
maximumNumberOfAlerts
integer (int32)
duration
integer (int32)
durationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
perTransaction
boolean
perExceptionCode
boolean
note
string
exceptionMonitorConfigurations
Array of object (ExceptionMonitorConfiguration)
object
id
string (uuid)
exceptionType
string
condition
string
value
string
isEnabled
boolean
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
durationAlertSettings
object (DurationAlertSettings)
notificationChannelMapping
string
durationMonitorConfigurations
Array of object (DurationMonitorConfiguration)
object
id
string (uuid)
parentId
string (uuid)
name
string
type
integer (int32)
Valid values[ 0, 1, 2 ]
warningDuration
integer (int32)
warningDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
errorDuration
integer (int32)
errorDurationTimeGrain
integer (int32)
Valid values[ 1, 2 ]
isConfigured
boolean
recipients
string
recipientTemplateId
string (uuid)
notificationChannels
Array of object (BAMNotificationChannel)
object
id
string (uuid)
name
string
type
string
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
emailSubject
string
note
string
currentAlertHour
string (date-time)
lastRunAt
string (date-time)
isMonitorProcessing
boolean
monitorProcessingStartedAt
string (date-time)
qM_EscalationPolicyId
string (uuid)
dM_EscalationPolicyId
string (uuid)
eM_EscalationPolicyId
string (uuid)
eM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
qM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
dM_EscalationPolicy
object (EscalationPolicy)
id
string (uuid)
productType
integer (int32)
Valid values[ 1, 2, 3, 4 ]
name
string
description
string
isDefault
boolean
escalationPolicyConfiguration
object (EscalationPolicyConfiguration)
repeatPolicyIfNoOneAcknowledges
boolean
numberOfTimesToRepeat
integer (int32)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRules
Array of object (EscalationRule)
object
isCreated
boolean
isUpdated
boolean
isDeleted
boolean
id
string (uuid)
escalationPolicyId
string (uuid)
createdAt
string (date-time)
updatedAt
string (date-time)
escalationRuleConfiguration
object (EscalationRuleConfiguration)
order
integer (int32)
escalateAfterTime
integer (int32)
escalationRuleTimeGranularity
integer (int32)
Valid values[ 0, 1 ]
emailRecipients
string
emailRecipientTemplateId
string (uuid)
emailSubject
string
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
applyToExistingMappings
boolean
customerId
string (uuid)
escalationPolicyMappings
Array of object (EscalationPolicyMapping)
object
escalationRuleNotificationChannelMappings
Array of object (EscalationRuleNotificationChannelMapping)
object
id
string (uuid)
escalationRuleId
string (uuid)
notificationChannelId
string (uuid)
customMailTemplateId
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
ruleRecipientMappings
Array of object (RuleRecipientMapping)
object
escalationRuleId
string (uuid)
customMailTemplateId
string (uuid)
recipients
string
id
string (uuid)
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
containerId
string (uuid)
emailSubject
string
bamMonitorType
integer (int32)
Valid values[ 0, 1, 2, 3 ]
alertIncidents
Array of object (AlertIncident)
object
id
string (uuid)
createdAt
string (date-time)
alertDescription
string
incidentStatus
integer (int32)
Valid values[ 1, 2, 3 ]
bA_AlertType
integer (int32)
Valid values[ 0, 1, 2, -1 ]
baMonitorConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
baM_AlertType
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
bamChannelConfigurationType
integer (int32)
Valid values[ 0, 1, 2 ]
healthStatus
integer (int32)
Valid values[ 0, 1, 2, 3, -1 ]
containerId
string (uuid)
templateMappingId
string (uuid)
incidentDetails
object (IncidentConfiguration)
assignmentInfo
Array of object (AssignmentInfo)
object
assignedRuleOrder
integer (int32)
assignedAt
string (date-time)
currentIteration
integer (int32)
transmittedNotificationChannels
Array of object (TransmittedNotificationChannel)
object
name
string
channelType
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
exception
string
transmittedAt
string (date-time)
userAssignmentInfo
Array of object (UserAssignmentInfo)
object
performedAt
string (date-time)
performedBy
string
description
string
oldState
integer (int32)
Valid values[ 1, 2, 3 ]
newState
integer (int32)
Valid values[ 1, 2, 3 ]
incidentStatusCountDetails
object (IncidentStatusCountDetails)
healthy
integer (int32)
warning
integer (int32)
error
integer (int32)
currentEscalationRuleOrder
integer (int32)
waitTillTime
string (date-time)
escalationPolicyId
string (uuid)
currentIteration
integer (int32)
globalProperties
Array of object (GlobalProperty)
object
id
string (uuid)
workspaceId
string (uuid)
name
string
dataType
string
dateFormat
string
createdAt
string (date-time)
updatedAt
string (date-time)
enabled
boolean
mappedBusinessProcesses
Array of object (MappedBusinessProcess)
object
id
string (uuid)
globalPropertyId
string (uuid)
businessProcessId
string (uuid)
configuration
object (MappedBusinessProcessConfiguration)
source
integer (int32)
Valid values[ 1, 2, 3, 4, 5 ]
value
string
extractValueRegEx
string
Responses
200

Success


Was this article helpful?