getTestJobResults
get
/ccadmin/v1/testJobs/{id}
Get Test Job Results. Returns the status of a given test job from the extension server.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The id of the job to return the results for. Job Id is the date time the job was created in the format of yyyyMMddHHmm.
Query Parameters
-
extensionName: string
The name of the extension that the test job is to be executed for.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getTestJobResults_response
Type:
Show Source
object-
extensionName(optional):
string
The name of the extension that the lint job is to be executed for.
-
jobId(optional):
string
The id of the job to return the results for. Job Id is the date time the job was created in the format of yyyyMMddHHmm.
-
status(optional):
string
The status of the job that the results belong to.
-
testResults(optional):
array testResults
An array of test results.
Nested Schema : items
Type:
Show Source
object-
description(optional):
string
The test description as defined in the test file itself.
-
failedExpectations(optional):
array failedExpectations
An array of the failed expectations.
-
fullName(optional):
string
The full name of the test as defined in the test file itself.
-
id(optional):
string
The id of the test suite.
-
specs(optional):
array specs
An array of test spec result details.
-
status(optional):
string
The status of the test suite.
Nested Schema : items
Type:
Show Source
object-
matcherName(optional):
string
The name of the matcher used.
-
message(optional):
string
Human readable message for the failed expectation.
-
passed(optional):
boolean
flag to denote if this is a pass of failure.
-
stack(optional):
string
The error stack.
Nested Schema : items
Type:
Show Source
object-
description(optional):
string
The test description as defined in the test file itself.
-
failedExpectations(optional):
array failedExpectations
An array of the failed expectations.
-
fullName(optional):
string
The full name of the test as defined in the test file itself.
-
id(optional):
string
The id of the test suite.
-
passedExpectations(optional):
array passedExpectations
An array of the passed expectations.
-
pendingReason(optional):
string
Reason why test may be pending.
-
status(optional):
string
The status of the test suite.
Nested Schema : items
Type:
Show Source
object-
matcherName(optional):
string
The name of the matcher used.
-
message(optional):
string
Human readable message for the failed expectation.
-
passed(optional):
boolean
flag to denote if this is a pass of failure.
-
stack(optional):
string
The error stack.
Nested Schema : items
Type:
Show Source
object-
matcherName(optional):
string
The name of the matcher used.
-
message(optional):
string
Human readable message for the failed expectation.
-
passed(optional):
boolean
flag to denote if this is a pass of failure.
-
stack(optional):
string
The error stack.
Example Response (application/json)
[
{
"testResults":[
{
"specs":[
{
"pendingReason":"",
"description":"returns status code 200",
"fullName":"Calculate Shipping GET /v1/calculateShipping returns status code 200",
"passedExpectations":[
{
"stack":"",
"matcherName":"toBe",
"passed":true,
"message":"Passed."
}
],
"id":"spec0",
"failedExpectations":[
],
"status":"passed"
},
{
"pendingReason":"",
"description":"returns shippingMethods Array",
"fullName":"Calculate Shipping GET /v1/calculateShipping returns shippingMethods Array",
"passedExpectations":[
{
"stack":"",
"matcherName":"toBe",
"passed":true,
"message":"Passed."
}
],
"id":"spec1",
"failedExpectations":[
],
"status":"passed"
},
{
"pendingReason":"",
"description":"returns shippingMethods Array",
"fullName":"Calculate Shipping GET /v1/calculateShipping returns shippingMethods Array",
"passedExpectations":[
{
"stack":"",
"matcherName":"toBe",
"passed":true,
"message":"Passed."
},
{
"stack":"",
"matcherName":"toBe",
"passed":true,
"message":"Passed."
}
],
"id":"spec2",
"failedExpectations":[
],
"status":"passed"
}
],
"description":"GET /v1/calculateShipping",
"fullName":"Calculate Shipping GET /v1/calculateShipping",
"id":"suite1",
"failedExpectations":[
],
"status":"finished"
},
{
"specs":[
{
"pendingReason":"",
"description":"returns status code 200",
"fullName":"Hello World Server GET /v1 returns status code 200",
"passedExpectations":[
{
"stack":"",
"matcherName":"toBe",
"passed":true,
"message":"Passed."
}
],
"id":"spec3",
"failedExpectations":[
],
"status":"passed"
},
{
"pendingReason":"",
"description":"returns Hello World",
"fullName":"Hello World Server GET /v1 returns Hello World",
"passedExpectations":[
{
"stack":"",
"matcherName":"toBe",
"passed":true,
"message":"Passed."
}
],
"id":"spec4",
"failedExpectations":[
],
"status":"passed"
}
],
"description":"GET /v1",
"fullName":"Hello World Server GET /v1",
"id":"suite2",
"failedExpectations":[
],
"status":"finished"
}
],
"extensionName":"externalShippingCalculator",
"jobId":"201612191709",
"status":"succeeded"
}
]Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code