After triggering an Id Mapping job, you need to monitor its progress and download the generated report. This page covers how to check job status and retrieve your ID mapping file.

Checking Job Status

Use the job status API to monitor the progress of your Id Mapping generation.

API Endpoint

HTTP Method: GET

URL:

1
2
https://api.atlassian.com/migrations/reports/v1/id-mappings/{jobId}

Authentication: API Token or Basic Auth

Content-Type: application/json

Parameters

Field	Type	Required	Description
`jobId`	string	Yes	The job ID returned from the trigger API

Response Scenarios

Success (200 OK)

1
2
{
  "jobId": "<JOB_ID>",
  "status": "SUCCESS"
}

Job Statuses

Status	Description
`PENDING`	Job is queued but not yet started
`IN_PROGRESS`	Job is actively generating the mapping report
`SUCCESS`	Job completed successfully - report is ready
`ERROR`	Report generation failed - retry or contact support

Job Not Found (404 NOT FOUND)

1
2
{
  "status": 404,
  "errorMessage": "Job not found with ID: <JOB_ID>. The job ID may be incorrect or expired.",
  "id": "<REQUEST_ID>"
}

Common causes:

Incorrect job ID
Job has expired (jobs have a limited lifetime)
Job was never created successfully

Server Error (500 INTERNAL SERVER ERROR)

1
2
{
  "status": 500,
  "errorMessage": "Internal Server Error",
  "id": "<REQUEST_ID>"
}

Example Status Check

1
2
curl -X GET \
  https://api.atlassian.com/migrations/reports/v1/id-mappings/your-job-id \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Downloading the Report

Once your job status shows SUCCESS, you can download the Id Mapping report.

API Endpoint

HTTP Method: GET

URL:

1
2
https://api.atlassian.com/migrations/reports/v1/id-mappings/{jobId}/download

Authentication: API Token or Basic Auth

Content-Type: application/json

Parameters

Field	Type	Required	Description
`jobId`	string	Yes	The job ID from the trigger API response

Response Scenarios

Success (200 OK)

1
2
{
  "jobId": "<JOB_ID>",
  "downloadUrl": "<Amazon_S3_Download_URL>",
  "expiresIn": 3600
}

Important notes:

The download URL expires in 1 hour (3600 seconds)
Don't share the presigned URL - anyone with access can download the report
Download the file immediately to avoid expiration

Report Not Available (404 NOT FOUND)

1
2
{
  "status": 404,
  "errorMessage": "Report file not available. The report may have been deleted or expired.",
  "id": "<REQUEST_ID>"
}

What to do: The report has expired or been deleted. Generate a new report using the trigger API.

Server Error (500 INTERNAL SERVER ERROR)

1
2
{
  "status": 500,
  "errorMessage": "Internal Server Error",
  "id": "<REQUEST_ID>"
}

Example Download Request

1
2
curl -X GET \
  https://api.atlassian.com/migrations/reports/v1/id-mappings/your-job-id/download \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Complete Workflow Example

Here's a complete workflow from trigger to download:

1. Trigger the job

1
2
# Trigger Id Mapping job
curl -X POST https://api.atlassian.com/migrations/reports/v1/id-mappings/trigger \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"product":"JIRA","destinationURL":"https://company.atlassian.net","sourceURL":"https://jira.company.com"}'

Response: {"jobId": "abc123", "status": "PENDING"}

2. Check status periodically

1
2
# Check job status (repeat until SUCCESS)
curl -X GET https://api.atlassian.com/migrations/reports/v1/id-mappings/abc123 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Responses:

{"jobId": "abc123", "status": "PENDING"} - Keep waiting
{"jobId": "abc123", "status": "IN_PROGRESS"} - Still processing
{"jobId": "abc123", "status": "SUCCESS"} - Ready to download!

3. Get download link

1
2
# Get download URL
curl -X GET https://api.atlassian.com/migrations/reports/v1/id-mappings/abc123/download \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response:

1
2
{
  "jobId": "abc123",
  "downloadUrl": "https://s3.amazonaws.com/...",
  "expiresIn": 3600
}

4. Download the file

1
2
# Download the actual mapping file
curl -O "https://s3.amazonaws.com/..."

Best Practices

Poll status regularly - Check every 30-60 seconds while job is running
Download immediately - URLs expire in 1 hour
Store securely - Id Mapping files contain sensitive data
Retry on errors - Temporary failures can occur; retry after a short delay
Plan for scale - Large instances may take longer to process

Troubleshooting

Job stuck in PENDING:

Wait a few more minutes - jobs are processed in queue order
High demand periods may cause delays

Job shows ERROR:

Check your source/destination URLs are correct and accessible
Verify you have admin access to both instances
Retry the trigger API call

Download URL expired:

Call the download API again to get a fresh URL
If that fails, regenerate the entire report