Update a Migration Package
patch
/rest/v16/migrationPackages/{identifier}
Use this endpoint to update the migration package properties of an existing migration package. Only the specified properties are added or updated using the PATCH method.
Request
Supported Media Types
- application/json
Path Parameters
-
identifier(required): string
The unique identifier of the package to be updated.
Update migration package request.
Root Schema : migrationPackage-request
Type:
objectMigration package request body for create package
Show Source
-
contents:
object Migration Package Contents
Title:
Migration Package ContentsContents for the Migration Package -
dateRelease:
string
Title:
dateReleasedateRelease of the Migration Package. this format should yyyy-MM-dd or milliseconds(numeric) -
dependencies:
object Migration Package Dependencies
Title:
Migration Package DependenciesDependent Packages for the Migration Package -
description:
string
Title:
descriptionDescription of the Migration Package -
name(required):
string
Title:
nameName of the Migration Package
Nested Schema : Migration Package Contents
Type:
objectTitle:
Migration Package ContentsContents for the Migration Package
Show Source
-
items:
array Migration Package Content List
Title:
Migration Package Content ListList of Migration Package Contents
Nested Schema : Migration Package Dependencies
Type:
objectTitle:
Migration Package DependenciesDependent Packages for the Migration Package
Show Source
-
items:
array Migration Package Dependencies list
Title:
Migration Package Dependencies listlist of migration package dependencies
Nested Schema : Migration Package Content List
Type:
arrayTitle:
Migration Package Content ListList 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:
objectContent for the Create, Update and Update Contents Migration Package
Show Source
-
category(required):
string
Title:
Migration Package Contents CategoryCategory of migration contents -
checked:
boolean
Title:
checkedDefault Value:trueIf true, add the resource to the package content -
children:
array List of children contents
Title:
List of children contentsList of children contents -
name:
string
Title:
Migration Package Contents NameName is an optional field in the request payload
Nested Schema : List of children contents
Type:
arrayTitle:
List of children contentsList of children contents
Show Source
-
Array of:
object migratePackage-subChildren
Migration Resource children contents
Nested Schema : migratePackage-subChildren
Type:
objectMigration Resource children contents
Show Source
-
checked:
boolean
Title:
checkedIf true, add the resource to the package content -
children:
array List of children contents
Title:
List of children contentsList of children contents -
granular:
boolean
Title:
granularDefault Value:falseIf true, the resource has low-level details -
name:
string
Title:
Migration Package Resource NameName is an optional field in Request Payload -
resourceType(required):
string
Title:
Migration Package node nameresourceType refers the node (This field is mandatory only for low-level details objects) -
variableName(required):
string
Title:
Migration Package Content Child NamevariableName refers the child name
Nested Schema : List of children contents
Type:
arrayTitle:
List of children contentsList of children contents
Show Source
Nested Schema : migrationPackage-lowLevelUpdateRequest
Type:
Show Source
object-
checkedAllChildren:
boolean
Title:
checkedAllChildrenDefault Value:falseIf true, considers all the children of the resource as selected. -
children:
array List of children contents
Title:
List of children contentsList of children contents -
resourceType(required):
string
Title:
resourceTypeThis field represents the type of resource. -
variableName(required):
string
Title:
variableNameThis field represents the variableName of the resource.
Nested Schema : List of children contents
Type:
arrayTitle:
List of children contentsList of children contents
Show Source
Nested Schema : migrationPackage-lowLevelUpdateRequest-children
Type:
Show Source
object-
resourceType(required):
string
Title:
resourceTypeThis field represents the type of resource -
variableName(required):
string
Title:
variableNameThis field represents the variableName of the resource.
Nested Schema : Migration Package Dependencies list
Type:
arrayTitle:
Migration Package Dependencies listlist of migration package dependencies
Show Source
Nested Schema : migrationPackageDependency
Type:
Show Source
object-
name(required):
string
Title:
nameName of the Migration Package -
version(required):
integer
Title:
versionVersion of the Migration Package
Response
Supported Media Types
- application/json
Default Response
Update package response.
Root Schema : migrationPackage-reponse
Type:
Show Source
object-
dateAdded:
string
Title:
dateAddedDate Added of the Migration Package -
dateModified:
string
Title:
dateModifiedDate Modified of the Migration Package -
dateRelease:
string
Title:
dateReleaseDate Release of the Migration Package -
dependencies:
object Migration Package Dependencies
Title:
Migration Package DependenciesDependent Packages for the Migration Package -
description:
string
Title:
descriptionDescription of the Migration Package -
identifier:
string
Title:
identifierUnique Identifier for the Migration Package -
links:
array Migration Package Links
Title:
Migration Package LinksLinks for the Migration Package -
name:
string
Title:
nameName of the Migration Package -
version:
integer
Title:
versionVersion of the Migration Package
Nested Schema : Migration Package Dependencies
Type:
objectTitle:
Migration Package DependenciesDependent Packages for the Migration Package
Show Source
-
items:
array Migration Package Dependencies list
Title:
Migration Package Dependencies listList of Dependencies for Migration Package
Nested Schema : Migration Package Links
Type:
arrayTitle:
Migration Package LinksLinks 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:
arrayTitle:
Migration Package Dependencies listList of Dependencies for Migration Package
Show Source
Nested Schema : migrationPackageDependency
Type:
Show Source
object-
name(required):
string
Title:
nameName of the Migration Package -
version(required):
integer
Title:
versionVersion of the Migration Package
Nested Schema : referenceLinks
Type:
objectReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
rel:
string
Title:
Link Relationship to the current objectLink Relationship to the current object
Examples
The following example updates the migration package properties of an existing migration package by submitting a PATCH 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/pkg2_v1
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"
}
]
}