Developer
Documentation
Resources
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Last updated Sep 22, 2025

Swagger API

1
2
{
  "openapi": "3.1.0",
  "info": {
    "title": "",
    "version": ""
  },
  "servers": [
    {
      "url": "<FORGE_EGRESS_PROXY_URL>"
    }
  ],
  "paths": {
    "/app/migration/forge/v1/message/{transferId}/status": {
      "post": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Update message status",
        "operationId": "setMessageProgress",
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "description": "Transfer ID as UUID",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MessageProgress"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/app/migration/forge/v1/mapping/{transferId}/find": {
      "post": {
        "tags": [
          "Forge Resource"
        ],
        "operationId": "findByNamespaceAndKeys_1",
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "description": "Transfer ID as UUID",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "namespace",
            "in": "query",
            "description": "Namespace",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "uniqueItems": true
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/app/migration/forge/v1/log/{transferId}": {
      "post": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Add log message from the Forge App",
        "operationId": "addLog",
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "description": "Transfer ID as UUID",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ForgeAppLog"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/app/migration/forge/v1/mapping/{transferId}/page": {
      "get": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Returns mappings for a given namespace",
        "operationId": "getMapping",
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "namespace",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lastEntity",
            "in": "query",
            "description": "Last Entity",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Size of each returning page",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1200,
              "maximum": 1200,
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/MigrationMappingDto"
                }
              }
            }
          }
        }
      }
    },
    "/app/migration/forge/v1/data/{transferId}/all": {
      "get": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Returns all uploaded file s3 keys for a transfer Id",
        "operationId": "getUploadedFiles",
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ForgeFileMappingDto"
                  },
                  "uniqueItems": true
                }
              }
            }
          }
        }
      }
    },
    "/app/migration/forge/v1/data/{s3Key}": {
      "get": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Returns an object containing a signed url to retrieve app data",
        "operationId": "getAppData_1",
        "parameters": [
          {
            "name": "s3Key",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/app/migration/forge/v1/data/{s3Key}/payload": {
      "get": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Returns an object containing a signed url to retrieve app data",
        "operationId": "getAppDataPayload",
        "parameters": [
          {
            "name": "s3Key",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/octet-stream": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        }
      }
    },
    "/app/migration/forge/v1/container/{transferId}/page": {
      "get": {
        "tags": [
          "Forge Resource"
        ],
        "summary": "Returns containers for a given transferId and container Type",
        "operationId": "getContainersForTransferIdByPage",
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "description": "Transfer ID as UUID",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "containerType",
            "in": "query",
            "description": "Container Type",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "JiraProject",
                "ConfluenceSpace",
                "Site"
              ]
            }
          },
          {
            "name": "lastEntity",
            "in": "query",
            "description": "Last Entity",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Size of each returning page",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 250,
              "maximum": 250,
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ContainerByPageResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ConsentRequest": {
        "type": "object",
        "properties": {
          "displayedText": {
            "type": "string",
            "maxLength": 800,
            "minLength": 3
          },
          "sens": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "maxItems": 5,
            "minItems": 1,
            "uniqueItems": true
          }
        }
      },
      "WebhookEndpointsDto": {
        "type": "object",
        "description": "Set of endpoints called after the app migration.",
        "properties": {
          "endpoints": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        }
      },
      "ModifyTransferStateRequest": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "containerId": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "enum": [
              "READY",
              "IN_PROGRESS",
              "SUCCESS",
              "FAILED",
              "SKIPPED",
              "TIMED_OUT",
              "INCOMPLETE",
              "CANCELLATION_REQUESTED",
              "CANCELLED"
            ]
          }
        },
        "required": [
          "containerId",
          "migrationId",
          "status"
        ]
      },
      "DefaultWebhookRequest": {
        "type": "object",
        "properties": {
          "endpoint": {
            "type": "string"
          }
        }
      },
      "JobChangeDetail": {
        "type": "object",
        "properties": {
          "jobId": {
            "type": "string"
          },
          "entityType": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "IN_PROGRESS",
              "COMPLETED",
              "FAILED",
              "ABORTED"
            ]
          }
        }
      },
      "FeederRequest": {
        "type": "object",
        "properties": {
          "jobId": {
            "type": "string"
          },
          "entityType": {
            "type": "string"
          },
          "paginationKey": {
            "type": "string"
          },
          "schemaVersion": {
            "type": "integer",
            "format": "int32"
          },
          "segment": {
            "type": "integer",
            "format": "int32"
          },
          "dryRun": {
            "type": "boolean"
          },
          "jobType": {
            "type": "string",
            "enum": [
              "PMR",
              "NON_PMR",
              "TIDB"
            ]
          }
        }
      },
      "FeederResponseSql": {
        "type": "object",
        "properties": {
          "tableRecords": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShardAwareTableRecord"
            }
          },
          "jobType": {
            "type": "string",
            "enum": [
              "PMR",
              "NON_PMR",
              "TIDB"
            ]
          },
          "nextPaginationKey": {
            "type": "string"
          }
        }
      },
      "ShardAwareTableRecord": {
        "type": "object",
        "properties": {
          "shardingContext": {
            "type": "string"
          },
          "tableRecord": {
            "$ref": "#/components/schemas/TableRecord"
          }
        }
      },
      "TableRecord": {
        "type": "object",
        "properties": {
          "tableName": {
            "type": "string"
          },
          "columnVsValueMap": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "Condition": {
        "type": "object",
        "properties": {
          "attribute": {
            "type": "string"
          },
          "operator": {
            "type": "string",
            "enum": [
              "EQ",
              "NE",
              "LT",
              "LE",
              "GT",
              "GE"
            ]
          },
          "value": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "FeederResponse": {
        "type": "object",
        "properties": {
          "shardAwareNodes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShardAwareNodeModel"
            }
          },
          "jobType": {
            "type": "string",
            "enum": [
              "PMR",
              "NON_PMR",
              "TIDB"
            ]
          },
          "nextPaginationKey": {
            "type": "string"
          }
        }
      },
      "NodeDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "schemaVersion": {
            "type": "integer",
            "format": "int64"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "ShardAwareNodeModel": {
        "type": "object",
        "properties": {
          "workSpaceAriStr": {
            "type": "string"
          },
          "nodeDto": {
            "$ref": "#/components/schemas/NodeDto"
          },
          "condition": {
            "$ref": "#/components/schemas/Condition"
          }
        }
      },
      "GetUploadMutationUrlRequest": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "uploadId": {
            "type": "string"
          },
          "chunkIndex": {
            "type": "string"
          },
          "contentLength": {
            "type": "string"
          },
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "contentSHA256": {
            "type": "string"
          },
          "contentMD5": {
            "type": "string"
          }
        },
        "required": [
          "transferId"
        ]
      },
      "MutationRequest": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "seed": {
            "type": "string"
          }
        }
      },
      "InitializeUploadResponse": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "uploadId": {
            "type": "string"
          }
        }
      },
      "FinalizeUploadRequest": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "uploadId": {
            "type": "string"
          },
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "sha256CheckSumValues": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "etags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "CloudSiteRequest": {
        "type": "object",
        "properties": {
          "appKeys": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            }
          }
        }
      },
      "CloudSiteResponse": {
        "type": "object",
        "properties": {
          "cloudId": {
            "type": "string"
          },
          "apps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteAppInfo"
            }
          }
        }
      },
      "SiteAppInfo": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "installed": {
            "type": "boolean"
          }
        }
      },
      "CloudAppsInstalled": {
        "type": "object",
        "properties": {
          "cloudAppKeys": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "cloudAppKeys"
        ]
      },
      "Function0Unit": {},
      "RegisterTransferAnalytics": {
        "type": "object",
        "properties": {
          "listenerFamily": {
            "type": "string"
          }
        }
      },
      "RegisterTransferRequest": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "cloudAppKey": {
            "type": "string"
          },
          "accessScopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "APP_DATA_UGC",
                "APP_DATA_PII",
                "APP_DATA_SECURITY",
                "APP_DATA_OTHER",
                "PRODUCT_DATA_UGC",
                "PRODUCT_DATA_PII",
                "PRODUCT_DATA_SECURITY",
                "PRODUCT_DATA_OTHER",
                "MIGRATION_TRACING_PRODUCT",
                "MIGRATION_TRACING_IDENTITY"
              ]
            },
            "uniqueItems": true
          },
          "analytics": {
            "$ref": "#/components/schemas/RegisterTransferAnalytics"
          },
          "enableAcceleratedTransfer": {
            "type": "boolean"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "cloudAppKey"
        ]
      },
      "CancelTransferRequest": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        },
        "required": [
          "message"
        ]
      },
      "CancelTransferResponse": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "expireTime": {
            "type": "string"
          }
        }
      },
      "RegisterTransferRerunRequest": {
        "type": "object",
        "properties": {
          "accessScopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "APP_DATA_UGC",
                "APP_DATA_PII",
                "APP_DATA_SECURITY",
                "APP_DATA_OTHER",
                "PRODUCT_DATA_UGC",
                "PRODUCT_DATA_PII",
                "PRODUCT_DATA_SECURITY",
                "PRODUCT_DATA_OTHER",
                "MIGRATION_TRACING_PRODUCT",
                "MIGRATION_TRACING_IDENTITY"
              ]
            },
            "uniqueItems": true
          },
          "analytics": {
            "$ref": "#/components/schemas/RegisterTransferAnalytics"
          },
          "transferId": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "RerunTransferResponse": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "originalTransferId": {
            "type": "string",
            "format": "uuid"
          },
          "transferName": {
            "type": "string"
          }
        }
      },
      "RegisterMultiTransferRequest": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "cloudAppKey": {
            "type": "string"
          },
          "transfers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RegisterTransferDefinition"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "cloudAppKey"
        ]
      },
      "RegisterTransferDefinition": {
        "type": "object",
        "properties": {
          "accessScopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "APP_DATA_UGC",
                "APP_DATA_PII",
                "APP_DATA_SECURITY",
                "APP_DATA_OTHER",
                "PRODUCT_DATA_UGC",
                "PRODUCT_DATA_PII",
                "PRODUCT_DATA_SECURITY",
                "PRODUCT_DATA_OTHER",
                "MIGRATION_TRACING_PRODUCT",
                "MIGRATION_TRACING_IDENTITY"
              ]
            },
            "uniqueItems": true
          },
          "analytics": {
            "$ref": "#/components/schemas/RegisterTransferAnalytics"
          },
          "enableAcceleratedTransfer": {
            "type": "boolean"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "transferName": {
            "type": "string"
          },
          "dependsOn": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "blocking": {
            "type": "boolean"
          }
        }
      },
      "RegisterForgeTransferRequest": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "appId": {
            "type": "string",
            "format": "uuid"
          },
          "environmentType": {
            "type": "string",
            "enum": [
              "DEVELOPMENT",
              "STAGING",
              "PRODUCTION"
            ]
          },
          "accessScopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "APP_DATA_UGC",
                "APP_DATA_PII",
                "APP_DATA_SECURITY",
                "APP_DATA_OTHER",
                "PRODUCT_DATA_UGC",
                "PRODUCT_DATA_PII",
                "PRODUCT_DATA_SECURITY",
                "PRODUCT_DATA_OTHER",
                "MIGRATION_TRACING_PRODUCT",
                "MIGRATION_TRACING_IDENTITY"
              ]
            },
            "uniqueItems": true
          },
          "analytics": {
            "$ref": "#/components/schemas/RegisterTransferAnalytics"
          },
          "enableAcceleratedTransfer": {
            "type": "boolean"
          },
          "environmentName": {
            "type": "string"
          }
        },
        "required": [
          "appId"
        ]
      },
      "RegisterForgeMultiTransferRequest": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "appId": {
            "type": "string",
            "format": "uuid"
          },
          "environmentName": {
            "type": "string"
          },
          "transfers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RegisterTransferDefinition"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "appId"
        ]
      },
      "GetUploadUrlRequest": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "uploadId": {
            "type": "string"
          },
          "chunkIndex": {
            "type": "string"
          },
          "contentMD5": {
            "type": "string"
          },
          "contentLength": {
            "type": "string"
          },
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "firstByte": {
            "type": "integer",
            "format": "int64"
          },
          "lastByte": {
            "type": "integer",
            "format": "int64"
          },
          "contentSHA256": {
            "type": "string"
          }
        },
        "required": [
          "transferId"
        ]
      },
      "Unit": {},
      "ForgeSqlRequest": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 1000,
            "minItems": 1
          },
          "tableName": {
            "type": "string"
          },
          "importOnForgeStorage": {
            "type": "boolean"
          },
          "transformers": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "MriIdMapping"
              ]
            }
          }
        }
      },
      "ForgeKeyValuePairRequest": {
        "type": "object",
        "properties": {
          "items": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "entityName": {
            "type": "string"
          },
          "importOnForgeStorage": {
            "type": "boolean"
          },
          "transformers": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "MriIdMapping"
              ]
            }
          }
        }
      },
      "GetPreloadDataUploadUrlRequest": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "uploadId": {
            "type": "string"
          },
          "chunkIndex": {
            "type": "string"
          },
          "contentLength": {
            "type": "string"
          },
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "contentSHA256": {
            "type": "string"
          }
        },
        "required": [
          "transferId"
        ]
      },
      "FinalizePreloadEventRequest": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string",
            "format": "uuid"
          },
          "preloadTransferId": {
            "type": "string",
            "format": "uuid"
          },
          "s3Key": {
            "type": "string"
          }
        }
      },
      "FinalizePreloadDataUploadRequest": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "uploadId": {
            "type": "string"
          },
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "sha256CheckSumValues": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "etags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "transferId"
        ]
      },
      "MessageProgress": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "FAILED"
            ]
          },
          "messageIds": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "uniqueItems": true
          }
        }
      },
      "ForgeAppLog": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "maxLength": 65536,
            "minLength": 0
          }
        }
      },
      "TransferError": {
        "type": "object",
        "properties": {
          "exceptionType": {
            "type": "string"
          },
          "safeStackTrace": {
            "type": "string"
          }
        },
        "required": [
          "exceptionType",
          "safeStackTrace"
        ]
      },
      "SiteAppsLicenseRequest": {
        "type": "object",
        "properties": {
          "appKeys": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "uniqueItems": true
          }
        }
      },
      "AppLicenseDetailDto": {
        "type": "object",
        "properties": {
          "appKey": {
            "type": "string"
          },
          "licensed": {
            "type": "boolean"
          }
        }
      },
      "AppsLicenseResponseDto": {
        "type": "object",
        "properties": {
          "appLicenses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppLicenseDetailDto"
            },
            "uniqueItems": true
          }
        }
      },
      "WebhookCheckRequestDto": {
        "type": "object",
        "properties": {
          "appKeys": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "uniqueItems": true
          },
          "product": {
            "type": "string"
          },
          "hosting": {
            "type": "string"
          }
        }
      },
      "AppWebhookCheckResult": {
        "type": "object",
        "properties": {
          "appKey": {
            "type": "string"
          },
          "available": {
            "type": "boolean"
          }
        }
      },
      "WebhookResponseDto": {
        "type": "object",
        "properties": {
          "appEndpoints": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppWebhookCheckResult"
            },
            "uniqueItems": true
          },
          "stepsToResolve": {
            "type": "string"
          }
        }
      },
      "ProgressEndpointDto": {
        "type": "object",
        "properties": {
          "percent": {
            "type": "integer",
            "format": "int32",
            "maximum": 100,
            "minimum": 0
          },
          "status": {
            "type": "string",
            "enum": [
              "READY",
              "IN_PROGRESS",
              "SUCCESS",
              "FAILED",
              "SKIPPED",
              "TIMED_OUT",
              "INCOMPLETE",
              "CANCELLATION_REQUESTED",
              "CANCELLED"
            ]
          },
          "message": {
            "type": "string",
            "maxLength": 65536,
            "minLength": 0
          }
        }
      },
      "CloudFeedback": {
        "type": "object",
        "properties": {
          "details": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "ExtendTransferLifetimeRequest": {
        "type": "object",
        "properties": {
          "extendToEpochSecond": {
            "type": "integer",
            "format": "int64"
          }
        },
        "required": [
          "extendToEpochSecond"
        ]
      },
      "ResumedEventsDto": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "eventsReplayed": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "PathfinderIdResponse": {
        "type": "object",
        "properties": {
          "pathfinderId": {
            "type": "string"
          }
        }
      },
      "FileMetadataDto": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "fileSize": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "FileMetadataDtoPage": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FileMetadataDto"
            }
          },
          "lastEvaluatedKey": {
            "type": "string"
          }
        }
      },
      "DownloadUrlResponse": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "format": "url"
          }
        }
      },
      "ContainerFileMetadataDto": {
        "type": "object",
        "properties": {
          "containerId": {
            "type": "string",
            "format": "uuid"
          },
          "fileCount": {
            "type": "integer",
            "format": "int32"
          },
          "totalFileSize": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "TransferForPlatform": {
        "type": "object",
        "properties": {
          "creator": {
            "type": "string"
          },
          "cloudId": {
            "type": "string"
          },
          "cloudAppKey": {
            "type": "string"
          },
          "migrationScope": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "TransferStartStatusResponse": {
        "type": "object",
        "properties": {
          "dependencyStatus": {
            "type": "string",
            "enum": [
              "RUNNING",
              "FINISHED",
              "FAILED"
            ]
          },
          "transferSettled": {
            "type": "boolean"
          }
        }
      },
      "StreamingResponseBody": {},
      "TransferLogEnablement": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "blockers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "EnrichedMigrationDetailsDtoV1": {
        "type": "object",
        "properties": {
          "migrationId": {
            "type": "string"
          },
          "migrationScopeId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "createdAt": {
            "type": "integer",
            "format": "int64"
          },
          "jiraClientKey": {
            "type": "string"
          },
          "confluenceClientKey": {
            "type": "string"
          },
          "cloudUrl": {
            "type": "string"
          },
          "enabledFeatures": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        }
      },
      "TransferDetailsDto": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "containerId": {
            "type": "string"
          },
          "cloudAppKey": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "name": {
            "type": "string"
          },
          "blocking": {
            "type": "boolean"
          },
          "migrationDetails": {
            "$ref": "#/components/schemas/EnrichedMigrationDetailsDtoV1"
          }
        }
      },
      "RerunEnablement": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "blockers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "AppProgress": {
        "type": "object",
        "properties": {
          "containerId": {
            "type": "string",
            "format": "uuid"
          },
          "serverAppName": {
            "type": "string"
          },
          "serverAppKey": {
            "type": "string"
          },
          "cloudAppKey": {
            "type": "string"
          },
          "completionPercent": {
            "type": "integer",
            "format": "int32"
          },
          "status": {
            "type": "string",
            "enum": [
              "READY",
              "IN_PROGRESS",
              "SUCCESS",
              "FAILED",
              "SKIPPED",
              "TIMED_OUT",
              "INCOMPLETE",
              "CANCELLATION_REQUESTED",
              "CANCELLED"
            ]
          },
          "statusMessage": {
            "type": "string"
          },
          "lastUpdatedAt": {
            "type": "integer",
            "format": "int64"
          },
          "contactVendorUrl": {
            "type": "string"
          },
          "appVendorName": {
            "type": "string"
          },
          "notCancellableTooltip": {
            "type": "string"
          },
          "multiTransfers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MultiTransfer"
            }
          },
          "readyToUse": {
            "type": "boolean"
          },
          "cancellable": {
            "type": "boolean"
          }
        }
      },
      "AppProgressResponse": {
        "type": "object",
        "properties": {
          "progress": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppProgress"
            }
          }
        }
      },
      "MultiTransfer": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "transferName": {
            "type": "string"
          },
          "completionPercent": {
            "type": "integer",
            "format": "int32"
          },
          "status": {
            "type": "string",
            "enum": [
              "READY",
              "IN_PROGRESS",
              "SUCCESS",
              "FAILED",
              "SKIPPED",
              "TIMED_OUT",
              "INCOMPLETE",
              "CANCELLATION_REQUESTED",
              "CANCELLED"
            ]
          },
          "statusMessage": {
            "type": "string"
          },
          "lastUpdatedAt": {
            "type": "integer",
            "format": "int64"
          },
          "notCancellableTooltip": {
            "type": "string"
          },
          "cancellable": {
            "type": "boolean"
          }
        }
      },
      "MigrationMappingDto": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/MigrationMappingMeta"
          },
          "items": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "MigrationMappingMeta": {
        "type": "object",
        "properties": {
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "hasNext": {
            "type": "boolean"
          },
          "lastEntity": {
            "type": "string"
          }
        }
      },
      "ForgeMacroKeyPrefixResponse": {
        "type": "object",
        "properties": {
          "macroKeyPrefix": {
            "type": "string"
          }
        }
      },
      "ForgeCFTypeKeyPrefixResponse": {
        "type": "object",
        "properties": {
          "typeKeyPrefix": {
            "type": "string"
          }
        }
      },
      "ForgeFileMappingDto": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "s3Key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        }
      },
      "ContainerByPageResponse": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/ContainerResponseMeta"
          },
          "containers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContainerV1"
            }
          }
        }
      },
      "ContainerResponseMeta": {
        "type": "object",
        "properties": {
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "hasNext": {
            "type": "boolean"
          },
          "lastEntity": {
            "type": "string"
          }
        }
      },
      "ContainerV1": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          }
        }
      },
      "TransferMetadata": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "migrationDetails": {
            "$ref": "#/components/schemas/EnrichedMigrationDetailsDtoV1"
          },
          "status": {
            "type": "string",
            "enum": [
              "READY",
              "IN_PROGRESS",
              "SUCCESS",
              "FAILED",
              "SKIPPED",
              "TIMED_OUT",
              "INCOMPLETE",
              "CANCELLATION_REQUESTED",
              "CANCELLED"
            ]
          }
        }
      },
      "FileMappingDto": {
        "type": "object",
        "properties": {
          "s3Key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        }
      },
      "TransferSummary": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string"
          },
          "migrationId": {
            "type": "string"
          },
          "appKey": {
            "type": "string"
          },
          "creationTime": {
            "type": "string"
          },
          "progress": {
            "type": "integer",
            "format": "int32"
          },
          "status": {
            "type": "string"
          },
          "endpoints": {
            "$ref": "#/components/schemas/WebhookEndpointsDto"
          },
          "files": {
            "type": "object",
            "additionalProperties": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "TransferEvent": {
        "type": "object",
        "properties": {
          "eventId": {
            "type": "string"
          },
          "eventTime": {
            "type": "integer",
            "format": "int64"
          },
          "details": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "eventTimeISO": {
            "type": "string"
          }
        }
      },
      "LogMessage": {
        "type": "object",
        "properties": {
          "level": {
            "type": "string",
            "enum": [
              "WARN",
              "INFO"
            ]
          },
          "eventTime": {
            "type": "integer",
            "format": "int64"
          },
          "message": {
            "type": "string"
          },
          "eventTimeISO": {
            "type": "string"
          }
        }
      },
      "UnifiedEventAndLogsResponse": {
        "type": "object",
        "properties": {
          "logs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogMessage"
            }
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TransferEvent"
            }
          }
        }
      },
      "MauiTransferDto": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string"
          },
          "containerId": {
            "type": "string"
          },
          "migrationId": {
            "type": "string"
          },
          "progressPercentage": {
            "type": "integer",
            "format": "int32"
          },
          "status": {
            "type": "string",
            "enum": [
              "READY",
              "IN_PROGRESS",
              "SUCCESS",
              "FAILED",
              "SKIPPED",
              "TIMED_OUT",
              "INCOMPLETE",
              "CANCELLATION_REQUESTED",
              "CANCELLED"
            ]
          },
          "statusMessage": {
            "type": "string"
          },
          "rerun": {
            "type": "boolean"
          },
          "lastUpdatedAt": {
            "type": "integer",
            "format": "int64"
          },
          "expiryTimeEpoch": {
            "type": "integer",
            "format": "int64"
          },
          "createdAt": {
            "type": "integer",
            "format": "int64"
          },
          "operationKey": {
            "type": "string"
          },
          "startedAt": {
            "type": "integer",
            "format": "int64"
          },
          "cancellationByEpoch": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "PausedTransferDto": {
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "format": "uuid"
          },
          "cloudId": {
            "type": "string"
          },
          "cloudAppKey": {
            "type": "string"
          },
          "cloudUrl": {
            "type": "string"
          },
          "product": {
            "type": "string"
          }
        }
      },
      "PausedTransferQueryResponse": {
        "type": "object",
        "properties": {
          "transfers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PausedTransferDto"
            }
          }
        }
      },
      "CheckupResult": {
        "type": "object",
        "properties": {
          "tcsDetails": {
            "$ref": "#/components/schemas/ProductDetail"
          },
          "confluenceClientKey": {
            "type": "string"
          },
          "jiraClientKey": {
            "type": "string"
          },
          "webhooks": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "uniqueItems": true
            }
          }
        }
      },
      "ProductDetail": {
        "type": "object",
        "properties": {
          "restricted": {
            "type": "boolean"
          },
          "restrictedReasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "apps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "workspaceId": {
            "type": "string"
          }
        }
      }
    }
  }
}

Rate this page: