Restore checklist data

Owned by Mariya Solovey, created
Last updated: May 13, 2024 by Oleksandr Haiun
2 min read

Starting from v6.8.4, you can restore checklist data in cleared checklists from Jira history. This can be useful in cases when the checklist data has been cleared from an issue by mistake.

☝🏼NOTE: Running this migration will restore checklist data for all issues for the period you selected where the checklist is empty no matter if it is done by mistake or you cleared checklist data on purpose.

We have introduced a new type of migration to make restoring deleted checklist data possible. Simply run the migration with migrationType - RESTORE_FROM_HISTORY.

Body parameters (application/json) - list of JSON objects:

  • migrationOption: string

    • value: ADD_IF_EMPTY

  • migrationType: string

    • value: RESTORE_FROM_HISTORY

  • START_DATE: date

  • END_DATE: date

  • dryRun: boolean

    • value: true - no changes will be made. Use it to see and confirm the list of issue IDs where the checklist data needs to be restored

    • value: false - apply changes to the list of issues from dryRun mode

Example

 

[ {"migrationOption": "ADD_IF_EMPTY", "migrationType": "RESTORE_FROM_HISTORY", "parameters":{"START_DATE": "2024-05-01T14:26:00", "END_DATE":"2024-05-03T14:26:00"}, "dryRun": true} ]

 

Responses

  • STATUS 200 Returns a list of all checklists associated with the same issue in JSON format

  • STATUS 400 Returns if the request body is invalid

Detailed description

Please find more detailed steps to follow:

  1. Use endpoint /rest/railsware/1.0/migration with the POST method to start the migration.

  2. Set desired values for START_DATE and END_DATE to restore the checklist data only for required issues.

  3. Start by running the migration in DRY RUN mode ("dryRun": true in body request). This way you’ll see and confirm the list of issue IDs where checklist data needs to be restored before proceeding with the actual migration.

     

    image-20240510-083534.png

  4. Find the results in the logs using the link /plugins/servlet/railsware/migrationlog.

  5. Verify that the list of issue IDs in Updated issues: matches expectations.

     

    image-20240508-200424.png

  6. Rerun the migration without the “dryRun” parameter to apply the changes.

  7. Check migration status using the following endpoint rest/railsware/1.0/migration?migrationType=RESTORE_FROM_HISTORY with the GET method.

    1. In response, you will see the status of the migration, the number of projects affected, and how many issues are migrated/ not migrated.

       

  8. You can now open the issues with the checklist data restored.

     

☝🏼NOTE: No new event in History or Smart Checklist History tabs for restoring checklist data is expected.