Migration of Connect modules to Forge

Submit Connect issue field migration task

Changed on

Submits a request to trigger migration of connect issue field to its Forge custom field counterpart.

When migrating a Connect app to Forge, Issue Field modules must be converted to Custom field modules. This endpoint triggers the background migration of field data. Use the GET endpoint to retrieve the status and progress of the task.

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

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

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

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token)

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.

Query parameters

retriggerCompletedMigrationboolean

Whether to retrigger the migration if it has already completed.

Response

Returned if the migration task was submitted successfully.

Changes