Jump to

• Request
• Response
• Examples

Migrate Selected Migration Resources or Migration Package from Source Site

post

/rest/v19/migrationResources/actions/migrate

This endpoint migrates the 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.

Body ()

Migrate content request.

Root Schema : Site Migrate Request

Type: object

Title: Site Migrate Request

Migrate request

Show Source

• cleanPkgsOfSameName: boolean
  Title: Clean Packages Of Same Name

  Delete the packages from resources having the same name
• contents: object Migration Content
  Title: Migration Content
• dependencies: object Migration Resource Content Dependencies
  Title: Migration Resource Content Dependencies
• excludeContents: object Exclude Content
  Title: Exclude Content
• includeSnapshot: boolean
  Title: Include Snapshot

  If true, create a snapshot
• migrationDescription: string
  Title: Migration Description

  Description
• packageIdentifier: string
  Title: Package Identifier

  Identifier of the package
• sendNotificationTo: string
  Title: Send Notification To

  Email address to send migrate info(success or error)

{
    "type":"object",
    "properties":{
        "migrationDescription":{
            "type":"string",
            "description":"Description",
            "title":"Migration Description"
        },
        "sendNotificationTo":{
            "type":"string",
            "description":"Email address to send migrate info(success or error)",
            "title":"Send Notification To"
        },
        "includeSnapshot":{
            "type":"boolean",
            "description":"If true, create a snapshot",
            "title":"Include Snapshot"
        },
        "packageIdentifier":{
            "type":"string",
            "description":"Identifier of the package",
            "title":"Package Identifier"
        },
        "cleanPkgsOfSameName":{
            "type":"boolean",
            "description":"Delete the packages from resources having the same name",
            "title":"Clean Packages Of Same Name"
        },
        "contents":{
            "type":"object",
            "title":"Migration Content",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of Migration Contents",
                    "title":"Migration Content List",
                    "items":{
                        "$ref":"#/definitions/migrationPackage-requestChildren"
                    }
                }
            }
        },
        "excludeContents":{
            "type":"object",
            "title":"Exclude Content",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of migration resource contents to be excluded",
                    "title":"List of Migration Resource Content",
                    "items":{
                        "$ref":"#/definitions/migrationPackage-requestChildren"
                    }
                }
            }
        },
        "dependencies":{
            "type":"object",
            "title":"Migration Resource Content Dependencies",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of migration resource content dependencies",
                    "title":"List of Migration Resource Dependencies",
                    "items":{
                        "$ref":"#/definitions/dependency-Response"
                    }
                }
            }
        }
    },
    "title":"Site Migrate Request",
    "description":"Migrate request"
}

Nested Schema : Migration Content

Type: object

Title: Migration Content

Show Source

• items: array Migration Content List
  Title: Migration Content List

  List of Migration Contents

{
    "type":"object",
    "title":"Migration Content",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Migration Contents",
            "title":"Migration Content List",
            "items":{
                "$ref":"#/definitions/migrationPackage-requestChildren"
            }
        }
    }
}

Nested Schema : Migration Resource Content Dependencies

Type: object

Title: Migration Resource Content Dependencies

Show Source

• items: array List of Migration Resource Dependencies
  Title: List of Migration Resource Dependencies

  List of migration resource content dependencies

{
    "type":"object",
    "title":"Migration Resource Content Dependencies",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of migration resource content dependencies",
            "title":"List of Migration Resource Dependencies",
            "items":{
                "$ref":"#/definitions/dependency-Response"
            }
        }
    }
}

Nested Schema : Exclude Content

Type: object

Title: Exclude Content

Show Source

• items: array List of Migration Resource Content
  Title: List of Migration Resource Content

  List of migration resource contents to be excluded

{
    "type":"object",
    "title":"Exclude Content",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of migration resource contents to be excluded",
            "title":"List of Migration Resource Content",
            "items":{
                "$ref":"#/definitions/migrationPackage-requestChildren"
            }
        }
    }
}

Nested Schema : Migration Content List

Type: array

Title: Migration Content List

List of Migration Contents

Show Source

• Array of: object migrationPackage-requestChildren
  Content for the Create, Update and Update Contents Migration Package

{
    "type":"array",
    "description":"List of Migration Contents",
    "title":"Migration Content List",
    "items":{
        "$ref":"#/definitions/migrationPackage-requestChildren"
    }
}

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

{
    "type":"object",
    "required":[
        "category"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name is an optional field in the request payload",
            "title":"Migration Package Contents Name"
        },
        "category":{
            "type":"string",
            "description":"Category of migration contents",
            "title":"Migration Package Contents Category"
        },
        "checked":{
            "type":"boolean",
            "description":"If true, add the resource to the package content",
            "title":"checked",
            "default":true
        },
        "children":{
            "type":"array",
            "description":"List of children contents",
            "title":"List of children contents",
            "items":{
                "$ref":"#/definitions/migratePackage-subChildren"
            }
        }
    },
    "description":"Content for the Create, Update and Update Contents Migration Package"
}

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

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

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

