Jump to

• Request
• Response
• Examples

Upload Zip File for a Migration Package

post

/rest/v19/migrationPackages/actions/uploadPackage

This endpoint uploads a ZIP file to the server.

Request

Supported Media Types

• multipart/form-data

Form Parameters

• file(required): file
  Migration Package zip file.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Upload package response

Body ()

Root Schema : migrationPackage-uploadPackageResponse

Type: object

Show Source

• crossProcessMigrationEnabled: boolean
  Title: crossProcessMigrationEnabled

  Uploaded package is eligible for cross process migration
• dateAdded: string
  Title: dateAdded

  Date Added of the Migration Package
• dateModified: string
  Title: dateModified

  Date Modified of the Migration Package
• dateRelease: string
  Title: dateRelease

  Date Release of the Migration Package
• dependencies: object Migration Package Dependencies
  Title: Migration Package Dependencies

  Dependent Packages for the Migration Package
• description: string
  Title: description

  Description of the Migration Package
• identifier: string
  Title: identifier

  Unique Identifier for the Migration Package
• links: array Migration Package Links
  Title: Migration Package Links

  Links for the Migration Package
• name: string
  Title: name

  Name of the Migration Package
• packageTransformationTask: array Package transforamtion info
  Title: Package transforamtion info

  Package Transformation taskId and status link (This field applicable only in upload package response)
• siteVersion: string
  Title: siteVersion

  Site version
• uploadedPackageIdentifer: string
  Title: uploadedPackageIdentifer

  Server location of uploaded zip
• uploadStatus: string
  Title: uploadStatus

  Package transformation status
• version: integer
  Title: version

  Version of the Migration Package

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Migration Package",
            "title":"name"
        },
        "identifier":{
            "type":"string",
            "description":"Unique Identifier for the Migration Package",
            "title":"identifier"
        },
        "description":{
            "type":"string",
            "description":"Description of the Migration Package",
            "title":"description"
        },
        "version":{
            "type":"integer",
            "description":"Version of the Migration Package",
            "title":"version"
        },
        "dateRelease":{
            "type":"string",
            "description":"Date Release of the Migration Package",
            "title":"dateRelease"
        },
        "dateAdded":{
            "type":"string",
            "description":"Date Added of the Migration Package",
            "title":"dateAdded"
        },
        "dateModified":{
            "type":"string",
            "description":"Date Modified of the Migration Package",
            "title":"dateModified"
        },
        "siteVersion":{
            "type":"string",
            "description":"Site version",
            "title":"siteVersion"
        },
        "uploadedPackageIdentifer":{
            "type":"string",
            "description":"Server location of uploaded zip",
            "title":"uploadedPackageIdentifer"
        },
        "crossProcessMigrationEnabled":{
            "type":"boolean",
            "description":"Uploaded package is eligible for cross process migration",
            "title":"crossProcessMigrationEnabled"
        },
        "uploadStatus":{
            "type":"string",
            "description":"Package transformation status",
            "title":"uploadStatus"
        },
        "dependencies":{
            "type":"object",
            "description":"Dependent Packages for the Migration Package",
            "title":"Migration Package Dependencies",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of Dependencies for Migration Package",
                    "title":"Migration Package Dependencies list",
                    "items":{
                        "$ref":"#/definitions/migrationPackageDependency"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links for the Migration Package",
            "title":"Migration Package Links",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        },
        "packageTransformationTask":{
            "type":"array",
            "description":"Package Transformation taskId and status link (This field applicable only in upload package response)",
            "title":"Package transforamtion info",
            "items":{
                "$ref":"#/definitions/taskDetails"
            }
        }
    }
}

Nested Schema : Migration Package Dependencies

Type: object

Title: Migration Package Dependencies

Dependent Packages for the Migration Package

Show Source

• items: array Migration Package Dependencies list
  Title: Migration Package Dependencies list

  List of Dependencies for Migration Package

{
    "type":"object",
    "description":"Dependent Packages for the Migration Package",
    "title":"Migration Package Dependencies",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Dependencies for Migration Package",
            "title":"Migration Package Dependencies list",
            "items":{
                "$ref":"#/definitions/migrationPackageDependency"
            }
        }
    }
}

Nested Schema : Migration Package Links

Type: array

Title: Migration Package Links

Links for the Migration Package

Show Source

• Array of: object referenceLinks
  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links for the Migration Package",
    "title":"Migration Package Links",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : Package transforamtion info

Type: array

Title: Package transforamtion info

Package Transformation taskId and status link (This field applicable only in upload package response)

Show Source

• Array of: object Task details
  Title: Task details

  Task details

{
    "type":"array",
    "description":"Package Transformation taskId and status link (This field applicable only in upload package response)",
    "title":"Package transforamtion info",
    "items":{
        "$ref":"#/definitions/taskDetails"
    }
}

Nested Schema : Migration Package Dependencies list

Type: array

Title: Migration Package Dependencies list

List of Dependencies for Migration Package

Show Source

• Array of: object migrationPackageDependency

{
    "type":"array",
    "description":"List of Dependencies for Migration Package",
    "title":"Migration Package Dependencies list",
    "items":{
        "$ref":"#/definitions/migrationPackageDependency"
    }
}

Nested Schema : migrationPackageDependency

Type: object

Show Source

• name(required): string
  Title: name

  Name of the Migration Package
• version(required): integer
  Title: version

  Version of the Migration Package

{
    "type":"object",
    "required":[
        "name",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Migration Package",
            "title":"name"
        },
        "version":{
            "type":"integer",
            "description":"Version of the Migration Package",
            "title":"version"
        }
    }
}

Nested Schema : referenceLinks

Type: object

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : Task details

Type: object

Title: Task details

Task details

Show Source

• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• taskId: integer
  Title: Task Id

  Task Id

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"Task Id",
            "title":"Task Id"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Task details",
    "description":"Task details"
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example shows how to upload a migration package ZIP file to the server by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/migrationPackages/actions/uploadPackage

Response Body Sample

{
  "name": "MigrationPackage",
  "identifier": "migrationPackage_v11",
  "version": 11,
  "dateModified": "2023-05-27T02:29:48.000Z",
  "uploadedPackageIdentifer": "MigrationPackage_111665383246705",
  "siteVersion": "22.3.0",
  "validCPM": false,
  "dependencies": {},
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/migrationPackages/TestPackage_111665383246705?retrieveFromPkgZip=true"
    }, {
      "rel": "child",
      "href": "http://sitename.oracle.com/rest/v19/migrationPackages/TestPackage_111665383246705/contents?retrieveFromPkgZip=true"
    }
  ]
}

Sample curl -H "Authorization: Bearer <token>" Command

curl -H "Authorization: Bearer <token>" --request POST
'https://sitename.oracle.com/rest/v19/migrationPackages/actions/uploadPackage' \
  \
 \
--form 'file=@/D:/MigrationPackage_2.zip

Back to Top