KSC Open API
Kaspersky Security Center API description
wstring MigrationData::Export ( params  pOptions)

Performs export of objects.

Exports all objects, specified in pOptions, and returns async action GUID, which can be used later to retrieve file URL. To provide more consistency, method can also export some additional "child" objects, which are referred to by "parent" objects, specified by user. As a result, user receives GUID to async action, containing URL to zip-archive with all exported data

Parameters:
pOptions(params) Export options, which include the following (see below). All options are mandatory!
  • KLMIGR_ROOT_GROUP_ID (paramInt) root group identifier
  • KLMIGR_ARR_ID_REPORTS (paramArray of paramInt) identifiers of report templates
  • KLMIGR_ARR_ID_CMN_TASKS (paramArray of paramInt) non-group tasks identifiers
  • KLMIGR_ARR_ID_EXTRA_QRS (paramArray of paramInt) extra (user-created) queries identifiers
  • KLMIGR_ARR_PRODUCTS_INFO (paramArray of paramParams) array of params, where each element contains the following:
    • KLMIGR_PRODUCT_INFO_NAME (paramString) name of product, for which tasks and policies should be exported
    • KLMIGR_PRODUCT_INFO_VERSION (paramString) version of product, for which tasks and policies should be exported
  • KLMIGR_SKIP_CUSTOM_ROLES (paramBool) skip import of custom roles
  • KLMIGR_SKIP_USERS_GROUPS (paramBool) skip import of internal users and security groups
  • KLMIGR_SKIP_CUSTOM_APP_CATEGORIES (paramBool) skip import of custom application categories
  • KLMIGR_REQUEST_ID (paramString) Optional. Custom request id which can be set by user
Returns:
(wstring) wstrActionGuid async action GUID, which can be used to retrieve zip-archive URL
Remarks:
Check the operation state by calling AsyncActionStateChecker::CheckActionState periodically until it's finalized or cancel it by calling MigrationData::CancelExport. If the operation succeeds then AsyncActionStateChecker::CheckActionState returns URL-path to zip archive with exported data in pStateData. Otherwise, a call to AsyncActionStateChecker::CheckActionState returns error in pStateData.
Exceptions:
Throwsexception in case of error.