Difference between V21 and V12.3 AE REST API

What's New

1. POST/{client_id}/folderobjects Import objects to a target folder.
2. GET/{client_id}/folderobjects/{folder_path} Export all objects from a folder recursively.
3. GET/{client_id}/objects/{object_name}/timezone Returns the time zone used by an object definition or defaults if the object or time zone does not exist.
4. GET/{client_id}/system/agentgroups Lists available agent groups
5. POST/{client_id}/system/agentpacks Creates a pre-configured agent package. The response contains a link to a zip file.
6. GET/{client_id}/system/agentpacks/{filename} Download of pre-configured agent package (agent.zip).
7. GET/{client_id}/system/agents/authentication_package Gets the agent authentication package if LOCAL is set in UC_AS_SETTINGS.
8. GET/{client_id}/system/agents/{object_name} Returns detailed agent information
9. DELETE/{client_id}/system/agents/{object_name} Deletes an existing agent.
10. POST/{client_id}/system/agents/{object_name}/authenticate Authenticates a waiting agent.
11. GET/{client_id}/system/agents/{object_name}/authentication_package Gets the agent authentication package for the specified agent if LOCAL_REMOTE is set in UC_AS_SETTINGS.
12. POST/{client_id}/system/agents/{object_name}/rename Renames an existing agent object.
13. POST/{client_id}/system/agents/{object_name}/renew_transferkey Resets the transfer key of a non TLS agent.
14. POST/{client_id}/system/agents/{object_name}/resetpublickey Resets the public key of an agent.
15. GET/{client_id}/system/certificates Returns list of tls certificates of currently active JCP processes.
16. GET/{client_id}/system/metrics/prometheus Retrieve the AE performance metrics for the last scrapeIntervalSeconds as prometheus format
17. GET/{client_id}/system/ra-solutions Lists all installed RA solutions.
18. POST/{client_id}/system/ra-solutions Install/update RA solution.
19. POST/{client_id}/system/ra-solutions/upload Install/update RA solution with binary upload.
20. GET/{client_id}/system/ra-solutions/{object_name} Returns detailed RA solution information.
21. GET/{client_id}/system/metrics Retrieve the AE historic performance metrics with extended filter options
22. POST/{client_id}/system/agents Creates a new agent.

What's Deleted

1. POST/{client_id}/telemetry/consumption null

What's Deprecated

What's Changed

1. GET/{client_id}/executions/{run_id}/variables

   • Parameters

     • client_id in path
     • run_id in path

   • Response

     • New response : [405]//Method not allowed.
     • Changed response : [200]//successful operation

       • Schema incompatible

         Changed body: 'application/json'
2. POST/{client_id}/objects Can be used to import single objects.

   • Parameters

     • client_id in path
     • overwrite_existing_objects in query

   • Request

     • New body: 'application/json'
     • Deleted body: '*/*'

   • Response

     • New response : [200]//Successful import
     • New response : [400]//Bad request - request data is invalid
     • New response : [405]//Method not allowed.
     • Deleted response : [default]//successful operation
3. GET/{client_id}/objects/{object_name}/inputs

   • Parameters

     • client_id in path
     • object_name in path

   • Response

     • New response : [405]//Method not allowed.
     • Changed response : [200]//successful operation

       • Schema incompatible

         Changed body: 'application/json'
4. GET/{client_id}/telemetry/export/{start_from} Retrieve telemetry data per month as json for the last n months, including the current month.

   • Parameters

     • client_id in path
     • start_from in path

   • Response

     • New response : [400]//Bad request - request data is invalid
     • New response : [405]//Method not allowed.
     • Changed response : [200]//successful operation
       • Deleted body: 'application/json'
5. GET/{client_id}/executions/{run_id}/comments

   • Parameters

     • client_id in path
     • run_id in path

   • Response

     • New response : [405]//Method not allowed.
