Oracle Commerce Cloud October 2017

getTestJobResults

get

/ccadminx/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: Type: string

Required: true

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: Type: string

Required: true

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.

Body

Root Schema : getTestJobResults_response

Properties

extensionName: Type: string

The name of the extension that the lint job is to be executed for.
jobId: Type: 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: Type: string

The status of the job that the results belong to.
testResults: Type: array testResults

An array of test results.

Nested Schema : testResults

Type: array

An array of test results.

Items

Type: object items

Nested Schema : items

Type: object

Properties

description: Type: string

The test description as defined in the test file itself.
failedExpectations: Type: array failedExpectations

An array of the failed expectations.
fullName: Type: string

The full name of the test as defined in the test file itself.
id: Type: string

The id of the test suite.
specs: Type: array specs

An array of test spec result details.
status: Type: string

The status of the test suite.

Nested Schema : failedExpectations

Type: array

An array of the failed expectations.

Items

Type: object items

Nested Schema : specs

Type: array

An array of test spec result details.

Items

Type: object items

Nested Schema : items

Type: object

Properties

matcherName: Type: string

The name of the matcher used.
message: Type: string

Human readable message for the failed expectation.
passed: Type: boolean

flag to denote if this is a pass of failure.
stack: Type: string

The error stack.

Nested Schema : items

Type: object

Properties

description: Type: string

The test description as defined in the test file itself.
failedExpectations: Type: array failedExpectations

An array of the failed expectations.
fullName: Type: string

The full name of the test as defined in the test file itself.
id: Type: string

The id of the test suite.
passedExpectations: Type: array passedExpectations

An array of the passed expectations.
pendingReason: Type: string

Reason why test may be pending.
status: Type: string

The status of the test suite.

Nested Schema : failedExpectations

Type: array

An array of the failed expectations.

Items

Type: object items

Nested Schema : passedExpectations

Type: array

An array of the passed expectations.

Items

Type: object items

Nested Schema : items

Type: object

Properties

matcherName: Type: string

The name of the matcher used.
message: Type: string

Human readable message for the failed expectation.
passed: Type: boolean

flag to denote if this is a pass of failure.
stack: Type: string

The error stack.

Nested Schema : items

Type: object

Properties

matcherName: Type: string

The name of the matcher used.
message: Type: string

Human readable message for the failed expectation.
passed: Type: boolean

flag to denote if this is a pass of failure.
stack: Type: string

The error stack.

Example 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

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

[{
  "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"
}]