v10.8 API Updates

  • Published on Jul 4, 2024
  • 3 minute(s) read
Prev Next

New APIs introduced in v10.8

MethodAPIDescription 
GETGetFeatureUsageRecommendationKnowledgeBaseThis API is used to get the BizTalk360 advisor recommendations that is available in the database and list them in KB.
POSTUpdateFeatureUsageRecommendationKnowledgeBaseThis API is used to update the BizTalk360 advisor recommendations that is available in the recommendations KB.
POSTValidateBizTalkLogsConfigurationThis API is used to Validate the BizTalk Log path configuration 
POSTManageBizTalkLogConfigurationThis API is used to save the log file path configuration. 
GETGetBizTalkLogConfiguration This API is used to get the BizTalk Log configuration. 
GETGetBizTalkLogDetails This API is used to get the BizTalk log details. 
POSTDownloadBizTalkLogContent This API is used to download the log and used to Send as email options
POSTCreateEditEscalationPolicyThis API is used to create or update the escalation policy in an environment. 
GETGetEscalationPolicies 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.
POSTGetIncidentAuditData
 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.
GETGetIISLogColumnValues 
 This API is used to get the filter column values of IIS logs.
POSTValidateHTTPLoggingStatus This API is used to get the window's feature http logging status.
POSTValidateIISLogsConfiguration
 It is used to validate the IIS Log path configuration.

Modified API's

Method APIUpdated property Description
GETGetProcessMonitorSchedule
  • 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
POSTManageProcessMonitorSchedule
  • 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


GETGetProcessMonitorExecutionResult
  • 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
POSTImportEnvironmentData
  • 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
GETGetCustomSQLQueryNames
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 
POSTManageCustomSQLQuery 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.
POSTExecuteCustomSQLQuery 1 new object property  "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360)This API is used to execute the custom SQL query.
POSTManageAlertMonitorConfig 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.
GETGetAlertMonitorSerializedConfig 
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. 
POSTExportEnvironmentData 
1 new object property "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360)		This API is used to Export Environment Data
POSTImportEnvironmentData1 new object property  "SQLCredentials" (userName, password, tenantId, clientId, secretKey, subscriptionId, isSubscriptionAddedInB360)This API is used to Import Environment Data
POSTEditAutomatedTaskConfiguration2 new properties  "enableTimeIntervalWorkFlow"
"TimeIntervalInMinutes"are added in request		This API is used to update the task configuration
GETGetAutomatedTaskList 2 new properties  "enableTimeIntervalWorkFlow"
"TimeIntervalInMinutes"are added in request 		This API is used to get all the created task
GETGetAutomatedTaskHistoryNew property IsTimeIntervalEnable is added in responseThis API is used to retrieves all the task history. 
GETGetUserAlarmTwo 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.
POSTUpdateUserAlarm
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.
POSTCreateUserAlarm

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.
GETGetConfiguredIISServers
Added log Info details in the response. 		This API is used to get all the configured IIS servers in an environment.
POSTUpdateConfiguredIISServers
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.


Related articles