Create a Migration Package
post
/rest/v16/migrationPackages
Use this endpoint to create a new migration package.
Request
Supported Media Types
- application/json
Create migration package request.
Root Schema : migrationPackage-request
Type:
object
Migration package request body for create package
Show Source
-
contents:
object Migration Package Contents
Title:
Migration Package Contents
Contents for the Migration Package -
dateRelease:
string
Title:
dateRelease
dateRelease of the Migration Package. this format should yyyy-MM-dd or milliseconds(numeric) -
dependencies:
object Migration Package Dependencies
Title:
Migration Package Dependencies
Dependent Packages for the Migration Package -
description:
string
Title:
description
Description of the Migration Package -
name(required):
string
Title:
name
Name of the Migration Package
Nested Schema : Migration Package Contents
Type:
object
Title:
Migration Package Contents
Contents for the Migration Package
Show Source
-
items:
array Migration Package Content List
Title:
Migration Package Content List
List of Migration Package Contents
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 migration package dependencies
Nested Schema : Migration Package Content List
Type:
array
Title:
Migration Package Content List
List of Migration Package Contents
Show Source
-
Array of:
object migrationPackage-requestChildren
Content for the Create, Update and Update Contents Migration Package
Nested Schema : migrationPackage-requestChildren
Type:
object
Content for the Create, Update and Update Contents Migration Package
Show Source
-
category(required):
string
Title:
Migration Package Contents Category
Category of migration contents -
checked:
boolean
Title:
checked
Default Value:true
If true, add the resource to the package content -
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
Nested Schema : List of children contents
Type:
array
Title:
List of children contents
List of children contents
Show Source
-
Array of:
object migratePackage-subChildren
Migration Resource children contents
Nested Schema : migratePackage-subChildren
Type:
object
Migration Resource children contents
Show Source
-
checked:
boolean
Title:
checked
If true, add the resource to the package content -
children:
array List of children contents
Title:
List of children contents
List of children contents -
granular:
boolean
Title:
granular
Default Value:false
If true, the resource has low-level details -
name:
string
Title:
Migration Package Resource Name
Name is an optional field in Request Payload -
resourceType(required):
string
Title:
Migration Package node name
resourceType refers the node (This field is mandatory only for low-level details objects) -
variableName(required):
string
Title:
Migration Package Content Child Name
variableName refers the child name
Nested Schema : List of children contents
Type:
array
Title:
List of children contents
List of children contents
Show Source
Nested Schema : migrationPackage-lowLevelUpdateRequest
Type:
Show Source
object
-
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.
Nested Schema : List of children contents
Type:
array
Title:
List of children contents
List of children contents
Show Source
Nested Schema : migrationPackage-lowLevelUpdateRequest-children
Type:
Show Source
object
-
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.
Nested Schema : Migration Package Dependencies list
Type:
array
Title:
Migration Package Dependencies list
list of migration package dependencies
Show Source
Nested Schema : migrationPackageDependency
Type:
Show Source
object
-
name(required):
string
Title:
name
Name of the Migration Package -
version(required):
integer
Title:
version
Version of the Migration Package
Response
Supported Media Types
- application/json
Default Response
Create migration package response.
Root Schema : migrationPackage-reponse
Type:
Show Source
object
-
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 -
links:
array Migration Package Links
Title:
Migration Package Links
Links for the Migration Package -
name:
string
Title:
name
Name of the Migration Package -
version:
integer
Title:
version
Version of the Migration Package
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
Nested Schema : Migration Package Links
Type:
array
Title:
Migration Package Links
Links for the Migration Package
Show Source
-
Array of:
object referenceLinks
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
Nested Schema : migrationPackageDependency
Type:
Show Source
object
-
name(required):
string
Title:
name
Name of the Migration Package -
version(required):
integer
Title:
version
Version of the Migration Package
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
Examples
The following example shows how to create a migration package by submitting a POST 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
Request Body Sample
{ "name": "pkg2", "contents": { "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Formula", "variableName": "formula", "resourceType": "process" }, { "name": "Test", "variableName": "test", "resourceType": "process", "granular": true, "children": [{ "name": "Move", "variableName": "_action_process_move", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Email", "variableName": "_action_process_email_print", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Main", "variableName": "main", "resourceType": "document", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:27 PM" } ] } ] } ] } }
Response Body Sample
{ "name": "pkg2", "identifier": "pkg2_v1", "version": 1, "dateAdded": "2023-08-24T09:31:42.000Z", "dateModified": "2023-08-24T09:31:42.000Z", "dependencies": {}, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/migrationPackages/pkg2_v1" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v16/migrationPackages/pkg2_v1/contents", "name": "contents" } ] }