Class AppMigrationService

This resource supports app migrations. Use it to:

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration

Hierarchy

  • CommonHttpService
    • AppMigrationService

Constructors

constructor

Methods

appIssueFieldValueUpdateResourceUpdateIssueFieldsPut migrationResourceUpdateEntityPropertiesValuePut migrationResourceWorkflowRuleSearchPost initialize

Constructors

constructor

  • new AppMigrationService(getClientInstance): AppMigrationService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns AppMigrationService

Methods

appIssueFieldValueUpdateResourceUpdateIssueFieldsPut

  • appIssueFieldValueUpdateResourceUpdateIssueFieldsPut(params): Promise<unknown>

  • Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated.

    Permissions required: Only Connect apps can make this request

    Parameters

    • params: {
          atlassianTransferId: string;
          connectCustomFieldValues: ConnectCustomFieldValues;
      }
      • atlassianTransferId: string

        The ID of the transfer.

      • connectCustomFieldValues: ConnectCustomFieldValues

        Example

        {
        "updateValueList": [
            {
              "_type": "StringIssueField",
              "issueID": 10001,
              "fieldID": 10076,
              "string": "new string value"
            },
            {
              "_type": "TextIssueField",
              "issueID": 10002,
              "fieldID": 10077,
              "text": "new text value"
            },
            {
              "_type": "SingleSelectIssueField",
              "issueID": 10003,
              "fieldID": 10078,
              "optionID": "1"
            },
            {
              "_type": "MultiSelectIssueField",
              "issueID": 10004,
              "fieldID": 10079,
              "optionID": "2"
            },
            {
              "_type": "RichTextIssueField",
              "issueID": 10005,
              "fieldID": 10080,
              "richText": "new rich text value"
            },
            {
              "_type": "NumberIssueField",
              "issueID": 10006,
              "fieldID": 10082,
              "number": 54
            }
          ]
        }

    Returns Promise<unknown>

    Returned if the request is successful.

    Path

    PUT /rest/atlassian-connect/1/migration/field

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration#api-rest-atlassian-connect-1-migration-field-put

migrationResourceUpdateEntityPropertiesValuePut

  • migrationResourceUpdateEntityPropertiesValuePut(params): Promise<void>

  • Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for use by Connect apps during app migration.

    Parameters

    • params: {
          atlassianTransferId: string;
          entityPropertyDetailses: EntityPropertyDetails[];
          entityType:
              | "IssueProperty"
              | "CommentProperty"
              | "DashboardItemProperty"
              | "IssueTypeProperty"
              | "ProjectProperty"
              | "UserProperty"
              | "WorklogProperty"
              | "BoardProperty"
              | "SprintProperty";
      }
      • atlassianTransferId: string

        The app migration transfer ID.

      • entityPropertyDetailses: EntityPropertyDetails[]
      • entityType:
            | "IssueProperty"
            | "CommentProperty"
            | "DashboardItemProperty"
            | "IssueTypeProperty"
            | "ProjectProperty"
            | "UserProperty"
            | "WorklogProperty"
            | "BoardProperty"
            | "SprintProperty"

        The type indicating the object that contains the entity properties.

    Returns Promise<void>

    Path

    PUT /rest/atlassian-connect/1/migration/properties/{entityType}

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration#api-rest-atlassian-connect-1-migration-properties-entitytype-put

migrationResourceWorkflowRuleSearchPost

  • migrationResourceWorkflowRuleSearchPost(params): Promise<WorkflowRulesSearchDetails>

  • Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

    Parameters

    • params: {
          atlassianTransferId: string;
          workflowRulesSearch: WorkflowRulesSearch;
      }
      • atlassianTransferId: string

        The app migration transfer ID.

      • workflowRulesSearch: WorkflowRulesSearch

    Returns Promise<WorkflowRulesSearchDetails>

    Returned if the request is successful.

    example:

    {
      "workflowEntityId": "a498d711-685d-428d-8c3e-bc03bb450ea7",
      "invalidRules": [
        "55d44f1d-c859-42e5-9c27-2c5ec3f340b1"
      ],
      "validRules": [
        {
          "workflowId": {
            "name": "Workflow name",
            "draft": true
          },
          "postFunctions": [
            {
              "id": "123",
              "key": "WorkflowKey",
              "configuration": {
                "value": "WorkflowValidator"
              },
              "transition": {
                "name": "transition",
                "id": 123
              }
            }
          ],
          "conditions": [
            {
              "id": "123",
              "key": "WorkflowKey",
              "configuration": {
                "value": "WorkflowValidator"
              },
              "transition": {
                "name": "transition",
                "id": 123
              }
            }
          ],
          "validators": [
            {
              "id": "123",
              "key": "WorkflowKey",
              "configuration": {
                "value": "WorkflowValidator"
              },
              "transition": {
                "name": "transition",
                "id": 123
              }
            }
          ]
        }
      ]
    }

    Path

    POST /rest/atlassian-connect/1/migration/workflow/rule/search

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration#api-rest-atlassian-connect-1-migration-workflow-rule-search-post

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods