10.3 API Updates

Prev Next

New APIs introduced in v10.3

Method API Description
GET GenerateAuditReport  This API is used to fetch the audit report
POST UpdateDashboardStatus
to update the dashboardEditInProgress value 
GET GetArtifactsOrphanedCount This API is used to get the count of orphaned applications and artifacts. 

GET
GetTableIndexDetails  This API is used to fetch the database table index details
GET
GetConfigurationDetails This API fetches the user configuration details for performing actions 
POST ManageConfigurationDetails
This API updates user configuration to the database 
GET
getEDIAuditData  should be added to get the Audit Data from the Database 

ManageAuditConfiguration' & 'GetAuditConfigurationData'
EDI Property must be added to the serializedAuditConfiguration property
GET

GetServiceDetails

A new API named 'GetServiceDetails' will be created to fetch the BizTalk360 Database size, Analytics and Monitoring service details.This API will return:

  • Monitoring Service Details(Monitoring Services and Monitoring Service Health)
  • Analytics Service Details(Analytics Services and Analytics Service Health) 
  • BizTalk360 Database Size
GET   GetAutomatedTaskList
This API is used to get the list of automated task from an environment.
GET GetAutomatedTaskHistory
This API is used to get the list of automated task history from an environment.
GET GetAssociatedResources
As the name specified, this API is used to get the list of resources as the automated task type is selected. (it gets the application list when user try to create\update the application task)
POST EditAutomatedTaskConfiguration
This API is used to create or edit the automated task, where the payload will have the configuration details like task name, description, schedule configuration and notification settings.
POST ManageAutomatedTask
It is used to manage the tasks like enable\disable and delete. where the payload contains the environment id and task id. If the operation is successfully complete the API response will be success: True.


Existing APIs modified in v10.3

Method  API Description
GET GetSystemAlertSchedule
POST UpdateSystemAlertSchedule 
GET GetDataMonitorSchedule
A new property named 'IsScheduleEnabled' is added
GET GetProcessMonitorSchedule
A new property named 'IsScheduleEnabled' is added
POST ManageDataMonitorSchedule
A new property named 'IsScheduleEnabled' is added
POST ManageProcessMonitorSchedule
A new property named 'IsScheduleEnabled' is added
GET GetProcessMonitorScheduleList
A new property named 'ScheduleStatus' is added
GET GetDataMonitorScheduleList  A new property named 'ScheduleStatus' is added
POST ManageDataMonitoringScheduleOperations
  • Changing API name from ResetDataMonitoringSchedules to ManageDataMonitoringScheduleOperations
  • New properties named 'ScheduleOperation' and 'isScheduleEnabled' has been added to the ManageDataMonitoringScheduleOperations API request
POST ExecuteBizTalkHostInstanceOperationBulk 
Two new properties named 'isOperationSuccess' and 'errorDescription' will be added
GET
GetBizTalkHostInstanceByFilter 

A Property BizTalkHostInstanceSetting is added in GetBizTalkHostInstanceByFilter() AP
POST
ManageGobalProperties

two new properties are added.
  1. IS_PAGING_ENABLED = false/true (bool type)
  2. PAGE_SIZE = 10(number type)
GET GetSystemGlobalProperties
two new properties are added.
  1. IS_PAGING_ENABLED = false/true (bool type)
  2. PAGE_SIZE = 10(number type)