Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getLintJobResults_response

Type: object

Show Source

• 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.

{
    "properties":{
        "extensionName":{
            "description":"The name of the extension that the lint job is to be executed for.",
            "type":"string"
        },
        "jobId":{
            "description":"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.",
            "type":"string"
        },
        "jsHintResults":{
            "description":"An array of JS Hint errors.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "filename":{
                        "description":"The filename that contains the lint error.",
                        "type":"string"
                    },
                    "totalErrors":{
                        "description":"The total number of errors found in the JavaScript file.",
                        "type":"integer"
                    },
                    "errors":{
                        "description":"An array of JS Hint errors.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "reason":{
                                    "description":"Human readable error message.",
                                    "type":"string"
                                },
                                "character":{
                                    "description":"The character of the line in the JavaScript file where the error begins.",
                                    "type":"integer"
                                },
                                "code":{
                                    "description":"The standard lint error code.",
                                    "type":"string"
                                },
                                "line":{
                                    "description":"The line of the JavaScript file where the error was found.",
                                    "type":"integer"
                                }
                            }
                        }
                    }
                }
            }
        },
        "status":{
            "description":"The status of the job that the results belong to.",
            "type":"string"
        }
    }
}

Nested Schema : jsHintResults

Type: array

An array of JS Hint errors.

Show Source

• Array of: object items

{
    "description":"An array of JS Hint errors.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "filename":{
                "description":"The filename that contains the lint error.",
                "type":"string"
            },
            "totalErrors":{
                "description":"The total number of errors found in the JavaScript file.",
                "type":"integer"
            },
            "errors":{
                "description":"An array of JS Hint errors.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "reason":{
                            "description":"Human readable error message.",
                            "type":"string"
                        },
                        "character":{
                            "description":"The character of the line in the JavaScript file where the error begins.",
                            "type":"integer"
                        },
                        "code":{
                            "description":"The standard lint error code.",
                            "type":"string"
                        },
                        "line":{
                            "description":"The line of the JavaScript file where the error was found.",
                            "type":"integer"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "filename":{
            "description":"The filename that contains the lint error.",
            "type":"string"
        },
        "totalErrors":{
            "description":"The total number of errors found in the JavaScript file.",
            "type":"integer"
        },
        "errors":{
            "description":"An array of JS Hint errors.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "reason":{
                        "description":"Human readable error message.",
                        "type":"string"
                    },
                    "character":{
                        "description":"The character of the line in the JavaScript file where the error begins.",
                        "type":"integer"
                    },
                    "code":{
                        "description":"The standard lint error code.",
                        "type":"string"
                    },
                    "line":{
                        "description":"The line of the JavaScript file where the error was found.",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : errors

Type: array

An array of JS Hint errors.

Show Source

• Array of: object items

{
    "description":"An array of JS Hint errors.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "reason":{
                "description":"Human readable error message.",
                "type":"string"
            },
            "character":{
                "description":"The character of the line in the JavaScript file where the error begins.",
                "type":"integer"
            },
            "code":{
                "description":"The standard lint error code.",
                "type":"string"
            },
            "line":{
                "description":"The line of the JavaScript file where the error was found.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "reason":{
            "description":"Human readable error message.",
            "type":"string"
        },
        "character":{
            "description":"The character of the line in the JavaScript file where the error begins.",
            "type":"integer"
        },
        "code":{
            "description":"The standard lint error code.",
            "type":"string"
        },
        "line":{
            "description":"The line of the JavaScript file where the error was found.",
            "type":"integer"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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(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

{
    "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