REST API Services for Oracle CPQ

Get List of Migration Packages

get

/rest/v16/migrationPackages

Use this endpoint to retrieve a list of migration packages.

Request

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.
orderby: string

Specifies a comma-separated list of pairs to order the response by.
q: string

Declares a query expression to specify filtering criteria. By default, no filtering is applied.

Response

Supported Media Types

application/json

Default Response

All Migration Packages Information

Root Schema : migrationPackage-collection

Type: object

Show Source

items: array Migration Packages list

Title: Migration Packages list

List of Migration Packages

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Migration Packages",
            "title":"Migration Packages list",
            "items":{
                "$ref":"#/definitions/migrationPackageContent"
            }
        }
    }
}

Nested Schema : Migration Packages list

Type: array

Title: Migration Packages list

List of Migration Packages

Show Source

Array of: object migrationPackageContent

{
    "type":"array",
    "description":"List of Migration Packages",
    "title":"Migration Packages list",
    "items":{
        "$ref":"#/definitions/migrationPackageContent"
    }
}

Nested 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
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
siteVersion: string

Title: siteVersion

Site version. This field is only applicable if retrieveFromPackageZip is set as true
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"
        },
        "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 Package Contents Name

Name is an optional field in Request Payload
resourceType: string

Title: Migration Package node name

resourceType refers the node
variableName: string

Title: Migration Package Content Child VarName

variableName refers the child varname

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name is an optional field in Request Payload",
            "title":"Migration Package Contents Name"
        },
        "variableName":{
            "type":"string",
            "description":"variableName refers the child varname",
            "title":"Migration Package Content Child VarName"
        },
        "resourceType":{
            "type":"string",
            "description":"resourceType refers the node",
            "title":"Migration Package node name"
        },
        "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"
        }
    }
}

Examples

The following example shows how to get a list of migration packages by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

>curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/migrationPackages

Response Body Sample

{
  "items": [{
      "name": "Migration Package",
      "identifier": "migrationPackage_v12",
      "version": 1,
      "dateAdded": "2020-04-17T14:10:20.000Z",
      "dateModified": "2020-04-17T14:10:20.000Z",
      "dependencies": {
        "items": []
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/migrationPackages/migrationPackage_v12"
        }
      ]
    }, {
      "name": "ABO Utilities",
      "identifier": "aBOUtilities_v12",
      "version": 1,
      "dateAdded": "2020-04-17T14:11:12.000Z",
      "dateModified": "2020-04-17T14:11:12.000Z",
      "dependencies": {
        "items": []
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/migrationPackages/aBOUtilities_v12"
        }
      ]
    }, {
      "name": "Migration Package",
      "identifier": "migrationPackage_v12",
      "version": 2,
      "dateRelease": "2020-04-17T05:00:00.000Z",
      "dateAdded": "2020-04-17T14:12:52.000Z",
      "dateModified": "2020-04-17T14:14:10.000Z",
      "dependencies": {
        "items": [{
            "name": "ABO Utilities",
            "version": 1
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/migrationPackages/migrationPackage_v12"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/migrationPackages"
    }
  ]
}