Jump to

• Request
• Response

Import configuration data

post

/clones/sim/v1/importConfig

either from a configuration data file or from a configuration file URL. Execute create config before this call. To download the configuration data use the URL from Status response(this url will be active for 15 min only in Object storage) and then import

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string(string)
  Org Identifier

Form Parameters

• configDataFile: file
  The config data file.
• configFileURL: integer
  The pre-authenticated URL of the object store from where the configuration can be cloned.
• importType: string
  The type of file for import.

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

Body ()

Root Schema : CreateCloneResponse

Type: object

Model for Create Clone Response Object

Show Source

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

  Example: 1
• requestTimeStampUTC(optional): 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",
    "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(optional): string
  A short, human-readable summary of the problem.

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

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

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

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

  Example: VALIDATION ERROR
• type(optional): 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",
    "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