Jump to

• Request
• Response

Cancel migration process

post

<servername>/fscmUI/applcoreApi/v2/csm/cancel/{csId}

Cancel migration process.

Request

Path Parameters

• csId(required): string
  Configuration Set ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• mdsFileId: string
  MDS File ID for specific identification when trying to access older configuration sets with same csId as new configuration set.

{
    "type":"object",
    "properties":{
        "mdsFileId":{
            "type":"string",
            "description":"MDS File ID for specific identification when trying to access older configuration sets with same csId as new configuration set."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 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 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."
        }
    }
}

404 Response

Configuration Set not found.

Back to Top