Atlassian App Migration API

openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: Atlassian The Jira Cloud platform REST App Migration API
  version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
servers:
- url: https://your-domain.atlassian.net
tags:
- name: App Migration
paths:
  /rest/atlassian-connect/1/migration/field:
    put:
      deprecated: false
      description: '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'
      operationId: atlassianAppissuefieldvalueupdateresourceUpdateissuefieldsPut
      parameters:
      - description: The ID of the transfer.
        in: header
        name: Atlassian-Transfer-Id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            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
            schema:
              $ref: '#/components/schemas/ConnectCustomFieldValues'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          description: Returned if the request is invalid.
        '403':
          description: 'Returned if:

            * the transfer ID is not found.

            * the authorisation credentials are incorrect or missing.'
      summary: Atlassian Bulk Update Custom Field Value
      tags:
      - App Migration
      x-atlassian-connect-scope: NONE
  /rest/atlassian-connect/1/migration/properties/{entityType}:
    put:
      description: 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.
      operationId: atlassianMigrationresourceUpdateentitypropertiesvaluePut
      parameters:
      - description: The app migration transfer ID.
        in: header
        name: Atlassian-Transfer-Id
        required: true
        schema:
          format: uuid
          type: string
      - description: The type indicating the object that contains the entity properties.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - IssueProperty
          - CommentProperty
          - DashboardItemProperty
          - IssueTypeProperty
          - ProjectProperty
          - UserProperty
          - WorklogProperty
          - BoardProperty
          - SprintProperty
          type: string
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/EntityPropertyDetails'
              maxItems: 50
              minItems: 1
              type: array
        required: true
      responses:
        '200':
          description: Returned if the request is successful.
        '400':
          description: Returned if the request is not valid.
        '403':
          description: Returned if the authorisation credentials are incorrect or missing.
      summary: Atlassian Bulk Update Entity Properties
      tags:
      - App Migration
      x-atlassian-connect-scope: NONE
  /rest/atlassian-connect/1/migration/workflow/rule/search:
    post:
      description: Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.
      operationId: atlassianMigrationresourceWorkflowrulesearchPost
      parameters:
      - description: The app migration transfer ID.
        in: header
        name: Atlassian-Transfer-Id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowRulesSearch'
        required: true
      responses:
        '200':
          content:
            application/json:
              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
              schema:
                $ref: '#/components/schemas/WorkflowRulesSearchDetails'
          description: Returned if the request is successful.
        '400':
          description: Returned if the request is not valid.
        '403':
          description: Returned if the authorisation credentials are incorrect or missing.
      summary: Atlassian Get Workflow Transition Rule Configurations
      tags:
      - App Migration
      x-atlassian-connect-scope: NONE
