Jump to

• Request
• Response

getTestStatus

get

/ccadmin/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(required): string
  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

• environmentType: string
  It specifies the environment where operation needs to be performed. Default value is live. (value: preview or live)
• extensionName(required): string
  The name of the extension that the test job was executed against.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getTestStatus_response

Type: object

Show Source

• completed: boolean
  Flag indicating whether or not the job has completed or not.
• completedPercentage: integer
  The progress of the job represented as a percentage.
• endTime: string
  The time that the job completed.
• intervalToPoll: integer
  The number of milliseconds to wait before polling the status of the job again.
• links: array links
  An array of test status links.
• message: string
  Human readable message about the current processing status.
• progress: string
  The current progress of the job.
• requestStatus: integer
  The status of the request the requested the job execution.
• startTime: string
  The time that the job was started.

{
    "properties":{
        "completedPercentage":{
            "description":"The progress of the job represented as a percentage.",
            "type":"integer"
        },
        "intervalToPoll":{
            "description":"The number of milliseconds to wait before polling the status of the job again.",
            "type":"integer"
        },
        "progress":{
            "description":"The current progress of the job.",
            "type":"string"
        },
        "startTime":{
            "description":"The time that the job was started.",
            "type":"string"
        },
        "links":{
            "description":"An array of test status links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The relationship the link has to the resource.",
                        "type":"string"
                    },
                    "href":{
                        "description":"Link to the resource.",
                        "type":"string"
                    }
                }
            }
        },
        "completed":{
            "description":"Flag indicating whether or not the job has completed or not.",
            "type":"boolean"
        },
        "endTime":{
            "description":"The time that the job completed.",
            "type":"string"
        },
        "message":{
            "description":"Human readable message about the current processing status.",
            "type":"string"
        },
        "requestStatus":{
            "description":"The status of the request the requested the job execution. ",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

An array of test status links.

Show Source

• Array of: object items

{
    "description":"An array of test status links.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"The relationship the link has to the resource.",
                "type":"string"
            },
            "href":{
                "description":"Link to the resource.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href: string
  Link to the resource.
• rel: string
  The relationship the link has to the resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The relationship the link has to the resource.",
            "type":"string"
        },
        "href":{
            "description":"Link to the resource.",
            "type":"string"
        }
    }
}

Example Response (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

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top