{
    "type":"object",
    "required":[
        "resourceType",
        "variableName"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name is an optional field in Request Payload",
            "title":"Migration Package Resource Name"
        },
        "variableName":{
            "type":"string",
            "description":"variableName refers the child name",
            "title":"Migration Package Content Child Name"
        },
        "resourceType":{
            "type":"string",
            "description":"resourceType refers the node (This field is mandatory only for low-level details objects)",
            "title":"Migration Package node name"
        },
        "checked":{
            "type":"boolean",
            "description":"If true, add the resource to the package content",
            "title":"checked"
        },
        "granular":{
            "type":"boolean",
            "description":"If true, the resource has low-level details",
            "title":"granular",
            "default":false
        },
        "children":{
            "type":"array",
            "description":"List of children contents",
            "title":"List of children contents",
            "items":{
                "$ref":"#/definitions/migrationPackage-lowLevelUpdateRequest"
            }
        }
    },
    "description":"Migration Resource children contents"
}

Nested Schema : List of children contents

Type: array

Title: List of children contents

List of children contents

Show Source

• Array of: object migrationPackage-lowLevelUpdateRequest

{
    "type":"array",
    "description":"List of children contents",
    "title":"List of children contents",
    "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"
        }
    }
}

Nested Schema : List of Migration Resource Dependencies

Type: array

Title: List of Migration Resource Dependencies

List of migration resource content dependencies

Show Source

• Array of: object dependency-Response

{
    "type":"array",
    "description":"List of migration resource content dependencies",
    "title":"List of Migration Resource Dependencies",
    "items":{
        "$ref":"#/definitions/dependency-Response"
    }
}

Nested Schema : dependency-Response

Type: object

Show Source

• items: array List of Dependent Resources
  Title: List of Dependent Resources

  List of dependent resources

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of dependent resources",
            "title":"List of Dependent Resources",
            "items":{
                "$ref":"#/definitions/dependencyResponse-children"
            }
        }
    }
}

Nested Schema : List of Dependent Resources

Type: array

Title: List of Dependent Resources

List of dependent resources

Show Source

• Array of: object dependencyResponse-children
  Dependency response

{
    "type":"array",
    "description":"List of dependent resources",
    "title":"List of Dependent Resources",
    "items":{
        "$ref":"#/definitions/dependencyResponse-children"
    }
}

Nested Schema : dependencyResponse-children

Type: object

Dependency response

Show Source

• category: string
  Title: Migration Resource Category

  Category
• children: array List of Resources
  Title: List of Resources

  List of resources
• name: string
  Title: Migration Resource Category Name

  Name of the category

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the category",
            "title":"Migration Resource Category Name"
        },
        "category":{
            "type":"string",
            "description":"Category",
            "title":"Migration Resource Category"
        },
        "children":{
            "type":"array",
            "description":"List of resources",
            "title":"List of Resources",
            "items":{
                "$ref":"#/definitions/dependencyResponse-subChildren"
            }
        }
    },
    "description":"Dependency response"
}

Nested Schema : List of Resources

Type: array

Title: List of Resources

List of resources

Show Source

• Array of: object dependencyResponse-subChildren
  Migration resource

{
    "type":"array",
    "description":"List of resources",
    "title":"List of Resources",
    "items":{
        "$ref":"#/definitions/dependencyResponse-subChildren"
    }
}

Nested Schema : dependencyResponse-subChildren

Type: object

Migration resource

Show Source

• dependencies: array List of Migration Resource Dependencies
  Title: List of Migration Resource Dependencies

  List of migration resource dependencies
• name: string
  Title: Migration Resource Name

  Name of resource
• resourceType: string
  Title: Migration Package node name

  resourceType refers to the node type
• resourceTypeLabel: string
  Title: Migration Resource Type Label

  resourceTypeLabel refers the node type label
• variableName: string
  Title: Migration Resouce Variable Name

  Migration resource variable name

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of resource",
            "title":"Migration Resource Name"
        },
        "variableName":{
            "type":"string",
            "description":"Migration resource variable name",
            "title":"Migration Resouce Variable Name"
        },
        "resourceType":{
            "type":"string",
            "description":"resourceType refers to the node type",
            "title":"Migration Package node name"
        },
        "resourceTypeLabel":{
            "type":"string",
            "description":"resourceTypeLabel refers the node type label",
            "title":"Migration Resource Type Label"
        },
        "dependencies":{
            "type":"array",
            "description":"List of migration resource dependencies",
            "title":"List of Migration Resource Dependencies",
            "items":{
                "$ref":"#/definitions/dependencyDetails"
            }
        }
    },
    "description":"Migration resource "
}

Nested Schema : List of Migration Resource Dependencies

