Integrity Check for Jira version 1.4

http://yourjira.com/jira/rest/integrity-check/api/1.4/

/integrity

Run Integrity Check.

post

post

Start an Integrity Check operation. The scope of the operation can be either 'system', 'project' or 'snapshot scope'. Include all filters/boards/dashboards by setting the corresponding parameters to 'true'. Please refer to the examples for details!

Start an Integrity Check operation. The scope of the operation can be either 'system', 'project' or 'snapshot scope'. Include all filters/boards/dashboards by setting the corresponding parameters to 'true'. Please refer to the examples for details!

Body

Media type: application/json

Type: any

Example:

{
  "scope" : "system"
}

or

{
  "scope" : "system",
  "includeAllFilters" : true,
  "includeAllBoards" : true,
  "includeAllDashboards" : true
}

or

{
  "scope": "project",
  "projectKey": "PRJA",
  "includeProjectBoards": false,
  "includeProjectFilters": true
}

HTTP status code 201

Contains the operation Id.

Headers

  • Location: required(string)

    The URI pointing to the started Integrity Check operation. The operation id can be used for getting operation progress, downloading result as csv, or canceling the operation.

Body

Media type: application/json

Type: any

Example:

{
 "id":2
}

HTTP status code 400

The value 'prettywrongscope' is not a valid enumerator of 'SnapshotType'.

/integrity/{id}

Get the progress or end result of the Integrity check operation with the given id.

get

get

Get the progress or end result of the Integrity check operation with the given id.

Get the progress or end result of the Integrity check operation with the given id.

URI Parameters

  • id: required(integer)

    The id of the operation.

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"id":8,"message":"Integrity Check in progress. Checking Filters: 56 of 492.","progressMessages":[...],"progressDouble":0.4227642276422765,"status":"Running"}

or

{"id":14,"integrityModel":{"maxSeverity":"Warning","containsUnknownErrors":false,"objectCount":227,"hasValidLicense":false,"quickfixablePathsCount":0},"message":"Integrity check succeeded","progressDouble":1.0,"status":"Succeeded"}

or

{integrityModel={objectCount=914, hasValidLicense=false, violations=[{severity=Warning, solution=Modify the objects to point to an existing project or remove the reference to the missing project., paths=[{elements=[{name=Engineering Stories Sprint 16 (mwoodbu), id=null, type=Filter, url=http://localhost:2990/jira/issues/?filter=10001}, {name=project = ABGF AND issuetype = Story...

HTTP status code 400

Request is invalid.

HTTP status code 404

No Integrity check operation with the given id.

/integrity/{id}/csv

Get a csv file with the end result of the Integrity check operation with the given id.

get

get

Get a csv file with the end result of the Integrity check operation with the given id.

Get a csv file with the end result of the Integrity check operation with the given id.

URI Parameters

  • id: required(integer)

    The id of the operation.

HTTP status code 200

Body

Media type: text/csv

Type: any

HTTP status code 400

Request is invalid.

HTTP status code 404

No Integrity check operation with the given id.

/integrity/{id}/cancel

Cancel a running Integrity Check operation.

put

put

Cancel a running Integrity Check operation.

Cancel a running Integrity Check operation.

URI Parameters

  • id: required(string)

HTTP status code 200

Cancellation request received.

HTTP status code 400

An error occurred while canceling the Integrity Check operation.

HTTP status code 404

Integrity Check operation with id '13' does not exist.

/integrity/scoped

Snapshot scope.

post

post

Start an Integrity Check operation on the last unsuccessful snapshot. After successfully completing the operation, use "/integrity/{id}" to get the result.

Start an Integrity Check operation on the last unsuccessful snapshot. After successfully completing the operation, use "/integrity/{id}" to get the result.

HTTP status code 201

Headers

  • Location: required(string)

    Contains the operation Id.

HTTP status code 500

Could not retrieve snapshot metadata, i.e. unsuccessful snapshot resource is missing.