Api Change Log 24 -> 24.1

What's New

1. DELETE/{client_id}/system/users/{user_name}/connections Disconnect a user from system.
2. PATCH/{client_id}/system/users/{user}/move Move user to another client.
3. GET/{client_id}/telemetry/export/details Obtain detailed telemetry information as CSV.
4. PATCH/{client_id}/system/clients/{client_id} Update a client.
5. POST/{client_id}/system/clients Create a client
6. PATCH/{client_id}/system/clients Perform a custom operation on a list of clients. E.g. Go/Stop clients
7. POST/{client_id}/system/users Create or overwrite a user for a client

What's Deleted

What's Deprecated

What's Changed

1. GET/{client_id}/executions/{run_id}/reports Get Report list for a given execution.
2. GET/{client_id}/executions/{run_id}/reports/{report_type} Get Report content pages.
3. POST/{client_id}/executions/{run_id}/status

   • Request

     • New body: 'application/json'
     • Deleted body: '*/*'
4. POST/{client_id}/objects/{object_name}/duplicate

   • Request

     • Schema

       Changed body: 'application/json'

   • Response

     • Changed response : [200]//Successful duplication

       • Schema incompatible

         Changed body: 'application/json'
5. POST/{client_id}/forecasts/{forecast_id}

   • Request

     • Schema

       Changed body: '*/*'
6. GET/{client_id}/system/clients

   • Response

     • Changed response : [200]//successful operation

       • Schema

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

   • Parameters

     • fields in query
8. POST/{client_id}/executions

   • Request

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

   • Parameters

     • time_frame_option in query
     • zdu_version in query
     • fields in query
10. POST/{client_id}/folderobjects

    • Request

      • Schema

        Changed body: 'application/json'

      • Schema

        Changed body: 'application/octet-stream'

    • Response

      • Changed response : [default]//default response
        • New body: 'application/json'
        • Deleted body: '*/*'
11. DELETE/{client_id}/folderobjects/{folder_path}

    • Response

      • Changed response : [default]//default response
        • New body: 'application/json'
        • Deleted body: '*/*'
12. PATCH/{client_id}/folderobjects/{folder_path}

    • Request

      • Schema

        Changed body: '*/*'
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.user.generalAttributes (object)

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

14. POST/{client_id}/objects

    • Parameters

      • overwrite_locked_objects in query Notes Determines whether existing objects which are locked should get overwritten by the import change into Determines whether existing objects which are locked should get overwritten by the operation

    • Request

      • Schema

        Changed body: 'application/json'
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}

    • Parameters

      • overwrite_locked_objects in query Notes Determines whether existing objects which are locked should get overwritten by the import change into Determines whether existing objects which are locked should get overwritten by the operation
      • Deleteoverwrite_existing_objectsin query//Determines whether existing objects should get overwritten by the import

    • Request

      • Schema

        Changed body: 'application/json'