v11.3 API Updates

Prev Next

New APIs introduced in v11.3

Method

API

Description

GET

GetActiveMQConfiguration

This API is introduced to fetch the configuration details of Active MQ.

POST

ManageActiveMQConfiguration

This API is introduced to manage the active MQ configuration.

POST

ConsolidatedArtifactsMapping

This API is used to map all the unmapped artifacts to an alarm.

POST

ConsolidatedAutoCorrectMapping

This API is used to enable auto correct for the artifacts that are not enabled for auto correct.

POST

GetPerformanceMetricsData 

This API is used to collect data for all the widgets in analytics dashboard.

POST

TestSQLServerAvailability

This API is introduced to test if the SQL server that we are trying to add is reachable or not.

GET

GetPredefinedStepDetails

This API is used to get the steps of the predefined automated tasks selected.

GET

GetPredefinedStepsForTemplate

This API is used to get the steps of the predefined automated tasks of the specific template selected.

Modified APIs

Method

API

Updated property

Description

POST

UpdateConfiguredSQLServerNames

The new properties "alwaysOnGroupName", "alwaysOnIsPrimaryNode", "alwaysOnIsPrimaryNodeReachable", "alwaysOnSQLInstanceName", "alwaysOnSqlNodes", "isServerReachable" are added.

As support for adding SQL server always on group server is now added, these properties are added to this API.

POST

GetBizTalkServersPerformance

A new property "aggregationParams" is added.

This property is added to show the data points based on certain aggregation selected.

POST

GetBizTalkHostsPerformance

A new property "aggregationParams" is added.

This property is added to show the data points based on certain aggregation selected.

POST

GetIISServersPerformance

A new property "aggregationParams" is added.

This property is added to show the data points based on certain aggregation selected.

POST

GetBizTalkMessagingPerformance

A new property "aggregationParams" is added.

This property is added to show the data points based on certain aggregation selected.

POST

GetSQLServersPerformance

A new property "aggregationParams" is added.

This property is added to show the data points based on certain aggregation selected.

POST

GetPerformanceMetricData

A new property "aggregationParams" is added.

This property is added to show the data points based on certain aggregation selected.

POST

ManageMonitoringServices

serverName (string) is added as a new parameter.

This property is added in order to identify the server's name.

POST

ManageProcessMonitorSchedule

A new property "Port Match" is added.

This property is added to find if the port match type selected is any or all.

GET

GetDataMonitorSchedule

The properties notifyOnEdiMdns, notifyOnProcessedMdns, notifyOnFailedMdns, senderParty, receiverParty, as2From, as2To, partyRole, mdnStatus, noOfMessages, isFailedMdn, 

sendEdiResultsInNotification are added.

These properties are added to send notification with respect to EDI schedules.

POST

ManageDataMonitorSchedule 

A new Enum is added "Clone".
The properties notifyOnEdiMdns, notifyOnProcessedMdns, notifyOnFailedMdns, senderParty, receiverParty, as2From, as2To, partyRole, mdnStatus, noOfMessages, isFailedMdn, sendEdiResultsInNotification are added.

As we have introduced an option to clone the data monitoring schedules, this Enum is added.

GET

GetEnvironmentDataForImport 

Added the properties azureSubscriptionNames, activeMQHosts, ibmMqServers, rabbitMQHosts, bt360InstalledServers.

These properties are added to identify the servers and hosts available in the environment where the data is imported.

GET

GetOrphanedResourcesData 

Added the processMonitors in payload, response -orphanedBizTalkServerCertificates, fileLocationsOrphanedList, queuesOrphanedList, ibmMQOrphanedList, azureServicessOrphanedList, dataMonitoringSchedules, serversOrphanedList.

These are added to identify the orphaned artifacts / resources while importing the data in the environment.

GET

GetEmailTemplates

Added a new property "type".

Since we have added a new template for reporting, this property is added to identify the type.

POST

MaintainEmailTemplate

Added a new property "type".

Since we have added a new template for reporting, this property is added to identify the type.

GET

GetAutomatedTaskList

Added a new property "operation".

As we have introduced an option to clone the automated tasks, this Enum is added.

POST

EditAutomatedTaskConfiguration

Added a new property "operation".

As we have introduced an option to clone the automated tasks, this Enum is added.