getLintJobResults
get
/ccadminx/custom/v1/lintJobs/{id}
Get Lint Job Results. Returns the status of a given lint 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 lint job is to be executed for.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getLintJobResults_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.
-
jsHintResults(optional):
array jsHintResults
An array of JS Hint errors.
-
status(optional):
string
The status of the job that the results belong to.
Nested Schema : items
Type:
Show Source
object
-
errors(optional):
array errors
An array of JS Hint errors.
-
filename(optional):
string
The filename that contains the lint error.
-
totalErrors(optional):
integer
The total number of errors found in the JavaScript file.
Nested Schema : items
Type:
Show Source
object
-
character(optional):
integer
The character of the line in the JavaScript file where the error begins.
-
code(optional):
string
The standard lint error code.
-
line(optional):
integer
The line of the JavaScript file where the error was found.
-
reason(optional):
string
Human readable error message.
Example Response (application/json)
[
{
"extensionName":"externalShippingCalculator",
"jobId":"201612201113",
"jsHintResults":[
{
"filename":"extensions\\extracted\\externalShippingCalculator\\js\\calculate-shipping-app.js",
"totalErrors":1,
"errors":[
{
"reason":"Missing \"use strict\" statement.",
"character":3,
"code":"E007",
"line":8
}
]
},
{
"filename":"extensions\\extracted\\externalShippingCalculator\\tests\\calculate-shipping-test.js",
"totalErrors":2,
"errors":[
{
"reason":"'fs' is defined but never used.",
"character":5,
"code":"W098",
"line":3
},
{
"reason":"'path' is defined but never used.",
"character":5,
"code":"W098",
"line":4
}
]
},
{
"filename":"extensions\\extracted\\externalShippingCalculator\\js\\lib\\calculate-shipping-demo.js",
"totalErrors":1,
"errors":[
{
"reason":"Strings must use singlequote.",
"character":35,
"code":"W109",
"line":4
}
]
}
],
"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:
array
An 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