This example shows you how to retrieve reference data from Cutover so you can replace IDs returned by the API with meaningful names in your exported data.
When you retrieve runbooks and tasks, some values are returned as IDs. You can retrieve the corresponding reference data and use it to make your exported data easier to understand.
1. Retrieve task types
Make an authenticated call to the List Task Types endpoint:
GET /core/task_types
Use the returned IDs to match task type IDs in your task data with their names.
2. Retrieve custom fields
Retrieve your custom field definitions:
GET /core/custom_fields
You can use these definitions to identify the custom fields referenced by your runbook and task data.
3. Retrieve users
Retrieve user reference data:
GET /core/users
You can use the returned user IDs to identify users referenced in your exported data.
4. Resolve the references
Use the returned IDs and names to replace references in your runbook and task data.
For example, instead of storing:
task_type_id: 123
you can store:
task_type: Manual Task
Tip: Retrieve these reference endpoints once per export cycle and cache the results rather than retrieving them for every runbook. This reduces the number of API calls your application needs to make.
