Jump to

• Request
• Response
• Examples

Get Migration Package Properties

get

/rest/v19/migrationPackages/{identifier}

This endpoint retrieves the properties for the specified migration package.

Request

Path Parameters

• identifier(required): string
  The unique identifier of the package the user wants to fetch.

Query Parameters

• expand: string
  Expand the child content.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• retrieveFromPackageZip: boolean
  To fetch uploaded package content.
• targetProcessVarName: string
  Cross process migration variable name.This field is only applicable if retrieveFromPackageZip is set as true.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Package information

Body ()

Root Schema : migrationPackageContent

Type: object

Show Source

• contents: object Migration Package Content
  Title: Migration Package Content

  Contents populate, when expand=contents or expand=all.
• crossProcessMigrationEnabled: boolean
  Title: crossProcessMigrationEnabled

  Uploaded package is eligible cross process migration. This field is only applicable if retrieveFromPackageZip is set as true.
• 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
• installedVersionOnTarget: integer
  Title: installedVersionOnTarget

  if package available in resource with same name. This field is only applicable if retrieveFromPackageZip is set as true
• isImported: boolean
  Title: isImported

  The package is created in the local or imported package
• lastModifiedUser: string
  Title: lastModifiedUser

  The last modified user of Package
• links: array Migration Package Links
  Title: Migration Package Links

  shows self and child content links
• multipleDuplicatePkgs: boolean
  Title: multipleDuplicatePkgs

  If more than one package available in resource with same name. This field is only applicable if retrieveFromPackageZip is set as true.
• name: string
  Title: name

  Name of the Migration Package
• owner: string
  Title: owner

  The user name package was created.
• siteVersion: string
  Title: siteVersion

  Site version. This field is only applicable if retrieveFromPackageZip is set as true
• sourceSiteUrl: string
  Title: sourceSiteUrl

  The site name of the package was created
• uploadedPackageIdentifer: string
  Title: uploadedPackageIdentifer

  Server location of uploaded zip. This field is only applicable if retrieveFromPackageZip is set as true.
• version: integer
  Title: version

  Version of the Migration Package

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Migration Package",
            "title":"name"
        },
        "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"
        },
        "owner":{
            "type":"string",
            "description":"The user name package was created.",
            "title":"owner"
        },
        "lastModifiedUser":{
            "type":"string",
            "description":"The last modified user of Package",
            "title":"lastModifiedUser"
        },
        "sourceSiteUrl":{
            "type":"string",
            "description":"The site name of the package was created",
            "title":"sourceSiteUrl"
        },
        "isImported":{
            "type":"boolean",
            "description":"The package is created in the local or imported package",
            "title":"isImported"
        },
        "identifier":{
            "type":"string",
            "description":"Unique Identifier for the Migration Package",
            "title":"identifier"
        },
        "installedVersionOnTarget":{
            "type":"integer",
            "description":"if package available in resource with same name. This field is only applicable if retrieveFromPackageZip is set as true",
            "title":"installedVersionOnTarget"
        },
        "siteVersion":{
            "type":"string",
            "description":"Site version. This field is only applicable if retrieveFromPackageZip is set as true",
            "title":"siteVersion"
        },
        "uploadedPackageIdentifer":{
            "type":"string",
            "description":"Server location of uploaded zip. This field is only applicable if retrieveFromPackageZip is set as true.",
            "title":"uploadedPackageIdentifer"
        },
        "multipleDuplicatePkgs":{
            "type":"boolean",
            "description":"If more than one package available in resource with same name. This field is only applicable if retrieveFromPackageZip is set as true.",
            "title":"multipleDuplicatePkgs"
        },
        "crossProcessMigrationEnabled":{
            "type":"boolean",
            "description":"Uploaded package is eligible cross process migration. This field is only applicable if retrieveFromPackageZip is set as true.",
            "title":"crossProcessMigrationEnabled"
        },
        "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":"shows self and child content links",
            "title":"Migration Package Links",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        },
        "contents":{
            "type":"object",
            "description":"Contents populate, when expand=contents or expand=all.",
            "title":"Migration Package Content",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"Migration package contents",
                    "title":"This is list of migration package contents",
                    "items":{
                        "$ref":"#/definitions/migrationContent"
                    }
                },
                "links":{
                    "type":"array",
                    "description":"shows self and parent links",
                    "title":"Links for Migration Package Contents",
                    "items":{
                        "$ref":"#/definitions/referenceLinks"
                    }
                }
            }
        }
    }
}

Nested Schema : Migration Package Content

Type: object

Title: Migration Package Content

Contents populate, when expand=contents or expand=all.

Show Source

• items: array This is list of migration package contents
  Title: This is list of migration package contents

  Migration package contents
