JCMA Rest API

This is the JCMA REST API for creating & running plans.
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

PlansRESTAPI

PlansRESTAPI

Up 
put /plan/{id}/archive
(archivePlan)
Archive a plan

Path parameters

id (required)
Path Parameter — Plan ID

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
post /plan/{id}/cancel-project
(cancelProject)
Cancel a plan

Path parameters

id (required)
Path Parameter — Plan ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ProjectKeyList (optional)
Body Parameter — List of projects

Responses

200

Plan cancelled

404

No such plan
Up 
post /plan/{planId}/copy
(copyPlan)
Copy a plan

Path parameters

planId (required)
Path Parameter — Plan ID

Query parameters

copyCreatedTime (optional)
Query Parameter — Time at which plan's copy was created' format: int64

Return type

PlanMonitor

Example data

Content-Type: application/json
{
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Copied PlanMonitor

404

No such plan
Up 
post /plan/v2/{planId}/copy
(copyPlanV2)
Copy a plan whilst removing invalid project keys from original plan if any.

Path parameters

planId (required)
Path Parameter — Plan ID

Query parameters

copyCreatedTime (optional)
Query Parameter — Time at which plan's copy was created' format: int64

Return type

CopyPlanResponse

Example data

Content-Type: application/json
{
  "removedProjectKeys" : [ "removedProjectKeys", "removedProjectKeys" ],
  "planId" : "planId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Copied CopyPlanResponse

404

No such plan
Up 
delete /plan/{id}
(deletePlan)
Delete a plan

Path parameters

id (required)
Path Parameter — Plan ID

Responses

200

Deleted

404

No such plan
Up 
get /plan/{id}/logs
(getLogs)
Retrieve logs for a plan

Path parameters

id (required)
Path Parameter — Plan ID

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Logs retrieved byte[]

404

No such plan
Up 
get /plan/config/{id}
(getPlanConfiguration)
Retrieve a plan configuration

Path parameters

id (required)
Path Parameter — Plan ID

Return type

PlanConfig

Example data

Content-Type: application/json
{
  "planIds" : [ 0, 0 ],
  "cloudSite" : {
    "cloudUrl" : "cloudUrl",
    "cloudType" : "STANDARD",
    "cloudId" : "cloudId",
    "edition" : "free",
    "products" : [ {
      "edition" : "free",
      "usersCount" : 0,
      "productKey" : "confluence.ondemand"
    }, {
      "edition" : "free",
      "usersCount" : 0,
      "productKey" : "confluence.ondemand"
    } ]
  },
  "crossProjectBoardsAndFiltersMigrationOption" : {
    "crossProjectBoardsCount" : 1,
    "crossProjectFiltersCount" : 5,
    "boardsAndFiltersMigrationMode" : "ALL"
  },
  "assetsDataMigrationMode" : "ALL",
  "userPreMigration" : true,
  "migrationType" : "CLASSIC",
  "attachmentFilters" : {
    "systemAttributes" : [ null, null ]
  },
  "singlePathMode" : "PROJECT_BY_PROJECT",
  "dashboardsMigrationMode" : "ALL",
  "appsMigrationOption" : {
    "includedCloudApps" : [ "includedCloudApps", "includedCloudApps" ],
    "includedApps" : [ "includedApps", "includedApps" ],
    "preloadableApps" : [ "preloadableApps", "preloadableApps" ],
    "preload" : true,
    "migrate" : true,
    "excludedAppsRequested" : [ "excludedAppsRequested", "excludedAppsRequested" ]
  },
  "advancedRoadmapsMigrationOption" : {
    "advancedRoadmapsMigrationMode" : "ALL",
    "advancedRoadmapsPlansCount" : 5
  },
  "manualImportFile" : "manualImportFile",
  "liftAndShiftMode" : "AUTOMATIC",
  "migrateArchivedIssues" : true,
  "projectKeys" : [ "projectKeys", "projectKeys" ],
  "issueFilters" : {
    "systemAttributes" : [ {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "type" : "STATUS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    }, {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "type" : "STATUS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    } ],
    "customAttributes" : [ {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "name" : "name",
      "type" : "LABELS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    }, {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "name" : "name",
      "type" : "LABELS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    } ]
  },
  "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
  "createdTimestamp" : 6,
  "projectDataMigrationMode" : "NONE",
  "jiraDataMigrationOption" : {
    "attachmentsMigrationMode" : "ALL"
  },
  "preflightChecksToRun" : [ "TrustedDomains", "TrustedDomains" ],
  "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
  "planPhase" : "PREPARE_PLAN",
  "assetsSchemaKeys" : [ "assetsSchemaKeys", "assetsSchemaKeys" ],
  "forceRelinking" : true,
  "usersGroupsMigrationOption" : {
    "mode" : "ALL",
    "includeUsersInGroups" : true,
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "includeRoleActors" : true,
    "memberships" : true
  },
  "preflightCheckExecutionId" : "preflightCheckExecutionId",
  "excludedProjectKeys" : [ "excludedProjectKeys", "excludedProjectKeys" ],
  "name" : "name",
  "migrationTag" : "NOT_SPECIFIED",
  "isCustomFieldsDeleted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Config retrieved PlanConfig

404

No such plan
Up 
get /plan/{id}
(getPlanWithContentStatsAndStatus)
Retrieve a plan

Path parameters

id (required)
Path Parameter — Plan ID

Return type

PlanMonitor

Example data

Content-Type: application/json
{
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Plan retrieved PlanMonitor

404

No such plan
Up 
get /plan
(listPlans)
List all plans

Return type

PlanMonitor

Example data

Content-Type: application/json
{
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved PlanMonitor
Up 
get /plan/details/{id}
(planDetails)
Retrieve plan details

Path parameters

id (required)
Path Parameter — Plan ID

Query parameters

projectOffset (optional)
Query Parameter — Start of project list format: int32
projectLimit (optional)
Query Parameter — Number of projects format: int32

Return type

PlanDetails

Example data

Content-Type: application/json
{
  "usersGroupsMigrationOption" : {
    "mode" : "ALL",
    "includeUsersInGroups" : true,
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "includeRoleActors" : true,
    "memberships" : true
  },
  "appsMigrationOption" : {
    "includedCloudApps" : [ "includedCloudApps", "includedCloudApps" ],
    "includedApps" : [ "includedApps", "includedApps" ],
    "preloadableApps" : [ "preloadableApps", "preloadableApps" ],
    "preload" : true,
    "migrate" : true,
    "excludedAppsRequested" : [ "excludedAppsRequested", "excludedAppsRequested" ]
  },
  "stats" : {
    "attachments" : {
      "totalSizeBytes" : 0
    },
    "totalUsers" : 5,
    "totalCustomers" : 7,
    "totalDashboards" : 7,
    "totalObjectSchemas" : 1,
    "totalGroups" : 2,
    "projectStatsOf" : {
      "key" : {
        "totalProjects" : 9,
        "totalIssues" : 3
      }
    },
    "totalRapidViews" : 2,
    "totalMigrationTimeSeconds" : 6,
    "totalProjects" : 1,
    "totalFilters" : 4,
    "totalIssues" : 5,
    "totalObjects" : 1
  },
  "projectDataMigrationMode" : "NONE",
  "progress" : {
    "projects" : [ {
      "archived" : true,
      "projectKey" : "projectKey",
      "isArchived" : true,
      "projectType" : "projectType",
      "projectName" : "projectName",
      "taskStatus" : "SAVED_READY"
    }, {
      "archived" : true,
      "projectKey" : "projectKey",
      "isArchived" : true,
      "projectType" : "projectType",
      "projectName" : "projectName",
      "taskStatus" : "SAVED_READY"
    } ],
    "usersAndGroups" : {
      "groups" : {
        "total" : 4,
        "completionDetails" : "completionDetails",
        "successfullyCompleted" : 1,
        "additionalProperties" : {
          "key" : { }
        },
        "status" : "READY"
      },
      "taskStatus" : "SAVED_READY"
    },
    "preflightStatusResponse" : {
      "checks" : [ {
        "checkType" : "checkType",
        "numberOfOccurrences" : 7,
        "lastExecution" : 1,
        "link" : {
          "text" : "text",
          "url" : "url"
        },
        "executionErrorCode" : 6,
        "description" : "description",
        "details" : {
          "longDescription" : "longDescription",
          "listOfOccurrences" : [ { }, { } ],
          "info" : {
            "key" : { }
          }
        },
        "status" : "Running"
      }, {
        "checkType" : "checkType",
        "numberOfOccurrences" : 7,
        "lastExecution" : 1,
        "link" : {
          "text" : "text",
          "url" : "url"
        },
        "executionErrorCode" : 6,
        "description" : "description",
        "details" : {
          "longDescription" : "longDescription",
          "listOfOccurrences" : [ { }, { } ],
          "info" : {
            "key" : { }
          }
        },
        "status" : "Running"
      } ]
    },
    "paginatedProjects" : {
      "total" : 8,
      "projects" : [ null, null ],
      "offset" : 9,
      "limit" : 6
    },
    "crossProjectEntityProgress" : { },
    "overallStatus" : "SAVED",
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "apps" : [ {
      "serverAppName" : "serverAppName",
      "lastUpdatedAt" : 9,
      "cloudAppKey" : "cloudAppKey",
      "appVendorName" : "appVendorName",
      "serverAppKey" : "serverAppKey",
      "statusMessage" : "statusMessage",
      "notCancellableTooltip" : "notCancellableTooltip",
      "contactVendorUrl" : "contactVendorUrl",
      "isCancellable" : true,
      "completionPercent" : 5,
      "containerId" : "containerId",
      "multiTransfers" : [ {
        "lastUpdatedAt" : 6,
        "isCancellable" : true,
        "completionPercent" : 9,
        "transferId" : "transferId",
        "statusMessage" : "statusMessage",
        "notCancellableTooltip" : "notCancellableTooltip",
        "transferName" : "transferName",
        "status" : "status"
      }, {
        "lastUpdatedAt" : 6,
        "isCancellable" : true,
        "completionPercent" : 9,
        "transferId" : "transferId",
        "statusMessage" : "statusMessage",
        "notCancellableTooltip" : "notCancellableTooltip",
        "transferName" : "transferName",
        "status" : "status"
      } ],
      "isReadyToUse" : true,
      "status" : "status"
    }, {
      "serverAppName" : "serverAppName",
      "lastUpdatedAt" : 9,
      "cloudAppKey" : "cloudAppKey",
      "appVendorName" : "appVendorName",
      "serverAppKey" : "serverAppKey",
      "statusMessage" : "statusMessage",
      "notCancellableTooltip" : "notCancellableTooltip",
      "contactVendorUrl" : "contactVendorUrl",
      "isCancellable" : true,
      "completionPercent" : 5,
      "containerId" : "containerId",
      "multiTransfers" : [ {
        "lastUpdatedAt" : 6,
        "isCancellable" : true,
        "completionPercent" : 9,
        "transferId" : "transferId",
        "statusMessage" : "statusMessage",
        "notCancellableTooltip" : "notCancellableTooltip",
        "transferName" : "transferName",
        "status" : "status"
      }, {
        "lastUpdatedAt" : 6,
        "isCancellable" : true,
        "completionPercent" : 9,
        "transferId" : "transferId",
        "statusMessage" : "statusMessage",
        "notCancellableTooltip" : "notCancellableTooltip",
        "transferName" : "transferName",
        "status" : "status"
      } ],
      "isReadyToUse" : true,
      "status" : "status"
    } ],
    "projectAndAttachments" : [ {
      "progressDetails" : "progressDetails",
      "name" : "name",
      "progress" : "progress",
      "status" : "SAVED_READY"
    }, {
      "progressDetails" : "progressDetails",
      "name" : "name",
      "progress" : "progress",
      "status" : "SAVED_READY"
    } ],
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  },
  "projectAndAttachments" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Details retrieved PlanDetails

404

No such plan
Up 
get /plan/progress/{id}/details
(planDetailsProgress)
Retrieve plan details progress

Path parameters

id (required)
Path Parameter — Plan ID

Query parameters

projectOffset (optional)
Query Parameter — Start of project list format: int32
projectLimit (optional)
Query Parameter — Number of projects format: int32

Return type

PlanProgress

Example data

Content-Type: application/json
{
  "projects" : [ {
    "archived" : true,
    "projectKey" : "projectKey",
    "isArchived" : true,
    "projectType" : "projectType",
    "projectName" : "projectName",
    "taskStatus" : "SAVED_READY"
  }, {
    "archived" : true,
    "projectKey" : "projectKey",
    "isArchived" : true,
    "projectType" : "projectType",
    "projectName" : "projectName",
    "taskStatus" : "SAVED_READY"
  } ],
  "usersAndGroups" : {
    "groups" : {
      "total" : 4,
      "completionDetails" : "completionDetails",
      "successfullyCompleted" : 1,
      "additionalProperties" : {
        "key" : { }
      },
      "status" : "READY"
    },
    "taskStatus" : "SAVED_READY"
  },
  "preflightStatusResponse" : {
    "checks" : [ {
      "checkType" : "checkType",
      "numberOfOccurrences" : 7,
      "lastExecution" : 1,
      "link" : {
        "text" : "text",
        "url" : "url"
      },
      "executionErrorCode" : 6,
      "description" : "description",
      "details" : {
        "longDescription" : "longDescription",
        "listOfOccurrences" : [ { }, { } ],
        "info" : {
          "key" : { }
        }
      },
      "status" : "Running"
    }, {
      "checkType" : "checkType",
      "numberOfOccurrences" : 7,
      "lastExecution" : 1,
      "link" : {
        "text" : "text",
        "url" : "url"
      },
      "executionErrorCode" : 6,
      "description" : "description",
      "details" : {
        "longDescription" : "longDescription",
        "listOfOccurrences" : [ { }, { } ],
        "info" : {
          "key" : { }
        }
      },
      "status" : "Running"
    } ]
  },
  "paginatedProjects" : {
    "total" : 8,
    "projects" : [ null, null ],
    "offset" : 9,
    "limit" : 6
  },
  "crossProjectEntityProgress" : { },
  "overallStatus" : "SAVED",
  "singlePathMode" : "PROJECT_BY_PROJECT",
  "apps" : [ {
    "serverAppName" : "serverAppName",
    "lastUpdatedAt" : 9,
    "cloudAppKey" : "cloudAppKey",
    "appVendorName" : "appVendorName",
    "serverAppKey" : "serverAppKey",
    "statusMessage" : "statusMessage",
    "notCancellableTooltip" : "notCancellableTooltip",
    "contactVendorUrl" : "contactVendorUrl",
    "isCancellable" : true,
    "completionPercent" : 5,
    "containerId" : "containerId",
    "multiTransfers" : [ {
      "lastUpdatedAt" : 6,
      "isCancellable" : true,
      "completionPercent" : 9,
      "transferId" : "transferId",
      "statusMessage" : "statusMessage",
      "notCancellableTooltip" : "notCancellableTooltip",
      "transferName" : "transferName",
      "status" : "status"
    }, {
      "lastUpdatedAt" : 6,
      "isCancellable" : true,
      "completionPercent" : 9,
      "transferId" : "transferId",
      "statusMessage" : "statusMessage",
      "notCancellableTooltip" : "notCancellableTooltip",
      "transferName" : "transferName",
      "status" : "status"
    } ],
    "isReadyToUse" : true,
    "status" : "status"
  }, {
    "serverAppName" : "serverAppName",
    "lastUpdatedAt" : 9,
    "cloudAppKey" : "cloudAppKey",
    "appVendorName" : "appVendorName",
    "serverAppKey" : "serverAppKey",
    "statusMessage" : "statusMessage",
    "notCancellableTooltip" : "notCancellableTooltip",
    "contactVendorUrl" : "contactVendorUrl",
    "isCancellable" : true,
    "completionPercent" : 5,
    "containerId" : "containerId",
    "multiTransfers" : [ {
      "lastUpdatedAt" : 6,
      "isCancellable" : true,
      "completionPercent" : 9,
      "transferId" : "transferId",
      "statusMessage" : "statusMessage",
      "notCancellableTooltip" : "notCancellableTooltip",
      "transferName" : "transferName",
      "status" : "status"
    }, {
      "lastUpdatedAt" : 6,
      "isCancellable" : true,
      "completionPercent" : 9,
      "transferId" : "transferId",
      "statusMessage" : "statusMessage",
      "notCancellableTooltip" : "notCancellableTooltip",
      "transferName" : "transferName",
      "status" : "status"
    } ],
    "isReadyToUse" : true,
    "status" : "status"
  } ],
  "projectAndAttachments" : [ {
    "progressDetails" : "progressDetails",
    "name" : "name",
    "progress" : "progress",
    "status" : "SAVED_READY"
  }, {
    "progressDetails" : "progressDetails",
    "name" : "name",
    "progress" : "progress",
    "status" : "SAVED_READY"
  } ],
  "infraOptimisationProgress" : {
    "status" : "NOT_RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Details retrieved PlanProgress

404

No such plan
Up 
get /plan/progress/{id}
(planProgress)
Retrieve plan progress

Path parameters

id (required)
Path Parameter — Plan ID

Return type

MigrationStatus

Example data

Content-Type: application/json
{
  "coreStatus" : "SAVED_READY",
  "appStatus" : "READY",
  "overallStatus" : "SAVED",
  "infraOptimisationProgress" : {
    "status" : "NOT_RUNNING"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Progress retrieved MigrationStatus

404

No such plan
Up 
get /plan/{id}/projects
(planProjects)
Retrieve plan projects

Path parameters

id (required)
Path Parameter — Plan ID

Return type

ServerProjectDto

Example data

Content-Type: application/json
{
  "archived" : true,
  "attachments" : {
    "totalSizeBytes" : 0
  },
  "totalIssues" : 6,
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "isArchived" : true,
  "name" : "name",
  "migrationEstimateSeconds" : 1,
  "id" : 0,
  "type" : "type",
  "category" : "category",
  "key" : "key",
  "lead" : "lead"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Projects retrieved ServerProjectDto

404

No such plan
Up 
put /plan/{id}/restore
(restoreArchivedPlan)
Restore a plan

Path parameters

id (required)
Path Parameter — Plan ID

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response
Up 
post /plan/save-and-start
(saveAndStartPlan)
Save and start a plan

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PlanConfig (optional)
Body Parameter — Plan Configuration

Return type

PlanMonitor

Example data

Content-Type: application/json
{
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Saved PlanMonitor

400

Invalid data provided
Up 
post /plan/save
(savePlan)
Save a plan

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PlanConfig (optional)
Body Parameter — Plan Configuration

Return type

PlanMonitor

Example data

Content-Type: application/json
{
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Saved PlanMonitor

400

Invalid data provided
Up 
post /plan/{id}/cutover
(scheduleFinalIncrement)
Cutover an incremental plan

Path parameters

id (required)
Path Parameter — Plan ID

Responses

200

Retrieved

404

No such plan
Up 
post /plan/{id}/start
(startPlan)
Start a plan

Path parameters

id (required)
Path Parameter — Plan ID

Return type

PlanMonitor

Example data

Content-Type: application/json
{
  "migrationStatus" : {
    "coreStatus" : "SAVED_READY",
    "appStatus" : "READY",
    "overallStatus" : "SAVED",
    "infraOptimisationProgress" : {
      "status" : "NOT_RUNNING"
    }
  },
  "plan" : {
    "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
    "cloudSite" : {
      "cloudUrl" : "cloudUrl",
      "cloudType" : "STANDARD",
      "cloudId" : "cloudId",
      "edition" : "free",
      "products" : [ {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      }, {
        "edition" : "free",
        "usersCount" : 0,
        "productKey" : "confluence.ondemand"
      } ]
    },
    "crossProjectBoardsAndFiltersMigrationOption" : {
      "crossProjectBoardsCount" : 1,
      "crossProjectFiltersCount" : 5,
      "boardsAndFiltersMigrationMode" : "ALL"
    },
    "createdTimestamp" : 6,
    "assetsDataMigrationMode" : "ALL",
    "userPreMigration" : true,
    "planName" : "planName",
    "jiraDataMigrationOption" : {
      "attachmentsMigrationMode" : "ALL"
    },
    "migrationType" : "CLASSIC",
    "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
    "attachmentFilters" : {
      "systemAttributes" : [ null, null ]
    },
    "singlePathMode" : "PROJECT_BY_PROJECT",
    "dashboardsMigrationMode" : "ALL",
    "advancedRoadmapsMigrationOption" : {
      "advancedRoadmapsMigrationMode" : "ALL",
      "advancedRoadmapsPlansCount" : 5
    },
    "activeStatus" : "ACTIVE",
    "preflightCheckExecutionId" : "preflightCheckExecutionId",
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "manualImportFile" : "manualImportFile",
    "planId" : "planId",
    "liftAndShiftMode" : "AUTOMATIC",
    "migrateArchivedIssues" : true,
    "migrationTag" : "NOT_SPECIFIED",
    "jsdPlan" : true,
    "issueFilters" : {
      "systemAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "type" : "STATUS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ],
      "customAttributes" : [ {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      }, {
        "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
        "name" : "name",
        "type" : "LABELS",
        "value" : [ "value", "value" ],
        "operator" : "operator"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Started PlanMonitor

404

No such plan
Up 
put /plan/{id}/apps
(updatePlanApps)
Update a plan's apps from app assessment

Path parameters

id (required)
Path Parameter — Plan ID

Responses

200

Plan apps updated

404

No such plan
Up 
put /plan/config/{id}
(updatePlanConfiguration)
Update a plan configuration

Path parameters

id (required)
Path Parameter — Plan ID

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PlanConfig (optional)
Body Parameter — Plan Configuration

Return type

PlanConfig

Example data

Content-Type: application/json
{
  "planIds" : [ 0, 0 ],
  "cloudSite" : {
    "cloudUrl" : "cloudUrl",
    "cloudType" : "STANDARD",
    "cloudId" : "cloudId",
    "edition" : "free",
    "products" : [ {
      "edition" : "free",
      "usersCount" : 0,
      "productKey" : "confluence.ondemand"
    }, {
      "edition" : "free",
      "usersCount" : 0,
      "productKey" : "confluence.ondemand"
    } ]
  },
  "crossProjectBoardsAndFiltersMigrationOption" : {
    "crossProjectBoardsCount" : 1,
    "crossProjectFiltersCount" : 5,
    "boardsAndFiltersMigrationMode" : "ALL"
  },
  "assetsDataMigrationMode" : "ALL",
  "userPreMigration" : true,
  "migrationType" : "CLASSIC",
  "attachmentFilters" : {
    "systemAttributes" : [ null, null ]
  },
  "singlePathMode" : "PROJECT_BY_PROJECT",
  "dashboardsMigrationMode" : "ALL",
  "appsMigrationOption" : {
    "includedCloudApps" : [ "includedCloudApps", "includedCloudApps" ],
    "includedApps" : [ "includedApps", "includedApps" ],
    "preloadableApps" : [ "preloadableApps", "preloadableApps" ],
    "preload" : true,
    "migrate" : true,
    "excludedAppsRequested" : [ "excludedAppsRequested", "excludedAppsRequested" ]
  },
  "advancedRoadmapsMigrationOption" : {
    "advancedRoadmapsMigrationMode" : "ALL",
    "advancedRoadmapsPlansCount" : 5
  },
  "manualImportFile" : "manualImportFile",
  "liftAndShiftMode" : "AUTOMATIC",
  "migrateArchivedIssues" : true,
  "projectKeys" : [ "projectKeys", "projectKeys" ],
  "issueFilters" : {
    "systemAttributes" : [ {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "type" : "STATUS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    }, {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "type" : "STATUS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    } ],
    "customAttributes" : [ {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "name" : "name",
      "type" : "LABELS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    }, {
      "scopedProjects" : [ "scopedProjects", "scopedProjects" ],
      "name" : "name",
      "type" : "LABELS",
      "value" : [ "value", "value" ],
      "operator" : "operator"
    } ]
  },
  "pbpMigrationMode" : "CHOOSE_WHAT_TO_MIGRATE",
  "createdTimestamp" : 6,
  "projectDataMigrationMode" : "NONE",
  "jiraDataMigrationOption" : {
    "attachmentsMigrationMode" : "ALL"
  },
  "preflightChecksToRun" : [ "TrustedDomains", "TrustedDomains" ],
  "preflightChecksToOverride" : [ "TrustedDomains", "TrustedDomains" ],
  "planPhase" : "PREPARE_PLAN",
  "assetsSchemaKeys" : [ "assetsSchemaKeys", "assetsSchemaKeys" ],
  "forceRelinking" : true,
  "usersGroupsMigrationOption" : {
    "mode" : "ALL",
    "includeUsersInGroups" : true,
    "jsdCustomersMigrationOption" : {
      "mode" : "ALL"
    },
    "includeRoleActors" : true,
    "memberships" : true
  },
  "preflightCheckExecutionId" : "preflightCheckExecutionId",
  "excludedProjectKeys" : [ "excludedProjectKeys", "excludedProjectKeys" ],
  "name" : "name",
  "migrationTag" : "NOT_SPECIFIED",
  "isCustomFieldsDeleted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Config updated PlanConfig

404

No such plan
Up 
get /plan/validate
(validatePlanName)
Validate a plan

Query parameters

name (optional)
Query Parameter — Plan Name
planId (optional)
Query Parameter — Plan ID

Return type

Boolean

Example data

Content-Type: application/json
true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

default response Boolean

Models

[ Jump to Methods ]

Table of Contents

  1. AdvancedRoadmapsMigrationOption
  2. AppProgress
  3. AppsMigrationOption
  4. AttachmentFilters
  5. AttachmentStatsDto
  6. CheckDetailsDto
  7. CheckResultDto
  8. ChecksResultDto
  9. CloudProductInfo
  10. CloudSiteDto
  11. CopyPlanResponse
  12. CrossProjectBoardsAndFiltersMigrationOption
  13. CrossProjectEntityProgress
  14. CustomAttributeFilter
  15. EntityProgress
  16. GeneralTaskProgress
  17. InfraProgress
  18. IssueFilters
  19. JiraDataMigrationOption
  20. JsdCustomersMigrationOption
  21. LinkDto
  22. MigrationStatus
  23. MultiTransfer
  24. PaginatedProjectProgressDto
  25. PlanConfig
  26. PlanDetails
  27. PlanInfo
  28. PlanMonitor
  29. PlanProgress
  30. ProjectKeyList
  31. ProjectProgress
  32. ProjectTypeStatsDto
  33. ServerProjectDto
  34. StatsDto
  35. SystemAttributeFilter
  36. UsersAndGroupsProgress
  37. UsersGroupsMigrationOption

AdvancedRoadmapsMigrationOption Up

advancedRoadmapsMigrationMode (optional)
String
Enum:
ALL
NONE
SELECTED_PROJECTS
advancedRoadmapsPlansCount (optional)
Long format: int64

AppProgress Up

serverAppName (optional)
String
serverAppKey (optional)
String
cloudAppKey (optional)
String
completionPercent (optional)
Integer format: int32
isCancellable (optional)
Boolean
status (optional)
String
statusMessage (optional)
String
lastUpdatedAt (optional)
Long format: int64
appVendorName (optional)
String
contactVendorUrl (optional)
String
containerId (optional)
String
notCancellableTooltip (optional)
String
isReadyToUse (optional)
Boolean
multiTransfers (optional)
array[MultiTransfer]

AppsMigrationOption Up

migrate (optional)
Boolean
excludedAppsRequested (optional)
array[String]
includedApps (optional)
array[String]
includedCloudApps (optional)
array[String]
preload (optional)
Boolean
preloadableApps (optional)
array[String]

AttachmentFilters Up

systemAttributes (optional)
array[SystemAttributeFilter]

AttachmentStatsDto Up

totalSizeBytes (optional)
Long format: int64

CheckDetailsDto Up

longDescription (optional)
String
link (optional)
LinkDto
listOfOccurrences (optional)
array[Object]
info (optional)
map[String, Object]

CheckResultDto Up

checkType (optional)
String
status (optional)
String
Enum:
Running
Success
Error
Warning
ExecutionError
lastExecution (optional)
Long format: int64
executionErrorCode (optional)
Integer format: int32
description (optional)
String
numberOfOccurrences (optional)
Integer format: int32
link (optional)
LinkDto
details (optional)
CheckDetailsDto

ChecksResultDto Up

checks (optional)
array[CheckResultDto]

CloudProductInfo Up

productKey (optional)
String
Enum:
confluence.ondemand
jira-core.ondemand
jira-software.ondemand
jira-servicedesk.ondemand
edition (optional)
String
Enum:
free
standard
premium
usersCount (optional)
Integer format: int32

CloudSiteDto Up

cloudId (optional)
String
cloudUrl (optional)
String
edition (optional)
String
Enum:
free
standard
premium
products (optional)
array[CloudProductInfo]
cloudType (optional)
String
Enum:
STANDARD
FEDRAMP

CopyPlanResponse Up

planId (optional)
String
removedProjectKeys (optional)
array[String]

CrossProjectBoardsAndFiltersMigrationOption Up

boardsAndFiltersMigrationMode (optional)
String
Enum:
ALL
NONE
SELECTED_PROJECTS
crossProjectBoardsCount (optional)
Long format: int64
crossProjectFiltersCount (optional)
Long format: int64

CrossProjectEntityProgress Up

crossProjectRapidViewProgress (optional)
EntityProgress
crossProjectFiltersProgress (optional)
EntityProgress
dashboardsProgress (optional)
EntityProgress

CustomAttributeFilter Up

type (optional)
String
Enum:
LABELS
SELECT
MULTISELECT
VERSION
MULTICHECKBOXES
INVALID
name (optional)
String
operator (optional)
String
value (optional)
array[String]
scopedProjects (optional)
array[String]

EntityProgress Up

status (optional)
String
Enum:
READY
RUNNING_EXPORTING
RUNNING_MIGRATING
COMPLETE
INCOMPLETE
FAILED
SKIPPED
UNKNOWN
successfullyCompleted (optional)
Long format: int64
total (optional)
Long format: int64
completionDetails (optional)
String
additionalProperties (optional)
map[String, Object]

GeneralTaskProgress Up

name (optional)
String
status (optional)
String
Enum:
SAVED_READY
RUNNING
COMPLETE
UNKNOWN
INCOMPLETE
FAILED
progress (optional)
String
progressDetails (optional)
String

InfraProgress Up

status (optional)
String
Enum:
NOT_RUNNING
RUNNING

IssueFilters Up

systemAttributes (optional)
array[SystemAttributeFilter]
customAttributes (optional)
array[CustomAttributeFilter]

JiraDataMigrationOption Up

attachmentsMigrationMode (optional)
String
Enum:
ALL
NONE

JsdCustomersMigrationOption Up

mode (optional)
String
Enum:
ALL
REFERENCED
NONE

LinkDto Up

text (optional)
String
url (optional)
String

MigrationStatus Up

infraOptimisationProgress (optional)
InfraProgress
overallStatus (optional)
String
Enum:
SAVED
RUNNING
INCOMPLETE
FAILED
COMPLETE
UNKNOWN
appStatus (optional)
String
Enum:
READY
RUNNING
INCOMPLETE
FAILED
COMPLETE
NO_APPS
UNKNOWN
coreStatus (optional)
String
Enum:
SAVED_READY
SAVED_PREFLIGHT_ERROR
SAVED_INCOMPLETE
VALIDATING
RUNNING
INCOMPLETE
FAILED
COMPLETE
UNKNOWN

MultiTransfer Up

transferId (optional)
String
transferName (optional)
String
completionPercent (optional)
Integer format: int32
status (optional)
String
statusMessage (optional)
String
lastUpdatedAt (optional)
Long format: int64
isCancellable (optional)
Boolean
notCancellableTooltip (optional)
String

PaginatedProjectProgressDto Up

total (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
projects (optional)
array[ProjectProgress]

PlanConfig Up

name (optional)
String
projectKeys (optional)
array[String]
planIds (optional)
array[Long] format: int64
cloudSite (optional)
CloudSiteDto
usersGroupsMigrationOption (optional)
UsersGroupsMigrationOption
appsMigrationOption (optional)
AppsMigrationOption
projectDataMigrationMode (optional)
String
Enum:
NONE
ALL
CONFIG_ONLY
ATTACHMENTS_ONLY
ATTACHMENTS_ONLY_V2
MEDIA_UPLOAD_LINK
MEDIA_UPLOAD_ONLY
LIFT_AND_SHIFT
APP_DATA_PRELOAD
forceRelinking (optional)
Boolean
migrationType (optional)
String
Enum:
CLASSIC
INCREMENTAL
preflightCheckExecutionId (optional)
String
preflightChecksToRun (optional)
array[String]
Enum:
preflightChecksToOverride (optional)
array[String]
Enum:
isCustomFieldsDeleted (optional)
Boolean
createdTimestamp (optional)
Long format: int64
singlePathMode (optional)
String
Enum:
PROJECT_BY_PROJECT
LIFT_AND_SHIFT
migrationTag (optional)
String
Enum:
NOT_SPECIFIED
TEST
PROD
manualImportFile (optional)
String
liftAndShiftMode (optional)
String
Enum:
AUTOMATIC
MANUAL_EXPORT
MANUAL_IMPORT
jiraDataMigrationOption (optional)
JiraDataMigrationOption
crossProjectBoardsAndFiltersMigrationOption (optional)
CrossProjectBoardsAndFiltersMigrationOption
dashboardsMigrationMode (optional)
String
Enum:
ALL
NONE
SELECTED_PROJECTS
planPhase (optional)
String
Enum:
PREPARE_PLAN
MIGRATE
assetsSchemaKeys (optional)
array[String]
assetsDataMigrationMode (optional)
String
Enum:
ALL
NONE
SELECTED_PROJECTS
SCHEMA_BY_SCHEMA
userPreMigration (optional)
Boolean
migrateArchivedIssues (optional)
Boolean
pbpMigrationMode (optional)
String
Enum:
CHOOSE_WHAT_TO_MIGRATE
SELECT_ALL_DATA
excludedProjectKeys (optional)
array[String]
advancedRoadmapsMigrationOption (optional)
AdvancedRoadmapsMigrationOption
issueFilters (optional)
IssueFilters
attachmentFilters (optional)
AttachmentFilters

PlanDetails Up

plan (optional)
PlanInfo
usersGroupsMigrationOption (optional)
UsersGroupsMigrationOption
appsMigrationOption (optional)
AppsMigrationOption
projectDataMigrationMode (optional)
String
Enum:
NONE
ALL
CONFIG_ONLY
ATTACHMENTS_ONLY
ATTACHMENTS_ONLY_V2
MEDIA_UPLOAD_LINK
MEDIA_UPLOAD_ONLY
LIFT_AND_SHIFT
APP_DATA_PRELOAD
stats (optional)
StatsDto
progress (optional)
PlanProgress
migrationStatus (optional)
MigrationStatus
projectAndAttachments (optional)
array[GeneralTaskProgress]

PlanInfo Up

planId (optional)
String
planName (optional)
String
migrationType (optional)
String
Enum:
CLASSIC
INCREMENTAL
preflightCheckExecutionId (optional)
String
cloudSite (optional)
CloudSiteDto
preflightChecksToOverride (optional)
array[String]
Enum:
jsdPlan (optional)
Boolean
activeStatus (optional)
String
Enum:
ACTIVE
ARCHIVED
createdTimestamp (optional)
Long format: int64
singlePathMode (optional)
String
Enum:
PROJECT_BY_PROJECT
LIFT_AND_SHIFT
migrationTag (optional)
String
Enum:
NOT_SPECIFIED
TEST
PROD
manualImportFile (optional)
String
liftAndShiftMode (optional)
String
Enum:
AUTOMATIC
MANUAL_EXPORT
MANUAL_IMPORT
jiraDataMigrationOption (optional)
JiraDataMigrationOption
crossProjectBoardsAndFiltersMigrationOption (optional)
CrossProjectBoardsAndFiltersMigrationOption
assetsDataMigrationMode (optional)
String
Enum:
ALL
NONE
SELECTED_PROJECTS
SCHEMA_BY_SCHEMA
userPreMigration (optional)
Boolean
jsdCustomersMigrationOption (optional)
JsdCustomersMigrationOption
migrateArchivedIssues (optional)
Boolean
dashboardsMigrationMode (optional)
String
Enum:
ALL
NONE
SELECTED_PROJECTS
pbpMigrationMode (optional)
String
Enum:
CHOOSE_WHAT_TO_MIGRATE
SELECT_ALL_DATA
advancedRoadmapsMigrationOption (optional)
AdvancedRoadmapsMigrationOption
issueFilters (optional)
IssueFilters
attachmentFilters (optional)
AttachmentFilters

PlanMonitor Up

plan (optional)
PlanInfo
migrationStatus (optional)
MigrationStatus

PlanProgress Up

overallStatus (optional)
String
Enum:
SAVED
RUNNING
INCOMPLETE
FAILED
COMPLETE
UNKNOWN
preflightStatusResponse (optional)
ChecksResultDto
usersAndGroups (optional)
UsersAndGroupsProgress
projects (optional)
array[ProjectProgress]
advancedRoadmapsPlanProgress (optional)
EntityProgress
crossProjectEntityProgress (optional)
CrossProjectEntityProgress
apps (optional)
array[AppProgress]
paginatedProjects (optional)
PaginatedProjectProgressDto
projectAndAttachments (optional)
array[GeneralTaskProgress]
singlePathMode (optional)
String
Enum:
PROJECT_BY_PROJECT
LIFT_AND_SHIFT
infraOptimisationProgress (optional)
InfraProgress

ProjectKeyList Up

projectKeys (optional)
array[String]

ProjectProgress Up

taskStatus (optional)
String
Enum:
SAVED_READY
RUNNING
COMPLETE
UNKNOWN
INCOMPLETE
FAILED
projectName (optional)
String
projectKey (optional)
String
projectType (optional)
String
isArchived (optional)
Boolean
projectData (optional)
EntityProgress
attachments (optional)
EntityProgress
preloadedAppData (optional)
EntityProgress
archived (optional)
Boolean

ProjectTypeStatsDto Up

totalProjects (optional)
Long format: int64
totalIssues (optional)
Long format: int64
attachments (optional)
AttachmentStatsDto

ServerProjectDto Up

id (optional)
Long format: int64
key (optional)
String
name (optional)
String
totalIssues (optional)
Long format: int64
lastActive (optional)
Date format: date-time
attachments (optional)
AttachmentStatsDto
migrationEstimateSeconds (optional)
Long format: int64
type (optional)
String
category (optional)
String
lead (optional)
String
isArchived (optional)
Boolean
archived (optional)
Boolean

StatsDto Up

attachments (optional)
AttachmentStatsDto
totalMigrationTimeSeconds (optional)
Long format: int64
totalProjects (optional)
Integer format: int32
totalIssues (optional)
Long format: int64
totalUsers (optional)
Long format: int64
totalGroups (optional)
Long format: int64
totalCustomers (optional)
Long format: int64
projectStatsOf (optional)
map[String, ProjectTypeStatsDto]
totalRapidViews (optional)
Long format: int64
totalFilters (optional)
Long format: int64
totalDashboards (optional)
Long format: int64
totalObjectSchemas (optional)
Long format: int64
totalObjects (optional)
Long format: int64

SystemAttributeFilter Up

type (optional)
String
Enum:
STATUS
CREATORACTIVE
ISSUECREATEDDATE
ATTACHMENTCREATEDDATE
ATTACHMENTSIZE
ARCHIVEDSTATUS
ISSUELABELS
operator (optional)
String
value (optional)
array[String]
scopedProjects (optional)
array[String]

UsersAndGroupsProgress Up

taskStatus (optional)
String
Enum:
SAVED_READY
RUNNING
COMPLETE
UNKNOWN
INCOMPLETE
FAILED
groups (optional)
EntityProgress
users (optional)
EntityProgress
jsdCustomers (optional)
EntityProgress
memberships (optional)
EntityProgress

UsersGroupsMigrationOption Up

mode (optional)
String
Enum:
ALL
REFERENCED
NONE
memberships (optional)
Boolean
includeUsersInGroups (optional)
Boolean
includeRoleActors (optional)
Boolean
jsdCustomersMigrationOption (optional)
JsdCustomersMigrationOption