App Data Migration Developer

App Data Migration Developer

Rate this page:

atlassian-connect-resource

Atlassian Connect Resource

Disclaimer: replace the product-specific-path with the corresponding product API i.e.,

  • your-site.atlassian.net/wiki/rest/atlassian-connect/1/migration/ for Confluence

  • your-site.atlassian.net/rest/atlassian-connect/1/migration/ for Jira

Returns an object containing a signed url to retrieve app data

GET /migration/data/{s3Key}

Request

Path parameters
s3Key Required

string

s3Key

Format: uuid

Example

1
2
3
curl --request GET \
  --url 'https://product-specific-path/migration/data/{s3Key}' \
  --header 'Accept: application/json'

Responses

OK

Content typeValue
application/json

object

Returns all uploaded data keys for a transfer id

GET /migration/data/{transferId}/all

Request

Path parameters
transferId Required

string

transferId

Format: uuid

Example

1
2
3
curl --request GET \
  --url 'https://product-specific-path/migration/data/{transferId}/all' \
  --header 'Accept: application/json'

Responses

OK

Content typeValue
application/json

Array<UploadedDataDto>

Feeds the app migration listener back with basic info coming from cloud

POST /migration/feedback/{transferId}

Request

Path parameters
transferId Required

string

transferId

Format: uuid
Body parameters
details

object

Example

1
2
3
4
5
6
curl --request POST \
  --url 'https://product-specific-path/migration/feedback/{transferId}' \
  --header 'Content-Type: application/json' \
  --data '{
  "details": {}
}'

Responses

OK

A schema has not been defined for this response code.

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

POST /migration/api/connect/v1/mapping/{transferId}/find

Request

Path parameters
transferId Required

string

Transfer ID as UUID

Format: uuid
Query parameters
namespace Required

string

Namespace

Body parameters
Content typeValue
application/json

Array<string>

Example

1
2
3
4
5
6
7
curl --request POST \
  --url 'https://product-specific-path/migration/api/connect/v1/mapping/{transferId}/find?namespace={namespace}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

Responses

OK

Content typeValue
application/json

object

Returns mappings for a given namespace

GET /migration/mapping/{transferId}/page

Request

Path parameters
transferId Required

string

transferId

Format: uuid
Query parameters
namespace Required

string

namespace

lastEntity

string

lastEntity

pageSize

integer

pageSize

Default: 5000, Minimum: 1, Maximum: 5000

Example

1
2
3
curl --request GET \
  --url 'https://product-specific-path/migration/mapping/{transferId}/page?namespace={namespace}' \
  --header 'Accept: application/json'

Responses

OK

Content typeValue
application/json

MigrationMappingDto

Returns a list of migrations available for the provided cloudAppKey

GET /migration/

Request

There are no parameters for this request.

Example

1
2
3
curl --request GET \
  --url 'https://product-specific-path/migration/' \
  --header 'Accept: */*'

Responses

OK

Content typeValue
*/*

Array<MigrationMetadata>

Retrieves all the webhook endpoints for a cloud id

GET /migration/webhook

Request

There are no parameters for this request.

Example

1
2
3
curl --request GET \
  --url 'https://product-specific-path/migration/webhook' \
  --header 'Accept: application/json'

Responses

OK

Content typeValue
application/json

WebhookEndpointsDto

Replaces existing URLs with a new set of URLs provided by your cloud app to receive notifications

PUT /migration/webhook

Request

Body parameters
endpoints

Array<string>

Non empty JSON array of absolute URL(s)

Example

1
2
3
4
5
6
7
8
curl --request PUT \
  --url 'https://product-specific-path/migration/webhook' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoints": [
    "<string>"
  ]
}'

Responses

OK

A schema has not been defined for this response code.

Deletes webhook endpoints for a cloud id

POST /migration/webhook/delete

This feature will be deprecated on 18 November 2020. Read the notice of deprecation for this feature.

Request

Body parameters
endpoints

Array<string>

Non empty JSON array of absolute URL(s)

Example

1
2
3
4
5
6
7
8
curl --request POST \
  --url 'https://product-specific-path/migration/webhook/delete' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoints": [
    "<string>"
  ]
}'

Responses

OK

A schema has not been defined for this response code.

Update or create migration progress status for transferId

POST /migration/progress/{transferId}

Request

Path parameters
transferId Required

string

transferId

Format: uuid
Body parameters
progressStatus Required

string

Valid values: READY, IN_PROGRESS, SUCCESS, FAILED, SKIPPED, INCOMPLETE

percent

integer

Format: int32
statusMessage Required

string

Example

1
2
3
4
5
6
7
8
curl --request POST \
  --url 'https://product-specific-path/migration/progress/{transferId}' \
  --header 'Content-Type: application/json' \
  --data '{
  "progressStatus": "READY",
  "percent": 2154,
  "statusMessage": "<string>"
}'

Responses

OK

A schema has not been defined for this response code.

Rate this page: