On this page:
|
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:
Code Block |
---|
http://yourjira.com/jira/rest/integrity-check/api/1.4/integrity |
Step-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. For details, please refer to the documentation
...
of the latest REST API version 1.4.
Note |
---|
On Windows, single quotes around JSON code might not work. Try escaping them like so: |
Request
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Expand | ||
---|---|---|
| ||
|
...
The response contains the id of the started Integrity Check operation.
Note that on Windows single quotes around json might not work! Try escaping them like "{\"scope\":\"system\"...
Tracking progress
...
Responses
Expand | ||
---|---|---|
| ||
STATUS 201 - application/json - Returns the id of the operation.
Example:
STATUS 400 - The value 'exampleValue' is not a valid enumerator of 'SnapshotType'. |
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
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Expand | ||
---|---|---|
| ||
|
...
For running operations, the response contains the progress of the operation, which is between 0 and 1, and the operation status.
...
Responses
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
STATUS 200 - application/json - Returns the status of the progress of the operation. Example:
or
or
STATUS 400 - Request is invalid. STATUS 404 - No Integrity check operation with the given id. |
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.
Tip |
---|
The .csv file will be empty if no integrity violations are detected. |
Request
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Expand | ||
---|---|---|
| ||
|
...
Responses
Expand | ||
---|---|---|
| ||
STATUS 200 - text/csv - Returns a .csv file |
...
. STATUS 400 - Request is invalid. STATUS 404 - No Integrity check operation with the given id. |
Cancel a running integrity check
...
PUT /integrity/{id}/cancel
Cancel a running Integrity Check operation.
Request
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Expand | ||
---|---|---|
| ||
|
Responses
Expand | ||
---|---|---|
| ||
STATUS 200 - Cancellation request received. STATUS 400 - An error occurred while canceling the Integrity Check operation. STATUS 404 - No Integrity check operation with the given id. |
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
Expand | ||
---|---|---|
| ||
STATUS 200 - Operation successfully completed. Headers
STATUS 500 - Could not retrieve snapshot metadata, i.e. unsuccessful snapshot is missing. |