QA Report
Last Updated: August 8th, 2024
Problem Statement
Cutover workspaces can be populated with many different types of runbooks, for example a popular runbook type is Recovery Plans. Many of our clients have specific policies and standards which recovery plans should follow, in order to review all the recovery plans which could run into the 1000's, a QA report using the Cutover API can be created.
Solution
The Cutover API is a great way to extract runbook data to build a QA report. The runbook data returned from the API can be used to assess if remediation steps need to occur on your runbooks.This ensures that your runbook templates are up to date and continuously meet your standards.
Key Benefits
- Removes any inconsistencies or errors
- Provides a healthy audit trail
- Improves current work processes and provides efficiency
Recipe
The recipe outlines how to use the Cutover API to build a QA Report. Steps may vary depending on what you would like to report on. Let’s get started:
1. Execute the List Workspaces API to retrieve the ID of the workspace where the runbooks you are looking to extract are located.
2. If the runbooks are located in folders, use the workspace ID from step 1, and execute the List Folders API to find the ID of the folder.
3. To GET a list of all the runbook IDs, execute the List Runbooks API. The API response can be filtered down by runbooks located in a particular workspace or folder using the IDs retrieved from step 1 and step 2. This requires the folder ID and the runbook ID to be added to the query string parameters.
4. For each runbook ID returned in step 3, execute the List Tasks in a Runbook API. Each task will contain all of its key attributes, some of the values will contain IDs to other data objects, to retrieve the names run the following API calls.
5. Run the List Task Types.
6. Run the List Runbook Teams in a Runbook using the runbook ID in step 4.
7. Run the List Streams in a Runbook using the runbook ID in step 4.
8. You can look up the names of the data objects in steps 5, 6 and 7 for each task extracted in step 4.
Available endpoints
This endpoint retrieves runbook level information. You can use parameters to return all runbooks associated with a workspace, folder or even the stage the runbooks are at.
