/
Server Operations Web Services - Export and Import

Server Operations Web Services - Export and Import

Overview

Universal Controller supports the following RESTful-based web services for Export and Import Server Operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Bulk Export


Description

URI

http://host_name/uc/resources/serveroperation/bulkexport

HTTP Method

POST

Description

Performs a Bulk Export server operation.

Example URI

http://localhost:8080/uc/resources/serveroperation/bulkexport

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Bulk Export: XML and JSON Examples.

Response Properties

See Bulk Export: Response Properties.

Bulk Export: Example Response

XML Response

JSON Response

 XML Response
<serverOperationResponse>
     <operation>Bulk Export</operation>
     <success>true</success>
     <output>Bulk export completed successfully.
Bulk exporting table: ops_abort_action
No records exported for table ops_abort_action.
...
Bulk exporting table: ops_backup
Bulk exporting 3 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_backup.xml".
Bulk exporting table: ops_bundle
No records exported for table ops_bundle.
...
Bulk exporting table: ops_calendar
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_calendar.xml".
Bulk exporting table: ops_config
Bulk exporting 134 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_config.xml".
Bulk exporting table: ops_credentials
No records exported for table ops_credentials.
...
Bulk exporting table: ops_task_manual
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_task_manual.xml".
Bulk exporting table: ops_task_monitor
No records exported for table ops_task_monitor.
...
Bulk exporting table: ops_task_sleep
Bulk exporting 3 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_task_sleep.xml".
Bulk exporting table: ops_task_sql
No records exported for table ops_task_sql.
...
Bulk exporting table: ops_trigger_manual
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_trigger_manual.xml".
Bulk exporting table: ops_trigger_temp
No records exported for table ops_trigger_temp.
...
Bulk exporting table: ops_unix_agent_cluster
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_unix_agent_cluster.xml".
Bulk exporting table: ops_unix_agent_cluster_join
No records exported for table ops_unix_agent_cluster_join.
...
Bulk exporting table: ops_windows_agent_cluster
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_windows_agent_cluster.xml".
Bulk exporting table: ops_win_agent_cluster_join
No records exported for table ops_win_agent_cluster_join.
...
Bulk exporting table: ops_group_has_role
Bulk exporting 6 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_group_has_role.xml".
Bulk exporting table: ops_user
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_user.xml".
Bulk exporting table: ops_user_grmember
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_user_grmember.xml".
Bulk exporting table: ops_user_group
Bulk exporting 2 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_user_group.xml".
Bulk exporting table: ops_user_has_role
Bulk exporting 25 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_user_has_role.xml".
Bulk exporting table: ops_permission
Bulk exporting 8 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_permission.xml".
Bulk exporting table: ops_user_preference
No records exported for table ops_user_preference.
...
Bulk exporting table: ops_nav_tree_pref
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_nav_tree_pref.xml".
Bulk exporting table: ops_ldap
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_ldap.xml".
Bulk exporting table: ops_ldap_mapping
Bulk exporting 13 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_ldap_mapping.xml".
Bulk exporting table: ops_single_sign_on
Bulk exporting 2 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_single_sign_on.xml".
Bulk exporting table: ops_chart_color
Bulk exporting 26 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_chart_color.xml".
Bulk exporting table: ops_widget_activity
No records exported for table ops_widget_activity.
...
Bulk exporting table: ops_dashboard
Bulk exporting 1 record(s) to file "D:\tomcat\uc_export\Tue_Jun_19_14_23_59_EDT_2018-BULK_EXPORT\ops_dashboard.xml".
Bulk exporting table: ops_dashboard_portlet
No records exported for table ops_dashboard_portlet.
...
Bulk exporting table: ops_unv_tmplt_field_choice
No records exported for table ops_unv_tmplt_field_choice.
     </output>
     <path>D:\tomcat\uc_export\Fri_Jun_15_14_27_58_EDT_2018-BULK_EXPORT</path>
