v10.8 API Updates

Prev Next

New APIs introduced in v10.8

Method API Description 
GET GetFeatureUsageRecommendationKnowledgeBase This API is used to get the BizTalk360 advisor recommendations that is available in the database and list them in KB.
POST UpdateFeatureUsageRecommendationKnowledgeBase This API is used to update the BizTalk360 advisor recommendations that is available in the recommendations KB.
POST ValidateBizTalkLogsConfiguration This API is used to Validate the BizTalk Log path configuration 
POST ManageBizTalkLogConfiguration This API is used to save the log file path configuration. 
GET GetBizTalkLogConfiguration  This API is used to get the BizTalk Log configuration. 
GET GetBizTalkLogDetails  This API is used to get the BizTalk log details. 
POST DownloadBizTalkLogContent  This API is used to download the log and used to Send as email options
POST CreateEditEscalationPolicy This API is used to create or update the escalation policy in an environment. 
GET GetEscalationPolicies  This API is used to fetch the policies available in the environment. 
POST

RemoveEscalationPolicy
This API is used to remove the configured escalation policy from an environment.
POST
GetAlertIncidents


 This API as name defined, is used to get the incidents created over an environment for all the alarm. 
POST
UpdateIncidentStatus

This API is used to perform operation over any incidents like Acknowledging and Closing.
POST GetIncidentAuditData
 This API is used to get the audit data of each incidents creation, Incidents operations like closed and acknowledged and auto closing. 
GET
GetIncidentFilterValues 

This API is used to fetch the static filters details available in the incident section.
GET
GetIISLogDetails

This API is used to fetch the IIS logs collected for an environment.
GET GetIISLogColumnValues 
 This API is used to get the filter column values of IIS logs.
POST ValidateHTTPLoggingStatus  This API is used to get the window's feature http logging status.
POST ValidateIISLogsConfiguration
 It is used to validate the IIS Log path configuration.

Modified API's

Method  API Updated property  Description
GET GetProcessMonitorSchedule
  • two new properties in the "task" object in "processMonitorSchedule" request object
    • isMessageSizeThresholdEnabled (boolean)
    • messageSizeThresholdConfiguration (list of objects)
      • portId (int)
      • comparisonOperator (int)
      • sizeTypeOperator (int)
      • expectedSize (long)

This API is used to Get Process Monitoring Schedule Configuration
POST ManageProcessMonitorSchedule
  • two new properties in "task" object in "processMonitorSchedule" request object
    • isMessageSizeThresholdEnabled (boolean)
    • messageSizeThresholdConfiguration (list of objects)
      • portId (int)
      • comparisonOperator (int)
      • sizeTypeOperator (int)
      • expectedSize (long)

This API is used to Save/Update Process Monitoring Schedule Configuration


GET GetProcessMonitorExecutionResult
  • seven new properties in "dataMonitorStatuses" response object
    • isMessageSizeThresholdEnabled (boolean)
    • messageSizeThresholdComparisonOperator (int)
    • messageSizeThresholdSizeTypeOperator (int)
    • messageSizeThresholdExpectedSizeValue (long)
    • messageSizeThresholdViolatedFileCount (int)
    • messageSizeThresholdStatus (int)
    • fileCountThresholdStatus (int)
This API is used to show the Process Monitoring result
POST

ExportEnvironmentData


  • two new properties in "task" object in "processMonitors" object in "alarmConfigurations" object in "exportData" response object
    • isMessageSizeThresholdEnabled (boolean)
    • messageSizeThresholdConfiguration (list of objects)
      • portId (int)
      • comparisonOperator (int)
      • sizeTypeOperator (int)
      • expectedSize (long)
This API is used to Export Environment Data
POST ImportEnvironmentData
  • two new properties in "task" object in "processMonitors" object in "alarmConfigurations" object in "exportData" request object
    • isMessageSizeThresholdEnabled (boolean)
    • messageSizeThresholdConfiguration (list of objects)
      • portId (int)
      • comparisonOperator (int)
      • sizeTypeOperator (int)
      • expectedSize (long)
This API is used to Import Environment Data
GET GetCustomSQLQueryNames
1 new object property "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360)
This API is used to get the saved queries for secure SQL queries 
POST ManageCustomSQLQuery  1 new object property  "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360) This API is used to save /Update the queries in secure SQL queries.
POST ExecuteCustomSQLQuery  1 new object property  "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360) This API is used to execute the custom SQL query.
POST ManageAlertMonitorConfig  1 new object property  "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360) This API is used to add/Remove the artifacts configuration in the alarm.
GET GetAlertMonitorSerializedConfig 
1 new object property "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360)

This API is used to retrieves the artifacts configuration with an alarm in BizTalk Environment. 
POST ExportEnvironmentData 
1 new object property "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360)
This API is used to Export Environment Data
POST ImportEnvironmentData 1 new object property  "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360) This API is used to Import Environment Data
POST EditAutomatedTaskConfiguration 2 new properties  "enableTimeIntervalWorkFlow"
"TimeIntervalInMinutes"are added in request
This API is used to update the task configuration
GET GetAutomatedTaskList  2 new properties  "enableTimeIntervalWorkFlow"
"TimeIntervalInMinutes"are added in request 
This API is used to get all the created task
GET GetAutomatedTaskHistory New property IsTimeIntervalEnable is added in response This API is used to retrieves all the task history. 
GET GetUserAlarm Two new properties "IsEscalationEnabled " and "MappedEscalationPolicy" added to this API to know the escalation policy is enabled in that alarm or not and to get the mapped escalation policy name.
This API is generally used to get all the available alarms in an environment.
POST UpdateUserAlarm
Two new properties "IsEscalationEnabled " and "MappedEscalationPolicy" added to this API to know the escalation policy is enabled in that alarm or not and to get the mapped escalation policy name.

This API is generally used to update the alarm in an environment.
POST CreateUserAlarm

Two new properties "IsEscalationEnabled " and "MappedEscalationPolicy" added to this API to know the escalation policy is enabled in that alarm or not and to get the mapped escalation policy name.


This API is generally used to create the alarm in an environment.
GET GetConfiguredIISServers
Added log Info details in the response. 
This API is used to get all the configured IIS servers in an environment.
POST UpdateConfiguredIISServers
Added log Info details in the request and response. 
This API is used to update IIS server with different log path, enable\disable logging and remove server operations.