getLintJobResults
get
/ccadminx/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
-
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 lint job is to be executed for.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getLintJobResults_response
- 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. - jsHintResults
-
Type:
array
jsHintResultsAdditional Properties Allowed:An array of JS Hint errors. - status
-
Type:
string
The status of the job that the results belong to.
Nested Schema : jsHintResults
Nested Schema : items
Type:
object
- errors
-
Type:
array
errorsAdditional Properties Allowed:An array of JS Hint errors. - filename
-
Type:
string
The filename that contains the lint error. - totalErrors
-
Type:
integer
The total number of errors found in the JavaScript file.
Nested Schema : errors
Nested Schema : items
Type:
object
- character
-
Type:
integer
The character of the line in the JavaScript file where the error begins. - code
-
Type:
string
The standard lint error code. - line
-
Type:
integer
The line of the JavaScript file where the error was found. - reason
-
Type:
string
Human readable error message.
Example 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
Body
Root Schema : errorModel
Type:
object
- 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
errorsAdditional Properties Allowed: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
Nested Schema : items
Type:
object
- 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