Configuration and Content API Guide

Get Clone Request Status

post

/clones/sim/v1/getStatus

Gets the status of a specific clone request.

Request

Supported Media Types

application/json
multipart/form-data

Request body for getStatus.

Root Schema : RequestDetails

Type: object

Model for the Get Status

Show Source

requestId(required): integer

Unique reference of the clone request.

Example: 1

{
    "description":"Model for the Get Status",
    "type":"object",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "description":"Unique reference of the clone request.",
            "type":"integer",
            "example":1
        }
    }
}

Response

Supported Media Types

application/json

200 Response

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

Root Schema : GetCloneStatusResponse

Type: object

Model for Get Clone Status Response

Show Source

actualEndDateTimeUTC: string

The actual end date and time when the clone request was completed in UTC Format.

Example: 2022-01-23T09:21:00
configFileURL: string

The pre-authenticated URL of the object store from where the configuration can be cloned.

Example: https://objectstore. oracle.com/files/1
currDateTimeUTC: string

The current date time of the system in the UTC format.

Example: 2022-01-23T09:00:00
errorMsg: string

The error details if the clone process failed.

Example: Validation Failed
expectedEndDateTimeUTC: string

The expected date and time for the request to be completed.

Example: 2022-01-23T09:21:00
id: integer

The unique identifier of the request.

Example: 1
posDBVersion: string

The version of the Simphony POS database for which the clone was created.

Example: 34001
requestedDatetimeUTC: string

The date time when the clone request was submitted in UTC format.

Example: 2022-01-23T09:00:00
status: integer

Status of the clone request. 1- Queued 2- In Progress 3- Completed 4- Failed

Example: 3

{
    "description":"Model for Get Clone Status Response",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier of the request.",
            "type":"integer",
            "example":1
        },
        "currDateTimeUTC":{
            "description":"The current date time of the system in the UTC format.",
            "type":"string",
            "example":"2022-01-23T09:00:00"
        },
        "requestedDatetimeUTC":{
            "description":"The date time when the clone request was submitted in UTC format.",
            "type":"string",
            "example":"2022-01-23T09:00:00"
        },
        "status":{
            "description":"Status of the clone request. 1- Queued 2- In Progress 3- Completed 4- Failed",
            "example":3,
            "type":"integer"
        },
        "expectedEndDateTimeUTC":{
            "description":"The expected date and time for the request to be completed.",
            "type":"string",
            "example":"2022-01-23T09:21:00"
        },
        "actualEndDateTimeUTC":{
            "description":"The actual end date and 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"
        },
        "errorMsg":{
            "description":"The error details if the clone process failed.",
            "type":"string",
            "example":"Validation Failed"
        }
    }
}