Api Change Log

What's New

1. POST/{client_id}/system/slo/search List SLO objects using a custom object filter, with results ordered by specified parameters in ascending or descending order.
2. POST/{client_id}/system/agents/{object_name}/reset_cau_target_version Resets the CAU target version for the given system agent.
3. POST/{client_id}/system/clients/revisionreport Start revision reporting for the client
4. GET/{client_id}/system/clients/revisionreport/{run_id} Get reporting file by run Id
5. GET/{client_id}/system/processes List all processes.

What's Deleted

What's Deprecated

What's Changed

1. GET/{client_id}/system/metrics/prometheus

   • Parameters

     • scrapeIntervalSeconds in query
2. POST/{client_id}/system/ra-solutions/upload

   • Parameters

     • algorithm in header
3. DELETE/{client_id}/system/users/{user_name}/tokens/{tokenName}

   • Parameters

     • target_client in query
4. GET/{client_id}/system/metrics

   • Parameters

     • time_frame_from in query
     • time_frame_to in query
5. POST/{client_id}/transportcase

   • Parameters

     • overwrite_existing_objects in query
     • overwrite_locked_objects in query
     • client in query
6. GET/{client_id}/executions/{run_id}/reports/{report_type}

   • Parameters

     • max_results in query
     • start_at in query
7. GET/{client_id}/system/agents/{object_name}

   • Response

     • Changed response : [200]//successful operation

       • Schema

         Changed body: 'application/json'
8. POST/{client_id}/system/agents/{object_name}/rename

   • Request

     • Schema incompatible

       Changed body: '*/*'
9. POST/{client_id}/system/zdu

   • Request

     • Schema incompatible

       Changed body: 'application/json'
10. POST/{client_id}/executions/{run_id}/modify_status

    • Request

      • Schema

        Changed body: 'application/json'
11. POST/{client_id}/executions/{run_id}/status

    • Request

      • Schema incompatible

        Changed body: 'application/json'
12. GET/{client_id}/repositories/branches

    • Parameters

      • max_results in query
      • start_at in query
13. GET/{client_id}/repositories/branches/{branch_name}/log

    • Parameters

      • max_results in query
      • start_at in query
14. POST/{client_id}/repositories/commits

    • Request

      • Schema incompatible

        Changed body: '*/*'
15. POST/{client_id}/repositories/merge

    • Request

      • Schema incompatible

        Changed body: '*/*'
16. GET/{client_id}/system/agentgroups

    • Parameters

      • Add id in query//Filter after agent groups object id.
      • Add name in query//Filter by name.
      • Add platform in query//Filter by platform type.
      • Add mode in query//Filter by agent group mode. A = any, F = first, N = next, L = load dependent, X = all
      • Add parallel_tasks in query//Filter by max parallel task.
      • Add client in query//Filter by client.
      • Add sort in query//Comma separated values. Use '+' or omit prefix for ascending order and '-' for descending order.
17. POST/{client_id}/system/agents

    • Request

      • Schema incompatible

        Changed body: '*/*'
18. GET/{client_id}/system/agents

    • Parameters

      • Add sort in query//Comma separated values. Use '+' or omit prefix for ascending order and '-' for descending order.
      • max_results in query

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
19. PATCH/{client_id}/system/clients

    • Request

      • Schema incompatible

        Changed body: '*/*'
20. POST/{client_id}/system/clients/archive

    • Parameters

      • target_client in query Notes The parameter indicates the client to be archived change into The parameter indicates the client to be processed

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
21. POST/{client_id}/system/users/{user_name}/tokens

    • Request

      • Schema incompatible

        Changed body: 'application/json'
22. GET/{client_id}/system/users/{user_name}/tokens

    • Parameters

      • target_client in query
23. GET/{client_id}/executions/{run_id}

    • Response

      • Changed response : [200]//successful operation

        • Schema

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

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
25. GET/{client_id}/forecasts/agents

    • Parameters

      • min_duration in query
26. POST/{client_id}/search

    • Parameters

      • Add sort in query//Comma separated values. Use '+' or omit prefix for ascending order and '-' for descending order. You can use here same values as in sort_columns field in request body of this endpoint. If present, this parameter overrides sort_columns field in request body.
27. GET/{client_id}/system/health

    • Parameters

      • details in query
28. GET/{client_id}/executions

    • Parameters

      • Add sort in query//Comma separated values. Use '+' or omit prefix for ascending order and '-' for descending order.
      • Add parent_run_id in query//Query parent run id.
      • Add cau_version in query//Query CAU version. Supports wildcards (*).
      • max_results in query
      • time_frame_from in query
      • time_frame_to in query
      • zdu_version in query

    • Response

      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • max_results in query
      • Deleterelation_typein query//Type of parent-child relation. If omitted, the default value of 'processor' is applied.

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
30. GET/{client_id}/system/users

    • Parameters

      • lastSession in query
      • start_at in query
      • max_results in query
      • sort in query Notes Comma separated values. Use '+' or omit prefix for ASC order and '-' for DESC order. change into Comma separated values. Use '+' or omit prefix for ascending order and '-' for descending order.
31. POST/{client_id}/system/users

    • Parameters

      • overwrite_existing_user in query
      • overwrite_locked_user in query

    • Request

      • Schema incompatible

        Changed body: 'application/json'
32. POST/{client_id}/objects

    • Parameters

      • overwrite_locked_objects in query
      • overwrite_existing_objects in query

    • Request

      • Schema incompatible

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

    • Parameters

      • overwrite_existing_objects in query
      • overwrite_locked_objects in query
      • folder_path in query

    • Request

      • Schema incompatible

        Changed body: 'application/json'

      • Schema incompatible

        Changed body: 'application/octet-stream'
34. DELETE/{client_id}/folderobjects/{folder_path}

    • Parameters

      • recursive in query
35. GET/{client_id}/folderobjects/{folder_path}

    • Response

      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/octet-stream'
36. DELETE/{client_id}/objects/{object_name}

    • Parameters

      • ignore_references in query
37. PATCH/{client_id}/objects/{object_name}

    • Parameters

      • overwrite_locked_objects in query

    • Request

      • Schema incompatible

        Changed body: 'application/json'
38. GET/{client_id}/objects/{object_name}

    • Response

      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/json'