Start here

Home
About Klocwork
What's new
Fixed issues
Release notes
Installation

Reference

C/C++ checkers
Java checkers
C# checkers
MISRA C 2004 checkers
MISRA C++ 2008 checkers
MISRA C 2012 checkers
MISRA C 2012 checkers with Amendment 1
Commands
Metrics
Troubleshooting
Reference

Product components

C/C++ Integration build analysis
Java Integration build analysis
Desktop analysis
Refactoring
Klocwork Static Code Analysis
Klocwork Code Review
Structure101
Tuning
Custom checkers

Coding environments

Visual Studio
Eclipse for C/C++
Eclipse for Java
IntelliJ IDEA
Other

Administration

Project configuration
Build configuration
Administration
Analysis performance
Server performance
Security/permissions
Licensing
Klocwork Static Code Analysis Web API
Klocwork Code Review Web API

Community

View help online
Visit RogueWave.com
Klocwork Support
Rogue Wave Videos

Legal

Legal information

Understanding the API response

The result of any request is a (possibly zero-sized) set of JSON records.

The search action response is formatted as one detected issue per line. The reason for formatting them in this way is to support streaming, so that you can read records one at a time rather than having to wait for the whole result set to de-serialize. Note that the search action response does not include line numbers for detected issues.

The report action response is formatted as a JSON object containing, in this order:

  • a list of rows
  • a list of columns
  • a matrix of data, the dimensions of which are bounded by the number of rows and columns

Each row and column item consists of a pair of 'id' and 'name' fields. The 'name' is for display, while the 'id' allows for drilldown.

Note: If you are using an action which generates a time stamp, the encoding of the date is a form of POSIX/UTC time in milliseconds. If you want to convert it to a human readable date, use a python 'time.ctime' function like this:
human_readable_date = time.ctime(attrs["date"] / 1000)