Configuration Package Installation API
Overview
The article introduces the Public API Web Service for handling operations with the installation/uninstallation of the Configuration Packages
Start Installation
Initiates the asynchronous installation of the Configuration Package to the System. For obtaining the progressing information about the initiated installation process the method "Get Installation Progress" needs to be used.
POST https://{server_name}/wminstaller/api/installation?initonly={initonly}
URL attributes
Argument | Description | Type | Required |
---|---|---|---|
initOnly | Optional. Instructs to conduct only the validation of the provided Package, and do not run the installation procedure | Guid |
Headers
For a list of available HTTP request headers see Web Services: REST API integration.
POST body
Configuration Package as File Stream.
Response
The operation returns the information about the initiated installation process
Element | Description | Type |
---|---|---|
Message | Error message explaining why package installation has not been started | String |
State | Package installation current state. 0 - initialized, 1 - in progress, 2 - completed, 3 - canceled, 5 - failed | Integer |
Initiator | Id of the User who initiated the installation process | Guid |
PackageInfo | The details about the installation Package, like Name, Description, Vendor, etc. | Object |
Status codes and errors
Code | Message |
---|---|
401 | Unauthorized. The initiator is not the Administrator |
415 | The request Content-type is not defined |
500 | Internal Server Error. E.g. wrong reference or mandatory attribute is missing |
Installation Progress
Retrieves the information about currently installing Configuration Package or none, if no installation is active on Server
GET https://{server_name}/wminstaller/api/installation
Headers
For a list of available HTTP request headers see Web Services: REST API integration.
Response
Details about the current installation operation progress.
Element | Description | Type |
---|---|---|
Logs |
Information about the executed installation steps. Time - Datetime. The time of the installation step start; |
Object[] |
Exception | The message of the error which interrupted the installation process | String |
State | Package installation current state. 0 - initialized, 1 - in progress, 2 - completed, 3 - canceled, 5 - failed | Interger |
Status codes and errors
Code | Message |
---|---|
401 | Unauthorized. The initiator is not the Administrator |
415 | The request Content-type is not defined |
500 | Internal Server Error. E.g. wrong reference or mandatory attribute is missing |