getTestStatus

get

/ccadminx/v1/testStatus/{id}

Get Test Status. Returns the status of a given test job from the extension server.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The id of the job to return the status of. Job Id is the date time the job was created in the format of yyyyMMddHHmm.
Query Parameters
extensionName
Type: string
Required: true
The name of the extension that the test job was executed against.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getTestStatus_response
Example application/json

{
    "completedPercentage":100,
    "intervalToPoll":250,
    "progress":"succeeded",
    "startTime":"2016-12-20T09:25:11.559Z",
    "links":[
        {
            "rel":"self",
            "href":"/ccadminx/custom/v1/testStatus/201612200925?extensionName=externalShippingCalculator"
        },
        {
            "rel":"related",
            "href":"/ccadminx/custom/v1/testJobs/201612200925?extensionName=externalShippingCalculator"
        }
    ],
    "completed":true,
    "endTime":"2016-12-20T09:25:11.788Z",
    "message":"Job completed successfully.",
    "requestStatus":202
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object