Jump to

• Request
• Response

Create Clone

post

/clones/sim/v1/createConfig

Create the clone request for the given organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A Clone request

Root Schema : CreateCloneRequest

Type: object

Model for Create Clone Config

Show Source

• cloneName(required): string
  A user-friendly name for the clone configuration for the organization. This should be unique per organization.

  Example: MyClone

{
    "description":"Model for Create Clone Config",
    "type":"object",
    "required":[
        "cloneName"
    ],
    "properties":{
        "cloneName":{
            "description":"A user-friendly name for the clone configuration for the organization. This should be unique per organization.",
            "type":"string",
            "example":"MyClone"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request details after successfully submitting a request for export operation.

Body ()

Root Schema : CreateCloneResponse

Type: object

Model for Create Clone Response Object

Show Source

• requestId(required): integer
  Unique reference of the clone request. This attribute can be used to track the status of the clone request.

  Example: 1
• requestTimeStampUTC(required): string
  The time stamp in UTC format for when the request was submitted.

  Example: 2022-10-10T00:00:00

{
    "description":"Model for Create Clone Response Object",
    "type":"object",
    "required":[
        "requestId",
        "requestTimeStampUTC"
    ],
    "properties":{
        "requestId":{
            "description":"Unique reference of the clone request. This attribute can be used to track the status of the clone request.",
            "type":"integer",
            "example":1
        },
        "requestTimeStampUTC":{
            "description":"The time stamp in UTC format for when the request was submitted.",
            "type":"string",
            "example":"2022-10-10T00:00:00"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top