• links: array Links for Migration Package Contents
  Title: Links for Migration Package Contents

  shows self and parent links

{
    "type":"object",
    "description":"Contents populate, when expand=contents or expand=all.",
    "title":"Migration Package Content",
    "properties":{
        "items":{
            "type":"array",
            "description":"Migration package contents",
            "title":"This is list of migration package contents",
            "items":{
                "$ref":"#/definitions/migrationContent"
            }
        },
        "links":{
            "type":"array",
            "description":"shows self and parent links",
            "title":"Links for Migration Package Contents",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

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

shows self and child content links

Show Source

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

{
    "type":"array",
    "description":"shows self and child content links",
    "title":"Migration Package Links",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : This is list of migration package contents

Type: array

Title: This is list of migration package contents

Migration package contents

Show Source

• Array of: object migrationContent
  Low-level details

{
    "type":"array",
    "description":"Migration package contents",
    "title":"This is list of migration package contents",
    "items":{
        "$ref":"#/definitions/migrationContent"
    }
}

Nested Schema : Links for Migration Package Contents

Type: array

Title: Links for Migration Package Contents

shows self and parent links

Show Source

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

{
    "type":"array",
    "description":"shows self and parent links",
    "title":"Links for Migration Package Contents",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : migrationContent

Type: object

Low-level details

Show Source

• category: string
  Title: Migration Package Contents Category

  It's a category of migration contents
• children: array List of children contents
  Title: List of children contents

  List of children contents
• name: string
  Title: Migration Package Contents Name

  Name is an optional field in the request payload

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name is an optional field in the request payload",
            "title":"Migration Package Contents Name"
        },
        "category":{
            "type":"string",
            "description":"It's a category of migration contents",
            "title":"Migration Package Contents Category"
        },
        "children":{
            "type":"array",
            "description":"List of children contents",
            "title":"List of children contents",
            "items":{
                "$ref":"#/definitions/migrationContent-children"
            }
        }
    },
    "description":"Low-level details"
}

Nested Schema : List of children contents

Type: array

Title: List of children contents

List of children contents

Show Source

• Array of: object migrationContent-children
  Migration Resource children contents

{
    "type":"array",
    "description":"List of children contents",
    "title":"List of children contents",
    "items":{
        "$ref":"#/definitions/migrationContent-children"
    }
}

Nested Schema : migrationContent-children

Type: object

Migration Resource children contents

Show Source

• granular: boolean
  Title: granular

  If true, the resource has low-level details
• links: array Category Migration Resource Links
  Title: Category Migration Resource Links

  Links for Category Migration Package Contents low-level details. These links contains related link (This links populate only when granular=true)
• name: string
  Title: Migration Resource Child Name

  Name is an optional field in Request Payload
• resourceType: string
  Title: Migration Package node name

  resourceType refers to the node type
• resourceTypeLabel: string
  Title: Migration Resource Type Label

  resourceTypeLabel refers the node type label
• variableName: string
  Title: Migration Resource Child VarName

  variable name refers the child varname

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name is an optional field in Request Payload",
            "title":"Migration Resource Child Name"
        },
        "variableName":{
            "type":"string",
            "description":"variable name refers the child varname",
            "title":"Migration Resource Child VarName"
        },
        "resourceType":{
            "type":"string",
            "description":"resourceType refers to the node type",
            "title":"Migration Package node name"
        },
        "resourceTypeLabel":{
            "type":"string",
            "description":"resourceTypeLabel refers the node type label",
            "title":"Migration Resource Type Label"
        },
        "granular":{
            "type":"boolean",
            "description":"If true, the resource has low-level details",
            "title":"granular"
        },
        "links":{
            "type":"array",
            "description":"Links for Category Migration Package Contents low-level details. These links contains related link (This links populate only when granular=true)",
            "title":"Category Migration Resource Links",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "description":"Migration Resource children contents"
}

Nested Schema : Category Migration Resource Links

Type: array

Title: Category Migration Resource Links

Links for Category Migration Package Contents low-level details. These links contains related link (This links populate only when granular=true)

Show Source

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

{
    "type":"array",
    "description":"Links for Category Migration Package Contents low-level details. These links contains related link (This links populate only when granular=true)",
    "title":"Category Migration Resource Links",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

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 : 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"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve properties for the specified migration package by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/migrationPackages/migrationPackage_v12

Response Body Sample

{
  "name": "Migration Package",
  "identifier": "migrationPackage_v12",
  "version": 2,
  "dateAdded": "2020-04-15T21:01:57.000Z",
  "dateModified": "2020-04-15T21:01:57.000Z",
  "dependencies": {
    "items": []
  },
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/migrationPackages/migrationPackage_v12"
    }
  ]
}
    

Back to Top