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.
- Bulk Export
- Bulk Export with Versions
- Bulk Export Activity
- Bulk Export Audit
- Bulk Export History
- Bulk Import
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 | |
Response Properties |
Bulk Export: Example Response
XML Response | JSON Response |
---|---|
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 | |
Response Properties |
Bulk Export with Versions: Example Response
XML Response | JSON Response |
---|---|
Bulk Export Activity
Description | |
---|---|
URI | http://host_name/uc/resources/serveroperation/bulkexportactivity |
HTTP Method | POST |
Description | Performs a Bulk Export Activity server operation. |
Example URI | http://localhost:8080/uc/resources/serveroperation/bulkxportactivity |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Response Properties |
Bulk Export Activity: Example Response
Success
XML Response | JSON Response |
---|---|
Failure
XML Response | JSON Response |
---|---|
Bulk Export Audit
Description | |
---|---|
URI | http://host_name/uc/resources/serveroperation/bulkexportaudit |
HTTP Method | POST |
Description | Performs a Bulk Export Audit server operation. |
Example URI | http://localhost:8080/uc/resources/serveroperation/bulkexportaudit |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Response Properties |
Bulk Export Audit: Example Response
XML Response | JSON Response |
---|---|
Bulk Export History
Description | |
---|---|
URI | http://host_name/uc/resources/serveroperation/bulkexporthistory |
HTTP Method | POST |
Description | Performs a Bulk Export History server operation. |
Example URI | http://localhost:8080/uc/resources/serveroperation/bulkexporthistory |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Response Properties |
Bulk Export History: Example Response
XML Response | JSON Response |
---|---|
Bulk Export: Response Properties
Property | UI Field Name | Description | Specifications |
---|---|---|---|
operation | n/a | Server Operation that was performed. | |
success | n/a | Result of the Server Operation. | Boolean; Valid values: true/false. |
output | n/a | Output of the server operation. | |
path | n/a | Directory containing the exported files. |
Bulk Import
Description | |
---|---|
URI | http://host_name/uc/resources/serveroperation/bulkimport |
HTTP Method | POST |
Description | Performs a Bulk Import server operation. |
URI Parameters | See Bulk Import: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Response Properties |
Bulk Import: URI Parameters
Name | Description | Specifications | Required |
---|---|---|---|
path | Directory containing the imported file(s). | Y |
Note
Some characters in the path parameter may need to be URL-encoded. For example, the backslash character in a Windows path may need to be encoded as %5C as shown below:
Bulk Import: Example Response
XML Response | JSON Response |
---|---|
Bulk Import: Response Properties
Property | UI Field Name | Description | Specifications |
---|---|---|---|
operation | n/a | Server Operation that was performed. | |
success | n/a | Result of the Server Operation. | Boolean; Valid values: true/false. |
output | n/a | Output of the server operation. |