</serverOperationResponse>
 JSON Response
{
  "operation": "Bulk Export",
  "success": true,
  "output": "Bulk export completed successfully.\nBulk exporting table: ops_abort_action\nNo records exported for table ops_abort_action.
...
\nBulk exporting table: ops_backup\nBulk exporting 3 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_backup.xml\".
\nBulk exporting table: ops_bundle\nNo records exported for table ops_bundle.
...
\nBulk exporting table: ops_calendar\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_calendar.xml\".
\nBulk exporting table: ops_config\nBulk exporting 134 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_config.xml\".
\nBulk exporting table: ops_credentials\nNo records exported for table ops_credentials.
...
\nBulk exporting table: ops_task_manual\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_task_manual.xml\".
\nBulk exporting table: ops_task_monitor\nNo records exported for table ops_task_monitor.
...
\nBulk exporting table: ops_task_sleep\nBulk exporting 3 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_task_sleep.xml\".
\nBulk exporting table: ops_task_sql\nNo records exported for table ops_task_sql.
...
\nBulk exporting table: ops_trigger_manual\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_trigger_manual.xml\".
\nBulk exporting table: ops_trigger_temp\nNo records exported for table ops_trigger_temp.
...
\nBulk exporting table: ops_unix_agent_cluster\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_unix_agent_cluster.xml\".
\nBulk exporting table: ops_unix_agent_cluster_join\nNo records exported for table ops_unix_agent_cluster_join.
...
\nBulk exporting table: ops_windows_agent_cluster\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_windows_agent_cluster.xml\".
\nBulk exporting table: ops_win_agent_cluster_join\nNo records exported for table ops_win_agent_cluster_join.
...
\nBulk exporting table: ops_group_has_role\nBulk exporting 6 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_group_has_role.xml\".
\nBulk exporting table: ops_user\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_user.xml\".
\nBulk exporting table: ops_user_grmember\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_user_grmember.xml\".
\nBulk exporting table: ops_user_group\nBulk exporting 2 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_user_group.xml\".
\nBulk exporting table: ops_user_has_role\nBulk exporting 25 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_user_has_role.xml\".
\nBulk exporting table: ops_permission\nBulk exporting 8 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_permission.xml\".
\nBulk exporting table: ops_user_preference\nNo records exported for table ops_user_preference.
...
\nBulk exporting table: ops_nav_tree_pref\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_nav_tree_pref.xml\".
\nBulk exporting table: ops_ldap\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_ldap.xml\".
\nBulk exporting table: ops_ldap_mapping\nBulk exporting 13 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_ldap_mapping.xml\".
\nBulk exporting table: ops_single_sign_on\nBulk exporting 2 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_single_sign_on.xml\".
\nBulk exporting table: ops_chart_color\nBulk exporting 26 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_chart_color.xml\".
\nBulk exporting table: ops_widget_activity\nNo records exported for table ops_widget_activity.
...
\nBulk exporting table: ops_dashboard\nBulk exporting 1 record(s) to file \"D:\\tomcat\\uc_export\\Tue_Jun_19_14_27_17_EDT_2018-BULK_EXPORT\\ops_dashboard.xml\".
\nBulk exporting table: ops_dashboard_portlet\nNo records exported for table ops_dashboard_portlet.
...
.\nBulk exporting table: ops_unv_tmplt_field_choice\nNo records exported for table ops_unv_tmplt_field_choice.\n",
  "path":  "D:\\tomcat\\uc_export\\Fri_Jun_15_14_27_29_EDT_2018-BULK_EXPORT"
}

Bulk Export with Versions


Description

URI

http://host_name/uc/resources/serveroperation/bulkexportwithversions

HTTP Method

POST

Description

Performs a Bulk Export with Versions server operation.

Example URI

http://localhost:8080/uc/resources/serveroperation/bulkexportwithversions

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Bulk Export with Versions: Example Response.

Response Properties

See Bulk Export: Response Properties.

Bulk Export with Versions: Example Response

XML Response

JSON Response

 XML Response
<serverOperationResponse> 
     <operation>Bulk Export with Versions</operation>
     <success>true<