Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the configuration set to be exported."
        },
        "description":{
            "type":"string",
            "description":"Description of the configuration set to be exported."
        },
        "isFullExport":{
            "type":"string",
            "description":"Setting the flag to 'Y' will force a full migration instead of delta migration.",
            "enum":[
                "Y",
                "N"
            ]
        },
        "optionalModules":{
            "type":"array",
            "description":"List of optional modules to be included in the exported configuration set.",
            "items":{
                "type":"string"
            }
        },
        "options":{
            "$ref":"#/components/schemas/ExportOption"
        }
    }
}

Nested Schema : optionalModules

Type: array

List of optional modules to be included in the exported configuration set.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of optional modules to be included in the exported configuration set.",
    "items":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "SKIP_TARGET_CHECK":{
            "type":"boolean",
            "description":"Setting the flag to `true` will skip release version comparison between source and registered target environment."
        }
    },
    "description":"A (string, boolean) map of options. `SKIP_TARGET_CHECK` is an example key."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation already in progress.

Body ()

Root Schema : StandardResponse

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the current operational status."
        },
        "message":{
            "type":"string",
            "description":"Description of the current operational state."
        },
        "csId":{
            "type":"string",
            "description":"The identifier of created Configuration Set."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        },
        "detailedLog":{
            "type":"string",
            "description":"Detailed log of current operation."
        },
        "targetPushStatus":{
            "type":"string",
            "description":"Status of the configuration set archive being uploaded to target environment."
        },
        "csmSandboxId":{
            "type":"string",
            "description":"The identifier of the CSM Sandbox created on target environment as part of `Import` operation."
        }
    }
}

201 Response

Operation started.

Body ()

Root Schema : StandardResponse

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the current operational status."
        },
        "message":{
            "type":"string",
            "description":"Description of the current operational state."
        },
        "csId":{
            "type":"string",
            "description":"The identifier of created Configuration Set."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        },
        "detailedLog":{
            "type":"string",
            "description":"Detailed log of current operation."
        },
        "targetPushStatus":{
            "type":"string",
            "description":"Status of the configuration set archive being uploaded to target environment."
        },
        "csmSandboxId":{
            "type":"string",
            "description":"The identifier of the CSM Sandbox created on target environment as part of `Import` operation."
        }
    }
}

400 Response

Could not start the operation.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• message: string
  Description of the error.
• status: string
  Short status code of the error.
• userDetails: string
  Instructions or hint for user to action upon.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the error."
        },
        "message":{
            "type":"string",
            "description":"Description of the error."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        }
    }
}

Back to Top