Sign in
Migration of Connect modules to Forge

Get Connect issue field migration task

Returns the details of a Connect issue field's migration to Forge.

When migrating a Connect app to Forge, Issue Field modules must be converted to Custom field. When the Forge version of the app is installed, Forge creates a background task to track the migration of field data across. This endpoint returns the status and other details of that background task.

For more details, see Jira modules > Jira Custom Fields.

Permissions required: Only Connect and Forge apps can make this request.

get/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task

Path parameters

connectKeystring required

The key of the Connect app that contains the Jira issue field being migrated.

jiraIssueFieldsKeystring required

The module key of the Connect issue field being migrated.

Response

Returned if the request is successful and a migration task is found.

descriptionstring

The description of the task.

elapsedRuntimeinteger required

The execution time of the task, in milliseconds.

finishedstring date-time

A timestamp recording when the task was finished.

idstring required

The ID of the task.

lastUpdatestring date-time required

A timestamp recording when the task progress was last updated.

messagestring

Information about the progress of the task.

progressinteger required

The progress of the task, as a percentage complete.

{"stackTrail":"components:schemas:TaskProgress:properties:result","oasType":"schema","type":"unknown","description":"The result of the task execution."}
selfstring uri required

The URL of the task.

startedstring date-time

A timestamp recording when the task was started.

status'ENQUEUED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'DEAD' required

The status of the task.

submittedstring date-time

A timestamp recording when the task was submitted.

submittedByinteger required

The ID of the user who submitted the task.

Changes

No recorded changes to this endpoint across all 16 revisions of this API.