Api Change Log

What's New

1. POST/{client_id}/ai Chat with Automation AI
2. DELETE/{client_id}/ai End a chat with Automation AI
3. POST/{client_id}/executions/{run_id}/reports/{report_type}/ai Analyze Report content pages.
4. GET/{client_id}/executions/{run_id}/children/{lnr} Get children task using parent run ID and line number
5. POST/{client_id}/executions/{run_id}/children/{lnr}/unblock_task Unblock a child task using parent run ID and its running number in the workflow.
6. POST/{client_id}/executions/{run_id}/modify_priority Modify the priority of an active task.
7. POST/{client_id}/executions/{run_id}/modify_status Modify the status of an active task.
8. POST/{client_id}/executions/{run_id}/unblock_workflow Unblock the workflow).
9. POST/{client_id}/executions/{run_id}/{action} Perform the given action on the selected execution).
10. GET/{client_id}/system/users/connections List of all connections. For client 0 returns all connections, for other clients the connections for the current client.
11. GET/{client_id}/system/settings/{variable_name} Can be used to get variable value by name

What's Deleted

What's Deprecated

What's Changed

1. POST/{client_id}/system/ra-solutions/upload

   • Parameters

     • Deleteignore-signaturein header
2. DELETE/{client_id}/system/users/{user_name}/connections Disconnect all connections of a user or connections identified by session ids.

   • Parameters

     • session_ids in query
3. PATCH/{client_id}/system/users/{user}/move

   • Request

     • New body: 'application/json'
     • Deleted body: '*/*'
4. GET/{client_id}/telemetry/export/{start_from}
5. GET/{client_id}/system/agents/{object_name}

   • Response

     • Changed response : [200]//successful operation

       • Schema

         Changed body: 'application/json'
6. GET/{client_id}/system/agents

   • Response

     • Changed response : [200]//successful operation

       • Schema

         Changed body: 'application/json'
7. POST/{client_id}/system/ra-solutions

   • Request

     • Schema

       Changed body: '*/*'
8. POST/{client_id}/system/users

   • Parameters

     • overwrite_existing_user in query
     • overwrite_locked_user in query

   • Request

     • New body: 'application/json'
     • Deleted body: '*/*'
9. GET/{client_id}/executions/{run_id}

   • Response

     • Changed response : [200]//successful operation

       • Schema

         Changed body: 'application/json'
