10.5 API Updates

  • Published on May 17, 2023
  • 1 minute(s) read
Prev Next

New APIs introduced in v10.5

MethodAPIDescription
POSTGetPerformanceQueryDataTo get the Filtered query Results for Performance Metrics in the Administration module
POSTGetTrackingDataTo get the Filtered query results for Tracking Metrics in the Administration module 
GETGetPerformanceQueryFilterColumnValuesGet the Performance Metrics value List based on the filter 
GETGetPerformanceQueryFilterColumnValuesGet the Tracking Metrics value List based on the filter
GETGetInitialOnboardingMigrationStatusIt fetches all the Migration details from the bt360-admin_DBMigration_status table of the BizTalk360 Database and list in the Migration Screen

Modified API's

MethodAPI
Description
GETGetSystemGlobalPropertiesAdded a new property BHM_REPORT_COUNTWhen configuring the Report History count in the General settings it will display the configured number of reports in BHM in the Administration side
GETGetBizTalk360HealthStatusAdded new property FeatureMigrationStatusThis API will display the status of feature migration in the General Setting page
GETGetTopologyAdded new property in GetTopology response
isActiveNode and isPassiveNode in BizTalk server
isActiveNode, isClusterNode, and isPassiveNode in SQL Instances 		This API displays the
  • Active and Passive state of the SQL server
  • Grouping the cluster setup server in BizTalk and SQL
  • It shows the installed database in SQL Server Nodes
PostEditAutomatedTaskConfiguration New Object -> retryDetails Specifies the retry configuration and current retry count. Sub Properties: 
  1. retryInterval - Specifies the duration between each retry
  2. maxRetryCount - Specifies the maximum number of retry attempts can take place
  3. completedRetryCount - Specifies the so far completed retries of the task's latest execution

GetGetAssociatedResources

response:

  1. New property -> associatedResources -> hostInstancesList -> clusterType 
- Indicates the cluster type of the host instance
Get
GetAutomatedTaskHistory 

response 

  1. New property executingUser - Indicates the executed user of the task
  2. New object info - Specifies the additional information of the task summary
  3. New object parentAndRetriedTaskDetails - Specifies the details of parent and retried task details. Sub properties:
    1. parentTaskExecutionId - Originally triggered task id
    2. parentTaskExecutionType - Original task execution type
    3. retryCount - Retry count of the execution
    4. maximumRetryCount - Max retry count of the task
  4. New property groupID
 - Specifics the unique group id of original task and its retried tasks
PostManageAutomatedTaskPayload -> Old property scriptToBeValidated renamed to -> configurationToBeValidated Specifies either the PowerShell script to be validated or Custom Workflow resource configuration to check the conflicting alarms
GETGetConfiguredSQLServerNamesForMonitoring
Added a few properties
  • isServerReachable - Specifies whether the configured server is reachable or not
  • isActiveNodeReachable - Specifies whether the active node in the cluster is reachable or not
  • isPassiveNodeReachable - Specifies whether the passive node in the cluster is reachable or not
  • errors - Specifies the exception thrown while connecting with the server

Related articles