Contents x
    Create a business application
    • 12 Mar 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Create a business application

    • Updated on 12 Mar 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /BusinessApplication/Create
    Security
    API Key
    Header parameter nameAPIKey

    API key which has access for your API

    Body parameters
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    groupId
    string (uuid) Required
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetails)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    businessApplicationServicePrincipalType
    integer (int32) Required
    Valid values[ 1, 2 ]
    subscriptionName
    string
    subscriptionId
    string (uuid)
    environmentName
    string
    environmentId
    string
    refreshToken
    string
    isMonitoringProfileEnabled
    boolean Required
    monitoringProfileId
    string (uuid)
    resources
    object (ExposedAPIBusinessApplicationResourceMonitorRules)Required
    resources
    Array of object (ExposedAPIBusinessApplicationResource) Required
    object
    clientId
    string (uuid) Required
    azureResourceId
    string Required
    Min length1
    typeId
    integer (int32) Required
    subscriptionId
    string (uuid)
    environmentId
    string
    monitorConfiguration
    object (ExposedAPIBAMonitorConfiguration)Required
    evaluationFrequency
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
    aggregationPeriod
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
    statusReport
    Array of integerRequired
    integer (int32)
    monitoringDays
    Array of stringRequired
    string
    monitoringHours
    Array of integerRequired
    integer (int32)
    timeZoneId
    string Required
    Min length1
    escalationPolicyConfiguration
    object (EscalationPolicyExposedAPI)
    escalationPolicyId
    string (uuid) Required
    notificationChannelsConfiguration
    Array of object (EscalationNotificationChannles)
    object
    order
    integer (int32)
    notificationChannels
    Array of object (EscalationNotificationChannelMappingExposedAPI)
    object
    notificationChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    recipient
    object (RuleRecipientMappingExposedAPI)
    customMailTemplateId
    string (uuid)
    recipients
    string
    emailSubject
    string
    monitorScaledAppServiceInstances
    boolean
    includeHealthyRulesInTheReport
    boolean
    includeAllIdentifiedIssues
    boolean
    sendReportIfAnyError
    boolean
    upAlerts
    boolean
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    groupId
    string (uuid) Required
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetails)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    businessApplicationServicePrincipalType
    integer (int32) Required
    Valid values[ 1, 2 ]
    subscriptionName
    string
    subscriptionId
    string (uuid)
    environmentName
    string
    environmentId
    string
    refreshToken
    string
    isMonitoringProfileEnabled
    boolean Required
    monitoringProfileId
    string (uuid)
    resources
    object (ExposedAPIBusinessApplicationResourceMonitorRules)Required
    resources
    Array of object (ExposedAPIBusinessApplicationResource) Required
    object
    clientId
    string (uuid) Required
    azureResourceId
    string Required
    Min length1
    typeId
    integer (int32) Required
    subscriptionId
    string (uuid)
    environmentId
    string
    monitorConfiguration
    object (ExposedAPIBAMonitorConfiguration)Required
    evaluationFrequency
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
    aggregationPeriod
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
    statusReport
    Array of integerRequired
    integer (int32)
    monitoringDays
    Array of stringRequired
    string
    monitoringHours
    Array of integerRequired
    integer (int32)
    timeZoneId
    string Required
    Min length1
    escalationPolicyConfiguration
    object (EscalationPolicyExposedAPI)
    escalationPolicyId
    string (uuid) Required
    notificationChannelsConfiguration
    Array of object (EscalationNotificationChannles)
    object
    order
    integer (int32)
    notificationChannels
    Array of object (EscalationNotificationChannelMappingExposedAPI)
    object
    notificationChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    recipient
    object (RuleRecipientMappingExposedAPI)
    customMailTemplateId
    string (uuid)
    recipients
    string
    emailSubject
    string
    monitorScaledAppServiceInstances
    boolean
    includeHealthyRulesInTheReport
    boolean
    includeAllIdentifiedIssues
    boolean
    sendReportIfAnyError
    boolean
    upAlerts
    boolean
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    groupId
    string (uuid) Required
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetails)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    businessApplicationServicePrincipalType
    integer (int32) Required
    Valid values[ 1, 2 ]
    subscriptionName
    string
    subscriptionId
    string (uuid)
    environmentName
    string
    environmentId
    string
    refreshToken
    string
    isMonitoringProfileEnabled
    boolean Required
    monitoringProfileId
    string (uuid)
    resources
    object (ExposedAPIBusinessApplicationResourceMonitorRules)Required
    resources
    Array of object (ExposedAPIBusinessApplicationResource) Required
    object
    clientId
    string (uuid) Required
    azureResourceId
    string Required
    Min length1
    typeId
    integer (int32) Required
    subscriptionId
    string (uuid)
    environmentId
    string
    monitorConfiguration
    object (ExposedAPIBAMonitorConfiguration)Required
    evaluationFrequency
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
    aggregationPeriod
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
    statusReport
    Array of integerRequired
    integer (int32)
    monitoringDays
    Array of stringRequired
    string
    monitoringHours
    Array of integerRequired
    integer (int32)
    timeZoneId
    string Required
    Min length1
    escalationPolicyConfiguration
    object (EscalationPolicyExposedAPI)
    escalationPolicyId
    string (uuid) Required
    notificationChannelsConfiguration
    Array of object (EscalationNotificationChannles)
    object
    order
    integer (int32)
    notificationChannels
    Array of object (EscalationNotificationChannelMappingExposedAPI)
    object
    notificationChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    recipient
    object (RuleRecipientMappingExposedAPI)
    customMailTemplateId
    string (uuid)
    recipients
    string
    emailSubject
    string
    monitorScaledAppServiceInstances
    boolean
    includeHealthyRulesInTheReport
    boolean
    includeAllIdentifiedIssues
    boolean
    sendReportIfAnyError
    boolean
    upAlerts
    boolean
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    groupId
    string (uuid) Required
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetails)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    businessApplicationServicePrincipalType
    integer (int32) Required
    Valid values[ 1, 2 ]
    subscriptionName
    string
    subscriptionId
    string (uuid)
    environmentName
    string
    environmentId
    string
    refreshToken
    string
    isMonitoringProfileEnabled
    boolean Required
    monitoringProfileId
    string (uuid)
    resources
    object (ExposedAPIBusinessApplicationResourceMonitorRules)Required
    resources
    Array of object (ExposedAPIBusinessApplicationResource) Required
    object
    clientId
    string (uuid) Required
    azureResourceId
    string Required
    Min length1
    typeId
    integer (int32) Required
    subscriptionId
    string (uuid)
    environmentId
    string
    monitorConfiguration
    object (ExposedAPIBAMonitorConfiguration)Required
    evaluationFrequency
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7 ]
    aggregationPeriod
    integer (int32) Required
    Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
    statusReport
    Array of integerRequired
    integer (int32)
    monitoringDays
    Array of stringRequired
    string
    monitoringHours
    Array of integerRequired
    integer (int32)
    timeZoneId
    string Required
    Min length1
    escalationPolicyConfiguration
    object (EscalationPolicyExposedAPI)
    escalationPolicyId
    string (uuid) Required
    notificationChannelsConfiguration
    Array of object (EscalationNotificationChannles)
    object
    order
    integer (int32)
    notificationChannels
    Array of object (EscalationNotificationChannelMappingExposedAPI)
    object
    notificationChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    recipient
    object (RuleRecipientMappingExposedAPI)
    customMailTemplateId
    string (uuid)
    recipients
    string
    emailSubject
    string
    monitorScaledAppServiceInstances
    boolean
    includeHealthyRulesInTheReport
    boolean
    includeAllIdentifiedIssues
    boolean
    sendReportIfAnyError
    boolean
    upAlerts
    boolean
    Responses
    200

    Success

    Was this article helpful?
    What's Next