Jump to

• Request
• Response
• Examples

Get All Migration Package Content

get

/rest/v19/migrationPackages/{identifier}/contents

This endpoint retrieves all content within a migration package.

Request

Path Parameters

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

Query Parameters

• 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

Migration package content information

Body ()

Root Schema : migrationContent-collection

Type: object

Show Source

• items: array Migration resources list
  Title: Migration resources list

  List of migration resources
• links: array Migration Package Links
  Title: Migration Package Links

  Links for Migration Package Contents. These links contains self and parent link

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of migration resources",
            "title":"Migration resources list",
            "items":{
                "$ref":"#/definitions/migrationContent"
            }
        },
        "links":{
            "type":"array",
            "description":"Links for Migration Package Contents. These links contains self and parent link",
            "title":"Migration Package Links",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

Nested Schema : Migration resources list

Type: array

Title: Migration resources list

List of migration resources

Show Source

• Array of: object migrationContent
  Low-level details

{
    "type":"array",
    "description":"List of migration resources",
    "title":"Migration resources list",
    "items":{
        "$ref":"#/definitions/migrationContent"
    }
}

Nested Schema : Migration Package Links

Type: array

Title: Migration Package Links

Links for Migration Package Contents. These links contains self and parent link

Show Source

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

{
    "type":"array",
    "description":"Links for Migration Package Contents. These links contains self and parent link",
    "title":"Migration Package Links",
    "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"
}

Back to Top

Examples

The following example shows how to get all migration resources for an existing migration package by submitting a GET 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/migrationPackage_v1/contents

Response Body Sample

{
  "items": [{
      "name": "Configuration",
      "category": "CONFIGURATION",
      "children": [{
          "name": "Integration",
          "variableName": "integration",
          "resourceType": "product_family_configuration"
        }
      ]
    }, {
      "name": "Commerce",
      "category": "COMMERCE",
      "children": [{
          "name": "Test",
          "variableName": "test",
          "resourceType": "process"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/migrationPackages/migrationPackage_v1/contents"
    }, {
      "rel": "parent",
      "href": "http://sitename.oracle.com/rest/v19/migrationPackages/migrationPackage_v1"
    }
  ]
}
     

Back to Top