6. POST/{client_id}/executions/{run_id}/comments

   • Parameters

     • client_id in path
     • run_id in path

   • Response

     • New response : [405]//Method not allowed.
     • Changed response : [400]//Bad request - request data is invalid<br><br><span><b>45149</b>: Client '...' is not allowed to perform this action.</span><br><span><b>45150</b>: Property '...' may not be null.</span><br><span><b>45151</b>: Property '...' contains an invalid value. '...'.</span><br>
7. GET/{client_id}/executions/{run_id}/reports

   • Parameters

     • client_id in path
     • run_id in path

   • Response

     • New response : [405]//Method not allowed.
8. GET/{client_id}/executions/{run_id}/reports/{report_type}

   • Parameters

     • client_id in path
     • run_id in path
     • report_type in path
     • max_results in query
     • start_at in query

   • Response

     • New response : [405]//Method not allowed.
9. GET/{client_id}/objects/{object_name}

   • Parameters

     • Add fields in query//Optional list of additional fields.<br><strong>modification_details</strong> - Includes modification/creation date and user name.<br>
     • Add filter in query//Optional list of fields to reduce the response and improve performance. general_attributes are always returned. Other fields on the same level can be specified as filter.
     • client_id in path
     • object_name in path

   • Response

     • New response : [400]//Bad request - request data is invalid
     • New response : [405]//Method not allowed.
     • Changed response : [200]//successful operation

       • Schema incompatible

         Changed body: 'application/json'

         Changed property type: data (object -> object)

10. GET/{client_id}/repositories/branches/{branch_name}/diff

    • Parameters

      • client_id in path
      • branch_name in path
      • branch_name_theirs in query
      • object_path_ours in query
      • object_path_theirs in query

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
11. POST/{client_id}/repositories/pull

    • Parameters

      • client_id in path

    • Response

      • New response : [200]//successful operation
      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Deleted response : [default]//successful operation
12. POST/{client_id}/scripts

    • Parameters

      • client_id in path

    • Response

      • New response : [405]//Method not allowed.
13. DELETE/{client_id}/system/clients/{client_id}

    • Parameters

      • client_id in path

    • Response

      • New response : [405]//Method not allowed.
14. GET/{client_id}/system/health Can be used to determine if the automation system is in a healthy state.

    • Parameters

      • Add details in query//Parameter to include additional information about processes.
      • client_id in path

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [503]//Service Unavailable.
        • Deleted body: 'application/json'
      • Changed response : [200]

        • Schema incompatible

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

    • Parameters

      • client_id in path
      • run_id in path
      • fields in query Notes Parameter to include various additional information about an execution.<br><strong>comments</strong> - Includes a list of all comments that have been added to the execution<br><strong>variables</strong> - Includes a list of all object variables defined at the execution's scope<br><strong>reports</strong> - Includes a list of all report types of the execution<br><strong>restarts</strong> - Includes the number of restarts<br><strong>predecessors</strong> - Includes a list of the predecessors of a workflow task<br><strong>recurring</strong> - Includes details of a C_PERIOD task change into Parameter to include various additional information about an execution.<br><strong>comments</strong> - Includes a list of all comments that have been added to the execution<br><strong>variables</strong> - Includes a list of all object variables defined at the execution's scope<br><strong>reports</strong> - Includes a list of all report types of the execution<br><strong>restarts</strong> - Includes the number of restarts<br><strong>predecessors</strong> - Includes a list of the predecessors of a workflow task<br><strong>recurring</strong> - Includes details of a C_PERIOD task

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path
      • run_id in path

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path
      • run_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [405]//Method not allowed.
18. GET/{client_id}/forecasts/{forecast_id}

    • Parameters

      • client_id in path
      • forecast_id in path
      • name in query
      • estimated_start_from in query
      • estimated_start_to in query
      • agent_destination in query
      • agent_source in query
      • fields in query

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path
      • forecast_id in path

    • Request

      • Schema incompatible

        Changed body: '*/*'

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
21. POST/{client_id}/repositories

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/json'
22. POST/{client_id}/repositories/branches

    • Parameters

      • client_id in path

    • Request

    • Response

      • New response : [200]//successful operation
      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Deleted response : [default]//successful operation
