Jump to

• Request
• Response

Get Clones

post

/clones/sim/v1/getClones

Gets the list of successful clone requests. The system maintains only last five clone configurations that were created for the organization.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object consisting of the status of the previously submitted clone request.

Body ()

Root Schema : GetAvailableCloneResponse

Type: object

Model for Get Available Clone Response

Show Source

• actualEndDateTimeUTC(required): string
  The actual end date time when the clone request was completed in UTC Format.

  Example: 2022-01-23T09:21:00
• cloneName(required): string
  A user-friendly name for the clone configuration for the organization. This should be unique per organization.

  Example: MyClone
• configFileURL(required): string
  The pre-authenticated URL of the object store from where the configuration can be cloned.

  Example: https://objectstore. oracle.com/files/1
• posDBVersion(required): string
  The version of the Simphony POS database for which the clone was created.

  Example: 34001

{
    "description":"Model for Get Available Clone Response",
    "type":"object",
    "required":[
        "cloneName",
        "actualEndDateTimeUTC",
        "posDBVersion",
        "configFileURL"
    ],
    "properties":{
        "cloneName":{
            "description":"A user-friendly name for the clone configuration for the organization. This should be unique per organization.",
            "type":"string",
            "example":"MyClone"
        },
        "actualEndDateTimeUTC":{
            "description":"The actual end date time when the clone request was completed in UTC Format.",
            "type":"string",
            "example":"2022-01-23T09:21:00"
        },
        "posDBVersion":{
            "description":"The version of the Simphony POS database for which the clone was created.",
            "type":"string",
            "example":34001
        },
        "configFileURL":{
            "description":"The pre-authenticated URL of the object store from where the configuration can be cloned.",
            "type":"string",
            "example":"https://objectstore. oracle.com/files/1"
        }
    }
}

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