Contents x
    10.3 API Updates
    • 17 May 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    10.3 API Updates

    • Updated on 17 May 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    New APIs introduced in v10.3

    MethodAPIDescription
    GETGenerateAuditReport This API is used to fetch the audit report
    POSTUpdateDashboardStatus
    		to update the dashboardEditInProgress value 
    GETGetArtifactsOrphanedCount to get the count of Orphaned applications and artifacts. 

    GET    		GetTableIndexDetails This API fetches the database table index details
    GET
    		GetConfigurationDetailsThis API fetches the user configuration details for performing actions 
    POSTManageConfigurationDetails
    		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.
    GETGetAutomatedTaskHistory
    		This API is used to get the list of automated task history from an environment.
    GETGetAssociatedResources
    		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)
    POSTEditAutomatedTaskConfiguration
    		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.
    POSTManageAutomatedTask
    		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 APIDescription
    GETGetSystemAlertSchedule
    POSTUpdateSystemAlertSchedule 

    		GetDataMonitorSchedule
    GetProcessMonitorSchedule
    ManageDataMonitorSchedule
    ManageProcessMonitorSchedule


    A new property named 'IsScheduleEnabled' is added

    GET
    GetProcessMonitorScheduleList
    GetDataMonitorScheduleList    		A new property named 'ScheduleStatus' is added
    POSTManageDataMonitoringScheduleOperations
    • Changing API name from ResetDataMonitoringSchedules to ManageDataMonitoringScheduleOperations
    • New properties named 'ScheduleOperation' and 'isScheduleEnabled' has been added to the ManageDataMonitoringScheduleOperations API request
    POSTExecuteBizTalkHostInstanceOperationBulk 
    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)
    GETGetSystemGlobalProperties
    two new properties are added.
    1. IS_PAGING_ENABLED = false/true (bool type)
    2. PAGE_SIZE = 10(number type)
    Was this article helpful?
    What's Next
    ESC

    Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses