GET /rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/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.

Servers

Path parameters

Name Type Required Description
jiraIssueFieldsKey String Yes

The module key of the Connect issue field being migrated.

connectKey String Yes

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.