Start export
post
<servername>/fscmUI/applcoreApi/v2/csm/export
Start a CSM archive export process.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
description(required): string
Description of the configuration set to be exported.
-
isFullExport: string
Allowed Values:
[ "Y", "N" ]
Setting the flag to 'Y' will force a full migration instead of delta migration. -
name(required): string
Name of the configuration set to be exported.
-
optionalModules: array
optionalModules
List of optional modules to be included in the exported configuration set.
-
options: object
ExportOption
A (string, boolean) map of options. `SKIP_TARGET_CHECK` is an example key.
Nested Schema : optionalModules
Type:
array
List of optional modules to be included in the exported configuration set.
Show Source
Nested Schema : ExportOption
Type:
object
A (string, boolean) map of options. `SKIP_TARGET_CHECK` is an example key.
Show Source
-
SKIP_TARGET_CHECK: boolean
Setting the flag to `true` will skip release version comparison between source and registered target environment.
Response
Supported Media Types
- application/json
200 Response
Operation already in progress.
Root Schema : StandardResponse
Type:
Show Source
object
-
csId: string
The identifier of created Configuration Set.
-
csmSandboxId: string
The identifier of the CSM Sandbox created on target environment as part of `Import` operation.
-
detailedLog: string
Detailed log of current operation.
-
message: string
Description of the current operational state.
-
status: string
Short status code of the current operational status.
-
targetPushStatus: string
Status of the configuration set archive being uploaded to target environment.
-
userDetails: string
Instructions or hint for user to action upon.
201 Response
Operation started.
Root Schema : StandardResponse
Type:
Show Source
object
-
csId: string
The identifier of created Configuration Set.
-
csmSandboxId: string
The identifier of the CSM Sandbox created on target environment as part of `Import` operation.
-
detailedLog: string
Detailed log of current operation.
-
message: string
Description of the current operational state.
-
status: string
Short status code of the current operational status.
-
targetPushStatus: string
Status of the configuration set archive being uploaded to target environment.
-
userDetails: string
Instructions or hint for user to action upon.
400 Response
Could not start the operation.
Root Schema : ErrorResponse
Type:
Show Source
object
-
message: string
Description of the error.
-
status: string
Short status code of the error.
-
userDetails: string
Instructions or hint for user to action upon.