Migration API status examples

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "WARNING",
        "message": "All Preflight checks have passed with warning.",
    },
    "links": {}
}

Get status of a task and its children

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?expandChildren=true

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "WARNING",
        "message": "All Preflight checks have passed with warning.",
        "children": {
            "AdvancedRoadmapsOutdated": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AdvancedRoadmapsProjectMigratedConflict": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppAssessmentIncomplete": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppDataMigrationConsent": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppLicenseCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppsNotInstalledOnCloud": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppsReliabilityCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppVendorCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppWebhookEndpointCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "CloudFreeUserLimit": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "CloudSiteNotEmpty": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "CrossProjectEntityMissingProjectSelection": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "DatabaseSize": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "EpicLinksAboveStoryHierarchyLevel": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmCloudEntityCreationLimits": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmCloudFreeAgentLimit": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmInCloudSite": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmLicence": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "ManualImportFileValidation": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "MissingAttachments": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "MissingIssueTypes": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            }
        }
    },
    "links": {
        "next": "cm9vdCNmaW5pc2hlZCNza2lwcGVkI21pc3Npbmdpc3N1ZXR5cGVz",
        "self": "cm9vdCNmaW5pc2hlZCNza2lwcGVkI2FkdmFuY2Vkcm9hZG1hcHNvdXRkYXRlZA=="
    }
}

Get status of a task and one child

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=AdvancedRoadmapsOutdated

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "SKIPPED"
    },
    "links": {}
}

Note that pre-flight check tasks, as opposed to migration tasks, don't have levels. Trying to query the API about a pre-flight check task with a level parameter will return an empty result. See this example:

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=check

1
2
{
    "data": {},
    "links": {}
}

Get status of migrate task

Get overall migration status

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status

1
2
{
    "data": {
        "status": "IN_PROGRESS",
        "message": "Migration is in progress",
        "details": {
            "createdAt": 1708680664150,
            "lastUpdatedAt": 1708680665175,
            "startedAt": 1708680665175
        },
        "progressDetails": {
            "isSupported": false
        }
    },
    "links": {}
}

Get immediate children of a migration task

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?expandChildren=true

1
2
{
    "data": {
        "status": "IN_PROGRESS",
        "message": "Migration is in progress",
        "details": {
            "createdAt": 1708680664150,
            "lastUpdatedAt": 1708680665175,
            "startedAt": 1708680665175
        },
        "progressDetails": {
            "isSupported": false
        }
        "children": {
            "check": {
                "status": "FINISHED",
                "outcome": "WARNING",
                "message": "All Preflight checks have passed with warning."
            },
            "migrate": {
                "status": "IN_PROGRESS",
                "details": {
                    "createdAt": 1708680664150,
                    "lastUpdatedAt": 1708680665175,
                    "startedAt": 1708680665175
                },
                "progressDetails": {
                    "isSupported": false
                }
            }
        }
    },
    "links": {
        "self": "cm9vdCNmaW5pc2hlZCN3YXJuaW5nI2NoZWNr"
    }
}

Get all children of a task and drill down

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=check

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "WARNING",
        "message": "All Preflight checks have passed with warning."
    },
    "links": {}
}

Get all children of a task with `level=check`

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=check&expandChildren=true

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "WARNING",
        "message": "All Preflight checks have passed with warning.",
        "children": {
            "AdvancedRoadmapsOutdated": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AdvancedRoadmapsProjectMigratedConflict": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AnonPermission": {
                "status": "FINISHED",
                "outcome": "SKIPPED",
                "message": "No project settings allow public access"
            },
            "AppAssessmentIncomplete": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppDataMigrationConsent": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppLicenseCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppsNotInstalledOnCloud": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppsReliabilityCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppVendorCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "AppWebhookEndpointCheck": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "CloudFreeUserLimit": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "CloudSiteNotEmpty": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "CrossProjectEntityMissingProjectSelection": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "DatabaseSize": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "EpicLinksAboveStoryHierarchyLevel": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmCloudEntityCreationLimits": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmCloudFreeAgentLimit": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmInCloudSite": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "JsmLicence": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "ManualImportFileValidation": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            },
            "MissingAttachments": {
                "status": "FINISHED",
                "outcome": "SKIPPED"
            }
        }
    },
    "links": {
        "next": "cm9vdDpjaGVjayNmaW5pc2hlZCNza2lwcGVkI21pc3NpbmdhdHRhY2htZW50cw==",
        "self": "cm9vdDpjaGVjayNmaW5pc2hlZCNza2lwcGVkI2FkdmFuY2Vkcm9hZG1hcHNvdXRkYXRlZA=="
    }
}

Get one child of a task with `level=check`

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=check,AdvancedRoadmapsOutdated

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "SKIPPED"
    },
    "links": {}
}

Get overall migration status

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=migrate

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "SUCCESS",
        "details": {
            "createdAt": 1708680664150,
            "lastUpdatedAt": 1708680841379,
            "startedAt": 1708680665175
        }
    },
    "links": {}
}

Get all children of a task with `level=migrate`

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=migrate&expandChildren=true

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "SUCCESS",
        "details": {
            "createdAt": 1708680664150,
            "lastUpdatedAt": 1708680841379,
            "startedAt": 1708680665175
        },
        "children": {
            "customers": {
                "status": "FINISHED",
                "outcome": "SUCCESS"
            },
            "usersAndGroups": {
                "status": "FINISHED",
                "outcome": "SUCCESS"
            }
        }
    },
    "links": {
        "self": "cm9vdDptaWdyYXRlI2ZpbmlzaGVkI3N1Y2Nlc3MjY3VzdG9tZXJz"
    }
}

Get migration status of a project or space

To get the status of all projects or spaces being migrated, set level to migrate,projects and expandChildren to true. Otherwise you'll get an empty reply.

migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=migrate,projects&expandChildren=true

1
2
{
    "data": {
        "children": {
            "SC": {
                "status": "FINISHED",
                "outcome": "SUCCESS",
                "details": {
                    "createdAt": 1708680664378,
                    "lastUpdatedAt": 1708680826929,
                    "startedAt": 1708680702393
                }
            }
        }
    },
    "links": {
        "self": "cm9vdDptaWdyYXRlOnByb2plY3RzI2ZpbmlzaGVkI3N1Y2Nlc3Mjc2M="
    }
}

To get the status of a specific project by its key, your query should look like the following one, in which SC is your project key.

/migrations/public/v1/jobs/{jobId}/tasks/{taskId}/status?level=migrate,projects,SC

1
2
{
    "data": {
        "status": "FINISHED",
        "outcome": "SUCCESS",
        "details": {
            "createdAt": 1708680664378,
            "lastUpdatedAt": 1708680826929,
            "startedAt": 1708680702393
        }
    },
    "links": {}
}