Jump to

• Request
• Response
• Examples

Update Migration Package Resource Low-level Details

put

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

Use this endpoint to update low-level details of a migration resource within a specific category of a migration package. Using the PUT method replaces the entire package contents with new package contents.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Migration package low-level details request.

Root Schema : schema

Type: object

Show Source

• checkedAll: boolean
  Title: checkedAll

  If true, include all migratable resources within low-level details.
• items: array low-level details list
  Title: low-level details list

  List of low-level details

{
    "properties":{
        "checkedAll":{
            "type":"boolean",
            "description":"If true, include all migratable resources within low-level details.",
            "title":"checkedAll"
        },
        "items":{
            "type":"array",
            "description":"List of low-level details",
            "title":"low-level details list",
            "items":{
                "$ref":"#/definitions/migrationPackage-lowLevelUpdateRequest"
            }
        }
    }
}

Nested Schema : low-level details list

Type: array

Title: low-level details list

List of low-level details

Show Source

• Array of: object migrationPackage-lowLevelUpdateRequest

{
    "type":"array",
    "description":"List of low-level details",
    "title":"low-level details list",
    "items":{
        "$ref":"#/definitions/migrationPackage-lowLevelUpdateRequest"
    }
}

Nested Schema : migrationPackage-lowLevelUpdateRequest

Type: object

Show Source

• checkedAllChildren: boolean
  Title: checkedAllChildren

  Default Value: false

  If true, considers all the children of the resource as selected.
• children: array List of children contents
  Title: List of children contents

  List of children contents
• resourceType(required): string
  Title: resourceType

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

  This field represents the variableName of the resource.

{
    "type":"object",
    "required":[
        "resourceType",
        "variableName"
    ],
    "properties":{
        "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"
        },
        "checkedAllChildren":{
            "type":"boolean",
            "description":"If true, considers all the children of the resource as selected.",
            "title":"checkedAllChildren",
            "default":false
        },
        "children":{
            "type":"array",
            "description":"List of children contents",
            "title":"List of children contents",
            "items":{
                "$ref":"#/definitions/migrationPackage-lowLevelUpdateRequest-children"
            }
        }
    }
}

Nested Schema : List of children contents

Type: array

Title: List of children contents

List of children contents

Show Source

• Array of: object migrationPackage-lowLevelUpdateRequest-children

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

Nested Schema : migrationPackage-lowLevelUpdateRequest-children

Type: object

Show Source

• resourceType(required): string
  Title: resourceType

  This field represents the type of resource
• variableName(required): string
  Title: variableName

  This field represents the variableName of the resource.

{
    "type":"object",
    "required":[
        "resourceType",
        "variableName"
    ],
    "properties":{
        "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Migration package low-level details 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 update low-level details of a migration resource within a specific category of a migration package by submitting a PUT 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/commerce/test

Request Body Sample

{
  "items": [{
      "variableName": "main",
      "resourceType": "document",
      "children": [{
          "variableName": "submit",
          "resourceType": "action"
        }
      ]
    }
  ]
}

Response Body Sample

{
  "name": "Test",
  "variableName": "test",
  "modifiedByUser": "matt",
  "lastModified": "09/19/2019 12:30 PM",
  "children": [{
      "name": "Main",
      "variableName": "main",
      "resourceType": "document",
      "modifiedByUser": "matt",
      "lastModified": "09/18/2019 3:07 PM",
      "children": [{
          "name": "Submit",
          "variableName": "submit",
          "resourceType": "action",
          "modifiedByUser": "asuh",
          "lastModified": "06/06/2019 1:24 PM"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v16/migrationPackages/migrationPackage_v1/contents/COMMERCE/test"
    }
  ]
}

Back to Top