Difference between 12.3 and V12.2 AE REST API

What's New

  1. GET/{client_id}/forecasts List all forecasts, ordered descending by start_time.
  2. POST/{client_id}/forecasts Create a forecast.
  3. DELETE/{client_id}/forecasts Delete forecasts using ids.
  4. GET/{client_id}/forecasts/agents List forecast agents and gaps.
  5. GET/{client_id}/forecasts/{forecast_id} Get details of a given forecast.
  6. POST/{client_id}/forecasts/{forecast_id} Changes the title of a forecast item.
  7. GET/{client_id}/objects/{object_name}/usage Returns a list of objects with a reference name, a boolean to show if the actual result has hidden objects due to acl conflicts, for the given objectname
  8. GET/{client_id}/objects/{object_name}/usage/calendarevent/{event_name} Returns a list of objects with a reference name, a boolean to show if the actual result has hidden objects due to acl conflicts, for the given objectname
  9. POST/{client_id}/scripts Runs scripts written in the Automation Engine scripting language.
  10. GET/{client_id}/system/agents Lists all agents that are defined in the system. The returned list contains running and stopped agents.
  11. GET/{client_id}/system/clients List of clients in the system.
  12. DELETE/{client_id}/system/clients/{client_id} Delete a client

What's Deleted

    What's Deprecated

      What's Changed

      1. POST/{client_id}/objects

        • Parameters

          • Add overwrite_existing_objects in query//Determines whether existing objects should get overwritten by the import
      2. GET/{client_id}/executions/{run_id}

        • Response

          • Changed response : [200]//successful operation

            • Schema

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

        • Response

          • Changed response : [200]//successful operation

            • Schema

              Changed body: 'application/json'
      4. POST/{client_id}/search

        • Response

          • Changed response : [200]//successful operation

            • Schema

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

        • Parameters

          • Add run_id in query//RunID of the execution.
          • Add name_exclude in query//Exclude object name.
          • Add agent_exclude in query//Exclude agent name.
          • Add user in query//Username to query. Supports wildcards (*).
          • Add user_exclude in query//Exclude username.
          • Add archive_key1 in query//Archive key1 to query. Supports wildcards (*).
          • Add archive_key1_exclude in query//Exclude archive key1.
          • Add archive_key2 in query//Archive key2 to query. Supports wildcards (*).
          • Add archive_key2_exclude in query//Exclude archive key2.
          • Add commented_only in query//Query only commented tasks.
          • Add modified_only in query//Query only modified workflows.
          • Add remote_status_number in query//Remote status text to query.
          • Add remote_status_text in query//Remote status number to query.
          • Add zdu_version in query//Query ZDU Version.
          • Add sync_usage in query//Sync objects to query. Supports multiple, comma-separated values.

        • Response

          • Changed response : [200]//successful operation

            • Schema

              Changed body: 'application/json'
      6. POST/{client_id}/executions
        • GET/{client_id}/executions/{run_id}/children

          • Response

            • Changed response : [200]//successful operation

              • Schema

                Changed body: 'application/json'