Class MigrationOfConnectModulesToForgeService

This resource supports the migration of some Connect modules to their equivalent Forge modules.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-migration-of-connect-modules-to-forge

Hierarchy

CommonHttpService
- MigrationOfConnectModulesToForgeService

Index

Constructors

Methods

connectToForgeMigrationFetchTaskResourceFetchMigrationTaskGet initialize

Constructors

constructor

new MigrationOfConnectModulesToForgeService(getClientInstance): MigrationOfConnectModulesToForgeService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns MigrationOfConnectModulesToForgeService
Inherited from CommonHttpService.constructor

Methods

connectToForgeMigrationFetchTaskResourceFetchMigrationTaskGet

connectToForgeMigrationFetchTaskResourceFetchMigrationTaskGet(params): Promise<TaskProgress>
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
- params: {
  connectKey: string;
  jiraIssueFieldsKey: string;
  }
  - connectKey: string
    The key of the Connect app that contains the Jira issue field being migrated.
    Example
    com.example.app
  - jiraIssueFieldsKey: string
    The module key of the Connect issue field being migrated.
    Example
    my-custom-field
Returns Promise<TaskProgress>
Returned if the request is successful and a migration task is found.

Path
GET /rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task @scopes-current read:jira-work

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-migration-of-connect-modules-to-forge#api-rest-atlassian-connect-1-migration-connectkey-jiraissuefieldskey-task-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize