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.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

read:jira-work

Connect app scope required: NONE

Request

Path parameters

connectKey

string

Required

jiraIssueFieldsKey

string

Required

Responses

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

application/json

TaskProgress

Details about a task.

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

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";

const response = await requestJira(`/rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "description": "<string>",
  "elapsedRuntime": 48,
  "finished": "<string>",
  "id": "<string>",
  "lastUpdate": "<string>",
  "message": "<string>",
  "progress": 51,
  "self": "<string>",
  "started": "<string>",
  "status": "ENQUEUED",
  "submitted": "<string>",
  "submittedBy": 42
}