23. GET/{client_id}/repositories/branches

    • Parameters

      • client_id in path
      • max_results in query
      • start_at in query

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
24. GET/{client_id}/repositories/branches/{branch_name}/log

    • Parameters

      • client_id in path
      • branch_name in path
      • max_results in query
      • start_at in query

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
25. GET/{client_id}/repositories/changes

    • Parameters

      • client_id in path
      • fields in query

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
26. POST/{client_id}/repositories/commits

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/json'
27. POST/{client_id}/repositories/commits/{commit_id}

    • Parameters

      • client_id in path
      • commit_id in path

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/json'
28. DELETE/{client_id}/repositories/merge

    • Parameters

      • client_id in path

    • Response

      • New response : [200]//Success
      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Deleted response : [default]//successful operation
29. POST/{client_id}/repositories/merge

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: 'application/json'

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path
      • max_results in query
      • name in query
      • active in query
      • ip_address in query
      • version in query
      • hardware in query
      • software in query
      • linked in query
      • platform in query

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
32. GET/{client_id}/system/clients

    • Parameters

      • client_id in path

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
33. GET/{client_id}/system/features

    • Parameters

      • client_id in path

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
34. GET/{client_id}/telemetry/products

    • Parameters

      • client_id in path

    • Response

      • New response : [400]//Bad request - request data is invalid
      • New response : [405]//Method not allowed.
35. GET/{client_id}/executions

    • Parameters

      • Add reference_run_id in query//RunID of the original execution, zero if this was not a restart.
      • Add fields in query//Parameter to include various additional information about an execution.<br><strong>restarts</strong> - Includes the number of restarts<br><strong>predecessors</strong> - Includes a list of the predecessors of a workflow task<strong>recurring</strong> - Includes details of a C_PERIOD task
      • client_id in path
      • max_results in query
      • start_at_run_id in query
      • run_id in query
      • name in query
      • name_exclude in query
      • alias in query
      • agent in query
      • agent_exclude in query
      • include_deactivated in query
      • time_frame_option in query
      • time_frame_from in query
      • time_frame_to in query
      • user in query
      • user_exclude in query
      • archive_key1 in query
      • archive_key1_exclude in query
      • archive_key2 in query
      • archive_key2_exclude in query
      • commented_only in query
      • modified_only in query
      • remote_status_number in query
      • remote_status_text in query
      • zdu_version in query

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
36. POST/{client_id}/executions

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [400]//Bad request - request data is invalid<br><br><span><b>45113</b>: Given string is not a valid object name</span><br><span><b>45114</b>: Given string is not a valid execution option</span><br><span><b>45115</b>: Object to be executed is not an executable one</span>
37. GET/{client_id}/executions/{run_id}/children

    • Parameters

      • client_id in path
      • run_id in path
      • max_results in query
      • start_at_run_id in query

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
38. DELETE/{client_id}/forecasts

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path

    • Request

      • Schema

        Changed body: '*/*'

    • Response

      • New response : [405]//Method not allowed.
40. GET/{client_id}/forecasts

    • Parameters

      • client_id in path
      • fc_title in query
      • fc_start_time in query
      • fc_end_time in query
      • fc_type in query
      • name in query
      • estimated_start_from in query
      • estimated_start_to in query
      • agent_destination in query
      • agent_source in query
      • fields in query

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path
      • name in query
      • type in query
      • version in query
      • from in query
      • to in query
      • execution_name in query
      • min_duration in query

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

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

    • Parameters

      • client_id in path
      • object_name in path

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
43. GET/{client_id}/objects/{object_name}/usage/calendarevent/{event_name}

    • Parameters

      • client_id in path
      • object_name in path
      • event_name in path

    • Response

      • New response : [405]//Method not allowed.
      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'