Platform

App migration platform / Reference / REST API

Mapping API

Postman Collection

OpenAPI

Provides endpoints to retrieve mappings

Operations

POST/mapping/{transferId}/find GET/mapping/{transferId}/page

POST

Get mappings by keys

Retrieves mappings for a specific namespace filtering by the keys provided on the payload

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Query parameters

namespace

string

Required

Request bodyapplication/json

keys

array<string>

Responses

application/json

MigrationMappingItem

POST/mapping/{transferId}/find

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/mapping/{transferId}/find?namespace={namespace}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

200Response

1
2
3

{
  "additionalProperties": "<string>"
}

GET

Get mappings in pages

Returns mappings for a given namespace

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Query parameters

namespace

string

Required

lastEntity

string

pageSize

integer

Responses

application/json

MigrationMappingDto

GET/mapping/{transferId}/page

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/mapping/{transferId}/page?namespace={namespace}' \
  --header 'Accept: application/json'

200Response

{
  "items": {
    "additionalProperties": "<string>"
  },
  "meta": {
    "hasNext": true,
    "lastEntity": "<string>",
    "pageSize": 2154
  }
}