Get the status of a query job using the query job identifier for the task.
When you create a query job, the response includes a task result URL of the form: /queryjobs/{queryjob-id}.
643 matches
22 actions
LGTM API specification
22 actions
- Add a project to LGTMPOSTv1.0.0
- API specificationGETv1.0.0
- Delete project by numeric identifierDELETEv1.0.0
- Fetch the results of a query job for a specific projectGETv1.0.0
- Get analysis summaryGETv1.0.0
- Get analysis summary for a specific commitGETv1.0.0
- Get configuration for a project identified by numeric identifierGETv1.0.0
- Get detailed alert informationGETv1.0.0
- Get detailed alert information for an issueGETv1.0.0
- Get operation statusGETv1.0.0
- Get project by numeric identifierGETv1.0.0
- Get project by URL identifierGETv1.0.0
- Get results of code reviewGETv1.0.0
- Get the computed values of the specified metricGETv1.0.0
- Get the identifiers and descriptions of the usage metricsGETv1.0.0
- Get the status of a query jobGETv1.0.0
- List projectsGETv1.0.0
- Provide a summary of results for the projects in the query jobGETv1.0.0
- Run a CodeQL query on one or more projectsPOSTv1.0.0
- Run analysis of a specific commitPOSTv1.0.0
- Run code review for a patchPOSTv1.0.0
- Set the administrator configuration for a project identified by numeric identifierPUTv1.0.0
Other/LGTM API specification
Get the status of a query job
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"queryjob-id": {
"type": "string"
}
},
"required": [
"queryjob-id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier for the QueryJob."
},
"result-url": {
"type": "string",
"description": "URL to view the result of the query job."
},
"stats": {
"type": "object",
"properties": {
"failed": {
"type": "integer",
"format": "int32",
"description": "The number of projects for which the query failed."
},
"pending": {
"type": "integer",
"format": "int32",
"description": "The number of projects scheduled for execution but pending. For very large jobs, not all projects are scheduled at the same time. Therefore, this number might increase as more projects are scheduled. This means that `successful + failed + pending` might be smaller than the total number of project that will be analyzed.\n"
},
"success-with-result": {
"type": "integer",
"format": "int32",
"description": "The number of projects for which the query returned results."
},
"success-without-result": {
"type": "integer",
"format": "int32",
"description": "The number of projects for which the query was successful but returned no results."
},
"successful": {
"type": "integer",
"format": "int32",
"description": "The number of projects for which the query completed succesfully. These are broken down further between the ones that have results (`success-with-result`) and the ones that do not (`success-without-result`): `successful = success-with-result + success-without-result`.\n"
}
}
}
}
}