REST API: Integrity Check
- Rosen Marinkov
- Stanley Neychev
- Comala Publishing
For details and examples, take a look at the REST API reference:
Documentation for Integrity Check REST API 1.4 - available with CMJ 6.6.6 or later.
URI structure
Integrity Check for Jira’s REST API provides means to run integrity checks, track their progress, and get the results as json/csv. URIs for Integrity Check's REST API resource have the following structure:
http://yourjira.com/jira/rest/integrity-check/api/1.4/integrityStep-by-step guide for using the API
Run an integrity check
POST /integrity
Use this request to run an integrity check of your Jira configuration.
On Windows, single quotes around JSON code might not work. Try escaping them like so:
“{\"scope\":\"system\"...
Request
Responses
Track progress
GET /integrity/{id}
Get the progress or end result of the Integrity Check operation with the given id.
For running operations, the response contains the progress of the operation, which is between 0 and 1, and the operation status.
For completed operations, the response contains an integrityModel property, which includes any integrity violations.
Request
Responses
Download the results as .csv
GET /integrity/{id}/csv
Get a .csv file with the end result of the Integrity Check operation with the given id.
The .csv file will be empty if no integrity violations are detected.
Request
Responses
Cancel a running integrity check
PUT /integrity/{id}/cancel
Cancel a running Integrity Check operation.
Request
Responses
Snapshot scope
POST /integrity/scoped
Start an Integrity Check operation on the last unsuccessful snapshot. After successfully completing the operation, use "/integrity/{id}" to get the result.
Responses