Jump to

• Request
• Response
• Examples

Get Migration Package Resource Low-level Details

get

/rest/v16/migrationPackages/{identifier}/contents/{category}/{variableName}

Use this endpoint to retrieve low-level details of a migration resource within a specific category of a migration package.

Request

Path Parameters

• category(required): string
  Migration category for which the user wants to fetch the low-level details.
• identifier(required): string
  The unique identifier of the package the user wants to fetch
• variableName(required): string
  Variable Name of the migration category resource for which the user wants to fetch the low-level details.

Query Parameters

• retrieveFromPackageZip: boolean
  Flag to determine if contents must be fetched from the uploaded zip file. If true, the uploaded package identifier should be passed as a path parameter.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Package content low-level detail response.

Body ()

Root Schema : migration-lowLevelResponse

Type: object

Show Source

• children: array Migration resources low-level details Children
  Title: Migration resources low-level details Children

  Migration resources low-level details children
• lastModified: string
  Title: lastModified

  The last modified date, in a presentable string format. Used in the tree for this object
• links: array Migration resources low-level details links
  Title: Migration resources low-level details links

  shows self and parent links
• modifiedByUser: string
  Title: modifiedByUser

  The modifiedByUser used in the tree for this object
• name: string
  Title: name

  The name used in the tree for this object.
• variableName: string
  Title: variableName

  The variableName used in the tree for this object

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name used in the tree for this object.",
            "title":"name"
        },
        "variableName":{
            "type":"string",
            "description":"The variableName used in the tree for this object",
            "title":"variableName"
        },
        "lastModified":{
            "type":"string",
            "description":"The last modified date, in a presentable string format. Used in the tree for this object",
            "title":"lastModified"
        },
        "modifiedByUser":{
            "type":"string",
            "description":"The modifiedByUser used in the tree for this object",
            "title":"modifiedByUser"
        },
        "children":{
            "type":"array",
            "description":"Migration resources low-level details children",
            "title":"Migration resources low-level details Children",
            "items":{
                "$ref":"#/definitions/migrationPackageLowLevelDetails-children"
            }
        },
        "links":{
            "type":"array",
            "description":"shows self and parent links",
            "title":"Migration resources low-level details links",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

Nested Schema : Migration resources low-level details Children

Type: array

Title: Migration resources low-level details Children

Migration resources low-level details children

Show Source

• Array of: object migrationPackageLowLevelDetails-children

{
    "type":"array",
    "description":"Migration resources low-level details children",
    "title":"Migration resources low-level details Children",
    "items":{
        "$ref":"#/definitions/migrationPackageLowLevelDetails-children"
    }
}

Nested Schema : Migration resources low-level details links

Type: array

Title: Migration resources low-level details links

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":"Migration resources low-level details links",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : migrationPackageLowLevelDetails-children

Type: object

Show Source

• lastModified: string
  Title: lastModified

  The last modified date, in a presentable string format. Used in the tree for this object.
• modifiedByUser: string
  Title: modifiedByUser

  The modifiedByUser used in the tree for this object
• name: string
  Title: name

  The name used in the tree for this object.
• resourceType: string
  Title: resourceType

  This field represents the type of resource.
• variableName: string
  Title: variableName

  This field represents the variableName of the resource.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name used in the tree for this object.",
            "title":"name"
        },
        "variableName":{
            "type":"string",
            "description":"This field represents the variableName of the resource.",
            "title":"variableName"
        },
        "resourceType":{
            "type":"string",
            "description":"This field represents the type of resource.",
            "title":"resourceType"
        },
        "lastModified":{
            "type":"string",
            "description":"The last modified date, in a presentable string format. Used in the tree for this object.",
            "title":"lastModified"
        },
        "modifiedByUser":{
            "type":"string",
            "description":"The modifiedByUser used in the tree for this object",
            "title":"modifiedByUser"
        }
    }
}

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 low-level details of a migration resource within a specific category of a migration package by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/migrationPackages/migrationPackage_v1/contents/configuration/admin

Response Body Sample

{
  "name": "All Product Family",
  "variableName": "admin",
  "children": [{
      "name": "Bill Country",
      "variableName": "CRM_BILL_COUNTRY",
      "resourceType": "attribute",
      "modifiedByUser": "superuser",
      "lastModified": "05/15/2019 1:18 PM"
    }, {
      "name": "Admin (Product Family)",
      "variableName": "admin",
      "resourceType": "product_family",
      "modifiedByUser": "sam",
      "lastModified": "03/26/2021 10:04 AM",
      "children": [{
          "name": "Name",
          "variableName": "_bm_model_name",
          "resourceType": "attribute",
          "lastModified": "03/26/2021 10:04 AM"
        }, {
          "name": "Line",
          "variableName": "line",
          "resourceType": "product_line",
          "modifiedByUser": "Automation_JET_UserType_FullAccess",
          "lastModified": "02/21/2018 12:58 PM",
          "children": [{
              "name": "Test Model",
              "variableName": "model",
              "resourceType": "model",
              "modifiedByUser": "Automation_JET_UserType_FullAccess",
              "lastModified": "06/15/2017 3:04 PM"
            }
          ]
        }
      ]
    }, {
      "name": "All PF Level (Recommendation)",
      "variableName": "allPFLevel",
      "resourceType": "rule",
      "modifiedByUser": "sam",
      "lastModified": "05/03/2023 10:56 AM"
    }
  ],
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v16/migrationPackages/migrationPackage_v1/contents/configuration/admin"
    }
  ]
}

Back to Top