components:
  schemas:
    WorkflowRulesSearch:
      description: Details of the workflow and its transition rules.
      properties:
        expand:
          description: Use expand to include additional information in the response. This parameter accepts `transition` which, for each rule, returns information about the transition the rule is assigned to.
          example: transition
          type: string
        ruleIds:
          description: The list of workflow rule IDs.
          items:
            description: Workflow rule ID.
            example: 55d44f1d-c859-42e5-9c27-2c5ec3f340b1
            format: uuid
            type: string
          maxItems: 10
          minItems: 1
          type: array
        workflowEntityId:
          description: The workflow ID.
          example: a498d711-685d-428d-8c3e-bc03bb450ea7
          format: uuid
          type: string
      required:
      - ruleIds
      - workflowEntityId
      type: object
    EntityPropertyDetails:
      properties:
        entityId:
          description: The entity property ID.
          example: 123
          type: number
        key:
          description: The entity property key.
          example: mykey
          type: string
        value:
          description: The new value of the entity property.
          example: newValue
          type: string
      required:
      - entityId
      - key
      - value
      type: object
    WorkflowTransitionRules:
      additionalProperties: false
      description: A workflow with transition rules.
      properties:
        conditions:
          description: The list of conditions within the workflow.
          items:
            $ref: '#/components/schemas/AppWorkflowTransitionRule'
          type: array
        postFunctions:
          description: The list of post functions within the workflow.
          items:
            $ref: '#/components/schemas/AppWorkflowTransitionRule'
          type: array
        validators:
          description: The list of validators within the workflow.
          items:
            $ref: '#/components/schemas/AppWorkflowTransitionRule'
          type: array
        workflowId:
          $ref: '#/components/schemas/WorkflowId'
      required:
      - workflowId
      type: object
    RuleConfiguration:
      additionalProperties: false
      description: A rule configuration.
      properties:
        disabled:
          default: false
          description: Whether the rule is disabled.
          type: boolean
        tag:
          description: A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get).
          maxLength: 255
          type: string
        value:
          description: Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page.
          type: string
      required:
      - value
      type: object
    ConnectCustomFieldValue:
      description: A list of custom field details.
      properties:
        _type:
          description: The type of custom field.
          enum:
          - StringIssueField
          - NumberIssueField
          - RichTextIssueField
          - SingleSelectIssueField
          - MultiSelectIssueField
          - TextIssueField
          type: string
          writeOnly: true
        fieldID:
          description: The custom field ID.
          type: integer
          writeOnly: true
        issueID:
          description: The issue ID.
          type: integer
          writeOnly: true
        number:
          description: The value of number type custom field when `_type` is `NumberIssueField`.
          type: number
        optionID:
          description: The value of single select and multiselect custom field type when `_type` is `SingleSelectIssueField` or `MultiSelectIssueField`.
          type: string
        richText:
          description: The value of richText type custom field when `_type` is `RichTextIssueField`.
          type: string
        string:
          description: The value of string type custom field when `_type` is `StringIssueField`.
          type: string
        text:
          description: The value of of text custom field type when `_type` is `TextIssueField`.
          type: string
      required:
      - _type
      - fieldID
      - issueID
      type: object
      writeOnly: true
    AppWorkflowTransitionRule:
      additionalProperties: false
      description: A workflow transition rule.
      properties:
        configuration:
          $ref: '#/components/schemas/RuleConfiguration'
        id:
          description: The ID of the transition rule.
          type: string
        key:
          description: The key of the rule, as defined in the Connect or the Forge app descriptor.
          readOnly: true
          type: string
        transition:
          allOf:
          - $ref: '#/components/schemas/WorkflowTransition'
          readOnly: true
      required:
      - configuration
      - id
      - key
      type: object
    WorkflowRulesSearchDetails:
      description: Details of workflow transition rules.
      properties:
        invalidRules:
          description: List of workflow rule IDs that do not belong to the workflow or can not be found.
          items:
            description: Workflow rule ID.
            example: 55d44f1d-c859-42e5-9c27-2c5ec3f340b1
            format: uuid
            type: string
          type: array
        validRules:
          description: List of valid workflow transition rules.
          items:
            $ref: '#/components/schemas/WorkflowTransitionRules'
          type: array
        workflowEntityId:
          description: The workflow ID.
          example: a498d711-685d-428d-8c3e-bc03bb450ea7
          format: uuid
          type: string
      type: object
    ConnectCustomFieldValues:
      additionalProperties: false
      description: Details of updates for a custom field.
      properties:
        updateValueList:
          description: The list of custom field update details.
          items:
            $ref: '#/components/schemas/ConnectCustomFieldValue'
          type: array
      type: object
      writeOnly: true
    WorkflowTransition:
      additionalProperties: false
      description: A workflow transition.
      properties:
        id:
          description: The transition ID.
          format: int32
          type: integer
        name:
          description: The transition name.
          type: string
      required:
      - id
      - name
      type: object
    WorkflowId:
      additionalProperties: false
      description: Properties that identify a workflow.
      properties:
        draft:
          description: Whether the workflow is in the draft state.
          type: boolean
        name:
          description: The name of the workflow.
          type: string
      required:
      - draft
      - name
      type: object
  securitySchemes:
    OAuth2:
      description: OAuth2 scopes for Jira
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          scopes:
            delete:async-task:jira: Delete asynchronous task.
            delete:attachment:jira: Delete issue attachments.
            delete:avatar:jira: Delete system and custom avatars.
            delete:comment.property:jira: Delete issue comment properties.
            delete:comment:jira: Delete issue comments.
            delete:dashboard.property:jira: Delete dashboard properties.
            delete:dashboard:jira: Delete dashboards.
            delete:field-configuration-scheme:jira: Delete field configuration schemes.
            delete:field-configuration:jira: Delete field configurations.
            delete:field.option:jira: Delete field options.
            delete:field:jira: Delete fields.
            delete:filter.column:jira: Delete filter columns.
            delete:filter:jira: Delete filters.
            delete:group:jira: Delete user groups.
            delete:issue-link-type:jira: Delete issue link types.
            delete:issue-link:jira: Delete issue links.
            delete:issue-type-scheme:jira: Delete issue type schemes.
            delete:issue-type-screen-scheme:jira: Delete issue type screen schemes.
            delete:issue-type.property:jira: Delete issue type properties.
            delete:issue-type:jira: Delete issue types.
            delete:issue-worklog.property:jira: Delete issue worklog properties.
            delete:issue-worklog:jira: Delete issue worklogs.
            delete:issue.property:jira: Delete issue properties.
            delete:issue.remote-link:jira: Delete issue remote links.
            delete:issue:jira: Delete issues.
            delete:permission-scheme:jira: Delete permission schemes.
            delete:permission:jira: Delete permissions.
            delete:project-category:jira: Delete project categories.
            delete:project-role:jira: Delete project roles.
            delete:project-version:jira: Delete project versions.
            delete:project.avatar:jira: Delete project avatars.
            delete:project.component:jira: Delete project components.
            delete:project.property:jira: Delete project properties.
            delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars.
            delete:screen-scheme:jira: Delete screen schemes.
            delete:screen-tab:jira: Delete screen tabs.
            delete:screen:jira: Delete screens.
            delete:screenable-field:jira: Delete screenable fields.
            delete:user-configuration:jira: Delete user configurations.
            delete:user.property:jira: Delete user properties.
            delete:webhook:jira: Delete webhooks.
            delete:workflow-scheme:jira: Delete workflow schemes.
            delete:workflow.property:jira: Delete workflow properties.
            delete:workflow:jira: Delete workflows.
            manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.
            manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components.
            manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks.
            read:application-role:jira: View application roles.
            read:attachment:jira: View issue attachments.
            read:audit-log:jira: View audit logs.
            read:avatar:jira: View system and custom avatars.
            read:comment.property:jira: View issue comment properties.
            read:comment:jira: View issue comments.
            read:custom-field-contextual-configuration:jira: Read custom field contextual configurations.
            read:dashboard.property:jira: View dashboard properties.
            read:dashboard:jira: View dashboards.
            read:field-configuration-scheme:jira: View field configuration schemes.
            read:field-configuration:jira: Read field configurations.
            read:field.default-value:jira: View field default values.
            read:field.option:jira: View field options.
            read:field.options:jira: Read field options.
            read:field:jira: View fields.
            read:filter.column:jira: View filter columns.
            read:filter.default-share-scope:jira: View filter default share scopes.
            read:filter:jira: View filters.
            read:group:jira: View user groups.
            read:instance-configuration:jira: View instance configurations.
            read:issue-details:jira: View issue details.
            read:issue-event:jira: Read issue events.
            read:issue-field-values:jira: View issue field valueses.
            read:issue-link-type:jira: View issue link types.
            read:issue-link:jira: View issue links.
            read:issue-meta:jira: View issue meta.
            read:issue-security-level:jira: View issue security levels.
            read:issue-security-scheme:jira: View issue security schemes.
            read:issue-status:jira: View issue statuses.
            read:issue-type-hierarchy:jira: Read issue type hierarchies.
            read:issue-type-scheme:jira: View issue type schemes.
            read:issue-type-screen-scheme:jira: View issue type screen schemes.
            read:issue-type.property:jira: View issue type properties.
            read:issue-type:jira: View issue types.
            read:issue-worklog.property:jira: View issue worklog properties.
            read:issue-worklog:jira: View issue worklogs.
            read:issue.changelog:jira: View issue changelogs.
            read:issue.property:jira: View issue properties.
            read:issue.remote-link:jira: View issue remote links.
            read:issue.time-tracking:jira: View issue time trackings.
            read:issue.transition:jira: View issue transitions.
            read:issue.vote:jira: View issue votes.
            read:issue.votes:jira: View issue voteses.
            read:issue.watcher:jira: View issue watchers.
            read:issue:jira: View issues.
            read:jira-expressions:jira: View jira expressions.
            read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars.
            read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).
            read:jql:jira: View JQL.
            read:label:jira: View labels.
            read:license:jira: View licenses.
            read:notification-scheme:jira: View notification schemes.
            read:permission-scheme:jira: View permission schemes.
            read:permission:jira: View permissions.
            read:priority:jira: View priorities.
            read:project-category:jira: View project categories.
            read:project-role:jira: View project roles.
            read:project-type:jira: View project types.
            read:project-version:jira: View project versions.
            read:project.avatar:jira: Read project avatars.
            read:project.component:jira: View project components.
            read:project.email:jira: View project emails.
            read:project.feature:jira: Read project features.
            read:project.property:jira: View project properties.
            read:project:jira: View projects.
            read:resolution:jira: View resolutions.
            read:role:jira: View roles.
            read:screen-field:jira: View screen fields.
            read:screen-scheme:jira: View screen schemes.
            read:screen-tab:jira: View screen tabs.
            read:screen:jira: View screens.
            read:screenable-field:jira: View screenable fields.
            read:status:jira: View statuses.
            read:user-configuration:jira: View user configurations.
            read:user.columns:jira: View user columnses.
            read:user.property:jira: View user properties.
            read:user:jira: View users.
            read:webhook:jira: View webhooks.
            read:workflow-scheme:jira: View workflow schemes.
            read:workflow.property:jira: View workflow properties.
            read:workflow:jira: View workflows.
            send:notification:jira: Send notifications.
            validate:jql:jira: Validate JQL.
            write:attachment:jira: Create and update issue attachments.
            write:avatar:jira: Create and update system and custom avatars.
            write:comment.property:jira: Create and update issue comment properties.
            write:comment:jira: Create and update issue comments.
            write:custom-field-contextual-configuration:jira: Save custom field contextual configurations.
            write:dashboard.property:jira: Create and update dashboard properties.
            write:dashboard:jira: Create and update dashboards.
            write:field-configuration-scheme:jira: Create and update field configuration schemes.
            write:field-configuration:jira: Save field configurations.
            write:field.default-value:jira: Create and update field default values.
            write:field.option:jira: Create and update field options.
            write:field:jira: Create and update fields.
            write:filter.column:jira: Create and update filter columns.
            write:filter.default-share-scope:jira: Create and update filter default share scopes.
            write:filter:jira: Create and update filters.
            write:group:jira: Create and update user groups.
            write:instance-configuration:jira: Create and update instance configurations.
            write:issue-link-type:jira: Create and update issue link types.
            write:issue-link:jira: Create and update issue links.
            write:issue-type-scheme:jira: Create and update issue type schemes.
            write:issue-type-screen-scheme:jira: Create and update issue type screen schemes.
            write:issue-type.property:jira: Create and update issue type properties.
            write:issue-type:jira: Create and update issue types.
            write:issue-worklog.property:jira: Create and update issue worklog properties.
            write:issue-worklog:jira: Create and update issue worklogs.
            write:issue.property:jira: Create and update issue properties.
            write:issue.remote-link:jira: Create and update issue remote links.
            write:issue.time-tracking:jira: Create and update issue time trackings.
            write:issue.vote:jira: Create and update issue votes.
            write:issue.watcher:jira: Create and update issue watchers.
            write:issue:jira: Create and update issues.
            write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues.
            write:permission-scheme:jira: Create and update permission schemes.
            write:permission:jira: Create and update permissions.
            write:project-category:jira: Create and update project categories.
            write:project-role:jira: Create and update project roles.
            write:project-version:jira: Create and update project versions.
            write:project.avatar:jira: Create and update project avatars.
            write:project.component:jira: Create and update project components.
            write:project.email:jira: Create and update project emails.
            write:project.feature:jira: Save project features.
            write:project.property:jira: Create and update project properties.
            write:project:jira: Create and update projects.
            write:screen-scheme:jira: Create and update screen schemes.
            write:screen-tab:jira: Create and update screen tabs.
            write:screen:jira: Create and update screens.
            write:screenable-field:jira: Create and update screenable fields.
            write:user-configuration:jira: Create and update user configurations.
            write:user.property:jira: Create and update user properties.
            write:webhook:jira: Create and update webhooks.
            write:workflow-scheme:jira: Create and update workflow schemes.
            write:workflow.property:jira: Create and update workflow properties.
            write:workflow:jira: Create and update workflows.
          tokenUrl: https://auth.atlassian.com/oauth/token
      type: oauth2
    basicAuth:
      description: You can access this resource via basic auth.
      scheme: basic
      type: http
externalDocs:
  description: Find out more about Atlassian products and services.
  url: http://www.atlassian.com
x-atlassian-narrative:
  documents:
  - anchor: about
    body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses."
    title: About
  - anchor: version
    body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest version\nbut is in **beta**. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and \nversion 3 of the API offer the same collection of operations. However, version 3 provides support for \nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) \n(ADF) in: \n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields \n  (`textfield`) accept a string and don't handle Atlassian Document Format content.\n\nHowever, these new features are under development and may change.\n"
    title: Version
  - anchor: authentication
    body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/<resource-name>`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https://<site-url>/rest/api/3/<resource-name>`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira/<cloudId>/rest/api/3/<resource-name>`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https://<site-url>/rest/api/3/<resource-name>`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n"
    title: Authentication and authorization


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/atlassian/openapi/atlassian-app-migration-api-openapi.yml