10. GET/{client_id}/executions

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
11. GET/{client_id}/executions/{run_id}/children

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
12. POST/{client_id}/folderobjects

    • Request

      • Schema incompatible

        Changed body: 'application/json'

        Missing property: data[n].data.hostg.generalAttributes.workflow_children (integer)

        Missing property: data[n].data.hostg.generalAttributes.is_shared (string)

        Missing property: data[n].data.hostg.generalAttributes.client0_object_id (integer)

        Missing property: data[n].data.hostg.generalAttributes.extended_reports (integer)

        Missing property: data[n].data.hostg.generalAttributes.max_wait_time (integer)

        Missing property: data[n].data.hostg.generalAttributes.max_parallel (integer)

        Missing property: data[n].data.hostg.generalAttributes.max_parallel_action (integer)

        Missing property: data[n].data.hostg.generalAttributes.archive_key1 (string)

        Missing property: data[n].data.hostg.generalAttributes.archive_key2 (string)

        Missing property: data[n].data.hostg.generalAttributes.max_allowed_retcode (integer)

        Missing property: data[n].data.hostg.generalAttributes.mrt_method (integer)

        Missing property: data[n].data.hostg.generalAttributes.mrt_time (string)

        Missing property: data[n].data.hostg.generalAttributes.mrt_ert (integer)

        Missing property: data[n].data.hostg.generalAttributes.mrt_alarm (string)

        Missing property: data[n].data.hostg.generalAttributes.ert_check_last_runs (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_correction (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_deviation_extend (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_min_runs (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_method (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_trend (integer)

        Missing property: data[n].data.hostg.generalAttributes.srt_ert (integer)

        Missing property: data[n].data.hostg.generalAttributes.default_forecast_status (integer)

        Missing property: data[n].data.hostg.generalAttributes.time_zone (string)

        Missing property: data[n].data.hostg.generalAttributes.mrt_time_zone (string)

        Missing property: data[n].data.hostg.generalAttributes.has_object_variables (integer)

        Missing property: data[n].data.hostg.generalAttributes.inherit_object_variables (integer)

        Missing property: data[n].data.hostg.generalAttributes.file_scan_agent (string)

        Missing property: data[n].data.hostg.generalAttributes.file_scan_login (string)

        Missing property: data[n].data.hostg.generalAttributes.max_retcode_alarm (string)

        Missing property: data[n].data.hostg.generalAttributes.inherit_output_filter (string)

        Missing property: data[n].data.hostg.generalAttributes.child_queue (string)

        Missing property: data[n].data.hostg.generalAttributes.has_prompts (integer)

        Missing property: data[n].data.hostg.generalAttributes.has_output_filters (integer)

        Missing property: data[n].data.hostg.generalAttributes.is_template (integer)

        Missing property: data[n].data.hostg.generalAttributes.rollback_enabled (integer)

        Missing property: data[n].data.hostg.generalAttributes.is_inactive (integer)

        Missing property: data[n].data.hostg.generalAttributes.sub_type (string)

        Missing property: data[n].data.hostg.generalAttributes.deactivation_delay (integer)

        Missing property: data[n].data.hostg.generalAttributes.auto_deactivation (string)

        Missing property: data[n].data.hostg.generalAttributes.deactivation_condition (string)

        Missing property: data[n].data.hostg.generalAttributes.minimum_ae_version (string)

        Missing property: data[n].data.hostg.generalAttributes.object_authorizations (array)

        Missing property: data[n].data.user.general_attributes (object)

        Missing property: data[n].data.user.user_attributes (object)

        Missing property: data[n].data.user.authorizations[n].filter_type (string)

        Missing property: data[n].data.user.authorizations[n].filter_object_type (string)

        Missing property: data[n].data.user.authorizations[n].filter_object_name (string)

        Missing property: data[n].data.user.authorizations[n].filter_agent_name1 (string)

        Missing property: data[n].data.user.authorizations[n].filter_agent_name2 (string)

        Missing property: data[n].data.user.authorizations[n].filter_user_id1 (string)

        Missing property: data[n].data.user.authorizations[n].filter_user_id2 (string)

        Missing property: data[n].data.user.authorizations[n].filter_file_names1 (string)

        Missing property: data[n].data.user.authorizations[n].filter_file_names2 (string)

        Missing property: data[n].data.user.authorizations[n].authorizations_set (array)

        Missing property: data[n].data.user.authorizations[n].auth_group (integer)

      • Schema incompatible

        Changed body: 'application/octet-stream'

        Missing property: data[n].data.hostg.generalAttributes.workflow_children (integer)

        Missing property: data[n].data.hostg.generalAttributes.is_shared (string)

        Missing property: data[n].data.hostg.generalAttributes.client0_object_id (integer)

        Missing property: data[n].data.hostg.generalAttributes.extended_reports (integer)

        Missing property: data[n].data.hostg.generalAttributes.max_wait_time (integer)

        Missing property: data[n].data.hostg.generalAttributes.max_parallel (integer)

        Missing property: data[n].data.hostg.generalAttributes.max_parallel_action (integer)

        Missing property: data[n].data.hostg.generalAttributes.archive_key1 (string)

        Missing property: data[n].data.hostg.generalAttributes.archive_key2 (string)

        Missing property: data[n].data.hostg.generalAttributes.max_allowed_retcode (integer)

        Missing property: data[n].data.hostg.generalAttributes.mrt_method (integer)

        Missing property: data[n].data.hostg.generalAttributes.mrt_time (string)

        Missing property: data[n].data.hostg.generalAttributes.mrt_ert (integer)

        Missing property: data[n].data.hostg.generalAttributes.mrt_alarm (string)

        Missing property: data[n].data.hostg.generalAttributes.ert_check_last_runs (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_correction (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_deviation_extend (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_min_runs (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_method (integer)

        Missing property: data[n].data.hostg.generalAttributes.ert_trend (integer)

        Missing property: data[n].data.hostg.generalAttributes.srt_ert (integer)

        Missing property: data[n].data.hostg.generalAttributes.default_forecast_status (integer)

        Missing property: data[n].data.hostg.generalAttributes.time_zone (string)

        Missing property: data[n].data.hostg.generalAttributes.mrt_time_zone (string)

        Missing property: data[n].data.hostg.generalAttributes.has_object_variables (integer)

        Missing property: data[n].data.hostg.generalAttributes.inherit_object_variables (integer)

        Missing property: data[n].data.hostg.generalAttributes.file_scan_agent (string)

        Missing property: data[n].data.hostg.generalAttributes.file_scan_login (string)

        Missing property: data[n].data.hostg.generalAttributes.max_retcode_alarm (string)

        Missing property: data[n].data.hostg.generalAttributes.inherit_output_filter (string)

        Missing property: data[n].data.hostg.generalAttributes.child_queue (string)

        Missing property: data[n].data.hostg.generalAttributes.has_prompts (integer)

        Missing property: data[n].data.hostg.generalAttributes.has_output_filters (integer)

        Missing property: data[n].data.hostg.generalAttributes.is_template (integer)

        Missing property: data[n].data.hostg.generalAttributes.rollback_enabled (integer)

        Missing property: data[n].data.hostg.generalAttributes.is_inactive (integer)

        Missing property: data[n].data.hostg.generalAttributes.sub_type (string)

        Missing property: data[n].data.hostg.generalAttributes.deactivation_delay (integer)

        Missing property: data[n].data.hostg.generalAttributes.auto_deactivation (string)

        Missing property: data[n].data.hostg.generalAttributes.deactivation_condition (string)

        Missing property: data[n].data.hostg.generalAttributes.minimum_ae_version (string)

        Missing property: data[n].data.hostg.generalAttributes.object_authorizations (array)

        Missing property: data[n].data.user.general_attributes (object)

        Missing property: data[n].data.user.user_attributes (object)

        Missing property: data[n].data.user.authorizations[n].filter_type (string)

        Missing property: data[n].data.user.authorizations[n].filter_object_type (string)

        Missing property: data[n].data.user.authorizations[n].filter_object_name (string)

        Missing property: data[n].data.user.authorizations[n].filter_agent_name1 (string)

        Missing property: data[n].data.user.authorizations[n].filter_agent_name2 (string)

        Missing property: data[n].data.user.authorizations[n].filter_user_id1 (string)

        Missing property: data[n].data.user.authorizations[n].filter_user_id2 (string)

        Missing property: data[n].data.user.authorizations[n].filter_file_names1 (string)

        Missing property: data[n].data.user.authorizations[n].filter_file_names2 (string)

        Missing property: data[n].data.user.authorizations[n].authorizations_set (array)

        Missing property: data[n].data.user.authorizations[n].auth_group (integer)

13. GET/{client_id}/folderobjects/{folder_path}

    • Response

      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/octet-stream'

          Missing property: data[n].data.hostg.generalAttributes.modified_by (string)

          Missing property: data[n].data.hostg.generalAttributes.created_by (string)

          Missing property: data[n].data.hostg.generalAttributes.workflow_children (integer)

          Missing property: data[n].data.hostg.generalAttributes.is_shared (string)

          Missing property: data[n].data.hostg.generalAttributes.client0_object_id (integer)

          Missing property: data[n].data.hostg.generalAttributes.extended_reports (integer)

          Missing property: data[n].data.hostg.generalAttributes.max_wait_time (integer)

          Missing property: data[n].data.hostg.generalAttributes.max_parallel (integer)

          Missing property: data[n].data.hostg.generalAttributes.max_parallel_action (integer)

          Missing property: data[n].data.hostg.generalAttributes.archive_key1 (string)

          Missing property: data[n].data.hostg.generalAttributes.archive_key2 (string)

          Missing property: data[n].data.hostg.generalAttributes.max_allowed_retcode (integer)

          Missing property: data[n].data.hostg.generalAttributes.mrt_method (integer)

          Missing property: data[n].data.hostg.generalAttributes.mrt_time (string)

          Missing property: data[n].data.hostg.generalAttributes.mrt_ert (integer)

          Missing property: data[n].data.hostg.generalAttributes.mrt_alarm (string)

          Missing property: data[n].data.hostg.generalAttributes.ert_check_last_runs (integer)

          Missing property: data[n].data.hostg.generalAttributes.ert_correction (integer)

          Missing property: data[n].data.hostg.generalAttributes.ert_deviation_extend (integer)

          Missing property: data[n].data.hostg.generalAttributes.ert_min_runs (integer)

          Missing property: data[n].data.hostg.generalAttributes.ert_method (integer)

          Missing property: data[n].data.hostg.generalAttributes.ert_trend (integer)

          Missing property: data[n].data.hostg.generalAttributes.srt_ert (integer)

          Missing property: data[n].data.hostg.generalAttributes.default_forecast_status (integer)

          Missing property: data[n].data.hostg.generalAttributes.time_zone (string)

          Missing property: data[n].data.hostg.generalAttributes.mrt_time_zone (string)

          Missing property: data[n].data.hostg.generalAttributes.has_object_variables (integer)

          Missing property: data[n].data.hostg.generalAttributes.inherit_object_variables (integer)

          Missing property: data[n].data.hostg.generalAttributes.file_scan_agent (string)

          Missing property: data[n].data.hostg.generalAttributes.file_scan_login (string)

          Missing property: data[n].data.hostg.generalAttributes.max_retcode_alarm (string)

          Missing property: data[n].data.hostg.generalAttributes.inherit_output_filter (string)

          Missing property: data[n].data.hostg.generalAttributes.child_queue (string)

          Missing property: data[n].data.hostg.generalAttributes.has_prompts (integer)

          Missing property: data[n].data.hostg.generalAttributes.has_output_filters (integer)

          Missing property: data[n].data.hostg.generalAttributes.is_template (integer)

          Missing property: data[n].data.hostg.generalAttributes.rollback_enabled (integer)

          Missing property: data[n].data.hostg.generalAttributes.is_inactive (integer)

          Missing property: data[n].data.hostg.generalAttributes.sub_type (string)

          Missing property: data[n].data.hostg.generalAttributes.deactivation_delay (integer)

          Missing property: data[n].data.hostg.generalAttributes.auto_deactivation (string)

          Missing property: data[n].data.hostg.generalAttributes.deactivation_condition (string)

          Missing property: data[n].data.hostg.generalAttributes.minimum_ae_version (string)

          Missing property: data[n].data.hostg.generalAttributes.object_authorizations (array)

          Missing property: data[n].data.user.general_attributes (object)

          Missing property: data[n].data.user.user_attributes (object)

          Missing property: data[n].data.user.authorizations[n].filter_type (string)

          Missing property: data[n].data.user.authorizations[n].filter_object_type (string)

          Missing property: data[n].data.user.authorizations[n].filter_object_name (string)

          Missing property: data[n].data.user.authorizations[n].filter_agent_name1 (string)

          Missing property: data[n].data.user.authorizations[n].filter_agent_name2 (string)

          Missing property: data[n].data.user.authorizations[n].filter_user_id1 (string)

          Missing property: data[n].data.user.authorizations[n].filter_user_id2 (string)

          Missing property: data[n].data.user.authorizations[n].filter_file_names1 (string)

          Missing property: data[n].data.user.authorizations[n].filter_file_names2 (string)

          Missing property: data[n].data.user.authorizations[n].authorizations_set (array)

          Missing property: data[n].data.user.authorizations[n].auth_group (integer)

14. POST/{client_id}/objects

    • Request

      • Schema incompatible

        Changed body: 'application/json'

        Missing property: dataObject.generalAttributes.workflow_children (integer)

        Missing property: dataObject.generalAttributes.is_shared (string)

        Missing property: dataObject.generalAttributes.client0_object_id (integer)

        Missing property: dataObject.generalAttributes.extended_reports (integer)

        Missing property: dataObject.generalAttributes.max_wait_time (integer)

        Missing property: dataObject.generalAttributes.max_parallel (integer)

        Missing property: dataObject.generalAttributes.max_parallel_action (integer)

        Missing property: dataObject.generalAttributes.archive_key1 (string)

        Missing property: dataObject.generalAttributes.archive_key2 (string)

        Missing property: dataObject.generalAttributes.max_allowed_retcode (integer)

        Missing property: dataObject.generalAttributes.mrt_method (integer)

        Missing property: dataObject.generalAttributes.mrt_time (string)

        Missing property: dataObject.generalAttributes.mrt_ert (integer)

        Missing property: dataObject.generalAttributes.mrt_alarm (string)

        Missing property: dataObject.generalAttributes.ert_check_last_runs (integer)

        Missing property: dataObject.generalAttributes.ert_correction (integer)

        Missing property: dataObject.generalAttributes.ert_deviation_extend (integer)

        Missing property: dataObject.generalAttributes.ert_min_runs (integer)

        Missing property: dataObject.generalAttributes.ert_method (integer)

        Missing property: dataObject.generalAttributes.ert_trend (integer)

        Missing property: dataObject.generalAttributes.srt_ert (integer)

        Missing property: dataObject.generalAttributes.default_forecast_status (integer)

        Missing property: dataObject.generalAttributes.time_zone (string)

        Missing property: dataObject.generalAttributes.mrt_time_zone (string)

        Missing property: dataObject.generalAttributes.has_object_variables (integer)

        Missing property: dataObject.generalAttributes.inherit_object_variables (integer)

        Missing property: dataObject.generalAttributes.file_scan_agent (string)

        Missing property: dataObject.generalAttributes.file_scan_login (string)

        Missing property: dataObject.generalAttributes.max_retcode_alarm (string)

        Missing property: dataObject.generalAttributes.inherit_output_filter (string)

        Missing property: dataObject.generalAttributes.child_queue (string)

        Missing property: dataObject.generalAttributes.has_prompts (integer)

        Missing property: dataObject.generalAttributes.has_output_filters (integer)

        Missing property: dataObject.generalAttributes.is_template (integer)

        Missing property: dataObject.generalAttributes.rollback_enabled (integer)

        Missing property: dataObject.generalAttributes.is_inactive (integer)

        Missing property: dataObject.generalAttributes.sub_type (string)

        Missing property: dataObject.generalAttributes.deactivation_delay (integer)

        Missing property: dataObject.generalAttributes.auto_deactivation (string)

        Missing property: dataObject.generalAttributes.deactivation_condition (string)

        Missing property: dataObject.generalAttributes.minimum_ae_version (string)

        Missing property: dataObject.generalAttributes.object_authorizations (array)

15. GET/{client_id}/objects/{object_name}

    • Response

      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/json'
16. PATCH/{client_id}/objects/{object_name}

    • Request

      • Schema incompatible

        Changed body: 'application/json'

        Missing property: dataObject.generalAttributes.workflow_children (integer)

        Missing property: dataObject.generalAttributes.is_shared (string)

        Missing property: dataObject.generalAttributes.client0_object_id (integer)

        Missing property: dataObject.generalAttributes.extended_reports (integer)

        Missing property: dataObject.generalAttributes.max_wait_time (integer)

        Missing property: dataObject.generalAttributes.max_parallel (integer)

        Missing property: dataObject.generalAttributes.max_parallel_action (integer)

        Missing property: dataObject.generalAttributes.archive_key1 (string)

        Missing property: dataObject.generalAttributes.archive_key2 (string)

        Missing property: dataObject.generalAttributes.max_allowed_retcode (integer)

        Missing property: dataObject.generalAttributes.mrt_method (integer)

        Missing property: dataObject.generalAttributes.mrt_time (string)

        Missing property: dataObject.generalAttributes.mrt_ert (integer)

        Missing property: dataObject.generalAttributes.mrt_alarm (string)

        Missing property: dataObject.generalAttributes.ert_check_last_runs (integer)

        Missing property: dataObject.generalAttributes.ert_correction (integer)

        Missing property: dataObject.generalAttributes.ert_deviation_extend (integer)

        Missing property: dataObject.generalAttributes.ert_min_runs (integer)

        Missing property: dataObject.generalAttributes.ert_method (integer)

        Missing property: dataObject.generalAttributes.ert_trend (integer)

        Missing property: dataObject.generalAttributes.srt_ert (integer)

        Missing property: dataObject.generalAttributes.default_forecast_status (integer)

        Missing property: dataObject.generalAttributes.time_zone (string)

        Missing property: dataObject.generalAttributes.mrt_time_zone (string)

        Missing property: dataObject.generalAttributes.has_object_variables (integer)

        Missing property: dataObject.generalAttributes.inherit_object_variables (integer)

        Missing property: dataObject.generalAttributes.file_scan_agent (string)

        Missing property: dataObject.generalAttributes.file_scan_login (string)

        Missing property: dataObject.generalAttributes.max_retcode_alarm (string)

        Missing property: dataObject.generalAttributes.inherit_output_filter (string)

        Missing property: dataObject.generalAttributes.child_queue (string)

        Missing property: dataObject.generalAttributes.has_prompts (integer)

        Missing property: dataObject.generalAttributes.has_output_filters (integer)

        Missing property: dataObject.generalAttributes.is_template (integer)

        Missing property: dataObject.generalAttributes.rollback_enabled (integer)

        Missing property: dataObject.generalAttributes.is_inactive (integer)

        Missing property: dataObject.generalAttributes.sub_type (string)

        Missing property: dataObject.generalAttributes.deactivation_delay (integer)

        Missing property: dataObject.generalAttributes.auto_deactivation (string)

        Missing property: dataObject.generalAttributes.deactivation_condition (string)

        Missing property: dataObject.generalAttributes.minimum_ae_version (string)

        Missing property: dataObject.generalAttributes.object_authorizations (array)