Function: fetchMigrationTask()

function fetchMigrationTask(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  description?: string;
  elapsedRuntime: number;
  finished?: Date;
  id: string;
  lastUpdate: Date;
  message?: string;
  progress: number;
  result?: unknown;
  self: string;
  started?: Date;
  status:   | string & object
     | "ENQUEUED"
     | "RUNNING"
     | "COMPLETE"
     | "FAILED"
     | "CANCEL_REQUESTED"
     | "CANCELLED"
     | "DEAD";
  submitted?: Date;
  submittedBy: number;
}>;

Defined in: src/cloud/api/migrationOfConnectModulesToForge.ts:22

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ connectKey: string; jiraIssueFieldsKey: string; }	-
parameters.connectKey	string	The key of the Connect app that contains the Jira issue field being migrated.
parameters.jiraIssueFieldsKey?	string	The module key of the Connect issue field being migrated.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: Date; id: string; lastUpdate: Date; message?: string; progress: number; result?: unknown; self: string; started?: Date; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted?: Date; submittedBy: number; }>