Get Dependencies for Selected Migration Resources or a Migration Package from Source Site
post
/rest/v16/migrationResources/dependencies
Use this endpoint to retrieve dependencies for selected migration resources or migration package from a source site.
Request
Supported Media Types
- application/json
Header Parameters
-
password(required): string
Source site user password
-
siteUrl(required): string
Source site URL
-
username(required): string
Source site user name
Get dependencies request
Root Schema : dependency-Request
Type:
objectTitle:
Show Source
dependency-Request-
contents:
object Contents
Title:
Contents -
packageIdentifier:
string
Title:
Package IdentifierThe unique identifier of the package the user wants to get dependencies from.
Nested Schema : Contents
Type:
objectTitle:
Show Source
Contents-
items:
array Migration Package Content List
Title:
Migration Package Content ListList of Migration Package Contents
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.
Response
Supported Media Types
- application/json
Default Response
Migration resource dependencies response
Root Schema : dependency-Response
Type:
Show Source
object-
items:
array List of Dependent Resources
Title:
List of Dependent ResourcesList of dependent resources
Nested Schema : List of Dependent Resources
Type:
arrayTitle:
List of Dependent ResourcesList of dependent resources
Show Source
-
Array of:
object dependencyResponse-children
Dependency response
Nested Schema : dependencyResponse-children
Type:
objectDependency response
Show Source
-
category:
string
Title:
Migration Resource CategoryCategory -
children:
array List of Resources
Title:
List of ResourcesList of resources -
name:
string
Title:
Migration Resource Category NameName of the category
Nested Schema : List of Resources
Type:
arrayTitle:
List of ResourcesList of resources
Show Source
-
Array of:
object dependencyResponse-subChildren
Migration resource
Nested Schema : dependencyResponse-subChildren
Type:
objectMigration resource
Show Source
-
dependencies:
array List of Migration Resource Dependencies
Title:
List of Migration Resource DependenciesList of migration resource dependencies -
name:
string
Title:
Migration Resource NameName of resource -
resourceType:
string
Title:
Migration Resource TypeMigration resource type -
variableName:
string
Title:
Migration Resouce Variable NameMigration resource variable name
Nested Schema : List of Migration Resource Dependencies
Type:
arrayTitle:
List of Migration Resource DependenciesList of migration resource dependencies
Show Source
-
Array of:
object dependencyDetails
Migration resource dependency
Nested Schema : dependencyDetails
Type:
objectMigration resource dependency
Show Source
-
category:
string
Title:
Migration Resource CategoryMigration resource category -
hierarchy:
string
Title:
Migration Resource HierarchyHierarchy refers path information of the resource -
name:
string
Title:
Migration Resource NameName of the resource -
type:
string
Title:
Migration Resource Dependency TypeMigration resource dependency type -
variableName:
string
Title:
Migration Resource Variable NameMigration resource variable name
Examples
The following examples show how to retrieve the dependencies for migration resources or a migration package from a source site by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
Example of Dependencies of Selected Migration Resources from a Source Site
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/migrationResources/dependencies
Sample Request Body
{
"contents": {
"items": [{
"category": "COMMERCE",
"children": [{
"name": "test",
"variableName": "test",
"granular": true,
"children": [{
"variableName": "test",
"resourceType": "process",
"checked": false,
"children": [{
"name": "Main",
"variableName": "main",
"resourceType": "document",
"children": [{
"name": "Save",
"variableName": "save",
"resourceType": "action",
"modifiedByUser": "superuser",
"lastModified": "08/01/2023 10:28 PM"
}, {
"name": "Submit",
"variableName": "submit",
"resourceType": "action",
"modifiedByUser": "superuser",
"lastModified": "08/01/2023 10:27 PM"
}
]
}
]
}
]
}
]
}
]
}
}Sample Response Body
{
"items": [{
"name": "Commerce",
"category": "COMMERCE",
"children": [{
"name": "Test",
"variableName": "test",
"resourceType": "process",
"granular": true,
"dependencies": [{
"name": "HTML Field 1",
"category": "COMMERCE",
"variableName": "hTMLField1",
"resourceType": "attribute",
"type": "LOW_LEVEL",
"hierarchy": "test~process/main~document/hTMLField1~attribute"
}, {
"name": "Help Select Actions To Be Hidden",
"category": "COMMERCE",
"variableName": "helpSelectActionsToBeHidden",
"resourceType": "attribute",
"type": "LOW_LEVEL",
"hierarchy": "test~process/main~document/helpSelectActionsToBeHidden~attribute"
}, {
"name": "Step Name",
"category": "COMMERCE",
"variableName": "stepName",
"resourceType": "attribute",
"type": "LOW_LEVEL",
"hierarchy": "test~process/main~document/stepName~attribute"
}
]
}
]
}
]
}Example of Dependencies of a Migration Package from a Source Site
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/migrationResources/dependencies
Sample Request Body
{
"packageIdentifier": "migrationPackage_v1",
"contents": {
"items": [{
"category": "COMMERCE",
"children": [{
"name": "test",
"variableName": "test",
"granular": true,
"children": [{
"variableName": "test",
"resourceType": "process",
"checked": false,
"children": [{
"name": "Main",
"variableName": "main",
"resourceType": "document",
"children": [{
"name": "Save",
"variableName": "save",
"resourceType": "action",
"modifiedByUser": "superuser",
"lastModified": "08/01/2023 10:28 PM"
}, {
"name": "Submit",
"variableName": "submit",
"resourceType": "action",
"modifiedByUser": "superuser",
"lastModified": "08/01/2023 10:27 PM"
}
]
}
]
}
]
}
]
}
]
}
}Sample Response Body
{
"items": [{
"name": "Commerce",
"category": "COMMERCE",
"children": [{
"name": "Test",
"variableName": "test",
"resourceType": "process",
"granular": true,
"dependencies": [{
"name": "HTML Field 1",
"category": "COMMERCE",
"variableName": "hTMLField1",
"resourceType": "attribute",
"type": "LOW_LEVEL",
"hierarchy": "test~process/main~document/hTMLField1~attribute"
}, {
"name": "Help Select Actions To Be Hidden",
"category": "COMMERCE",
"variableName": "helpSelectActionsToBeHidden",
"resourceType": "attribute",
"type": "LOW_LEVEL",
"hierarchy": "test~process/main~document/helpSelectActionsToBeHidden~attribute"
}, {
"name": "Step Name",
"category": "COMMERCE",
"variableName": "stepName",
"resourceType": "attribute",
"type": "LOW_LEVEL",
"hierarchy": "test~process/main~document/stepName~attribute"
}
]
}
]
}
]
}