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:
stringRequired:trueThe 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:
stringRequired:trueThe 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
- completed
-
Type:
booleanFlag indicating whether or not the job has completed or not. - completedPercentage
-
Type:
integerThe progress of the job represented as a percentage. - endTime
-
Type:
stringThe time that the job completed. - intervalToPoll
-
Type:
integerThe number of milliseconds to wait before polling the status of the job again. - links
-
Type:
arraylinksAdditional Properties Allowed:An array of test status links. - message
-
Type:
stringHuman readable message about the current processing status. - progress
-
Type:
stringThe current progress of the job. - requestStatus
-
Type:
integerThe status of the request the requested the job execution. - startTime
-
Type:
stringThe time that the job was started.
Nested Schema : links
Nested Schema : items
Type:
object- href
-
Type:
stringLink to the resource. - rel
-
Type:
stringThe relationship the link has to the resource.
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- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code