Type: array

Title: List of Migration Resource Dependencies

List of migration resource dependencies

Show Source

• Array of: object dependencyDetails
  Migration resource dependency

{
    "type":"array",
    "description":"List of migration resource dependencies",
    "title":"List of Migration Resource Dependencies",
    "items":{
        "$ref":"#/definitions/dependencyDetails"
    }
}

Nested Schema : dependencyDetails

Type: object

Migration resource dependency

Show Source

• category: string
  Title: Migration Resource Category

  Migration resource category
• hierarchy: string
  Title: Migration Resource Hierarchy

  Hierarchy refers path information of the resource
• hierarchyLabel: string
  Title: Migration Resource Hierarchy Label

  Hierarchy label refers path information of the resource
• name: string
  Title: Migration Resource Name

  Name of the resource
• resourceType: string
  Title: Migration Package node name

  resourceType refers to the node type
• resourceTypeLabel: string
  Title: Migration Resource Type Label

  resourceTypeLabel refers the node type label
• type: string
  Title: Migration Resource Dependency Type

  Migration resource dependency type
• variableName: string
  Title: Migration Resource Variable Name

  Migration resource variable name

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the resource",
            "title":"Migration Resource Name"
        },
        "category":{
            "type":"string",
            "description":"Migration resource category",
            "title":"Migration Resource Category"
        },
        "variableName":{
            "type":"string",
            "description":"Migration resource variable name",
            "title":"Migration Resource Variable Name"
        },
        "resourceType":{
            "type":"string",
            "description":"resourceType refers to the node type",
            "title":"Migration Package node name"
        },
        "resourceTypeLabel":{
            "type":"string",
            "description":"resourceTypeLabel refers the node type label",
            "title":"Migration Resource Type Label"
        },
        "type":{
            "type":"string",
            "description":"Migration resource dependency type",
            "title":"Migration Resource Dependency Type"
        },
        "hierarchy":{
            "type":"string",
            "description":"Hierarchy refers path information of the resource",
            "title":"Migration Resource Hierarchy"
        },
        "hierarchyLabel":{
            "type":"string",
            "description":"Hierarchy label refers path information of the resource",
            "title":"Migration Resource Hierarchy Label"
        }
    },
    "description":"Migration resource dependency"
}

Nested Schema : List of Migration Resource Content

Type: array

Title: List of Migration Resource Content

List of migration resource contents to be excluded

Show Source

• Array of: object migrationPackage-requestChildren
  Content for the Create, Update and Update Contents Migration Package

{
    "type":"array",
    "description":"List of migration resource contents to be excluded",
    "title":"List of Migration Resource Content",
    "items":{
        "$ref":"#/definitions/migrationPackage-requestChildren"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Migrate task response

Body ()

Root Schema : Task details

Type: object

Title: Task details

Task details

Show Source

• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• taskId: integer
  Title: Task Id

  Task Id

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"Task Id",
            "title":"Task Id"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Task details",
    "description":"Task details"
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : reference links

Type: object

Title: reference links

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"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following examples show how to migrate the selected 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 Migrating Resources from a Source Site

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" 
https://sitename.oracle.com/rest/v19/migrationResources/actions/migrate

Sample Request Body

{
  "contents": {
    "items": [{
        "category": "COMMERCE",
        "children": [{
            "variableName": "test",
            "granular": true,
            "children": [{
                "variableName": "main",
                "resourceType": "document",
                "checkedAllChildren": false,
                "children": [{
                    "name": "eSignature Action Set",
                    "variableName": "_action_esig_set",
                    "resourceType": "action_set",
                    "lastModified": "06/15/2023 3:27 AM"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },

Sample Response Body

{
  "taskId": 3023163957,
  "links": [{
      "rel": "related",
      "href": "http://sitename.oracle.com/rest/v19/tasks/3023163957"
    }
  ]
}

Example of a Migrating a Package from a Source Site

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/migrationResources/actions/migrate

Sample Request Body

{
  "packageIdentifier": "packageName3_v1",
  "sendNotificationTo": "[e-mail]",
  "includeSnapshot": false,
  "excludeContents": {
    "items": [{
        "category": "COMMERCE",
        "children": [{
            "variableName": "test",
            "granular": true,
            "children": [{
                "variableName": "main",
                "resourceType": "document",
                "checkedAllChildren": false,
                "children": [{
                    "name": "eSignature Action Set",
                    "variableName": "_action_esig_set",
                    "resourceType": "action_set",
                    "lastModified": "06/15/2023 3:27 AM"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "dependencies": {
    "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"
              }
            ]
          }
        ]
      }
    ]
  }
}

Sample Response Body

{
  "taskId": 3023163957,
  "links": [{
      "rel": "related",
      "href": "http://sitename.oracle.com/rest/v19/tasks/3023163957"
    }
  ]
}

Back to Top