Jump to

• Request
• Response
• Examples

Get Dependencies for Selected Migration Resources or a Migration Package from Source Site

post

/rest/v19/migrationResources/dependencies

This endpoint retrieves 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.

Body ()

Get dependencies request.

Root Schema : dependency-Request

Type: object

Title: dependency-Request

Show Source

• contents: object Contents
  Title: Contents
• packageIdentifier: string
  Title: Package Identifier

  Identifier of the package the user wishes to get dependencies

{
    "type":"object",
    "properties":{
        "packageIdentifier":{
            "type":"string",
            "description":"Identifier of the package the user wishes to get dependencies",
            "title":"Package Identifier"
        },
        "contents":{
            "type":"object",
            "title":"Contents",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of Migration Package Contents",
                    "title":"Migration Package Content List",
                    "items":{
                        "$ref":"#/definitions/migrationPackage-requestChildren"
                    }
                }
            }
        }
    },
    "title":"dependency-Request"
}

Nested Schema : Contents

Type: object

Title: Contents

Show Source

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

  List of Migration Package Contents

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

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

{
    "type":"array",
    "description":"List of Migration Package Contents",
    "title":"Migration Package 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Migration resource dependencies response

Body ()

Root 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"
}

Back to Top

Examples

The Get Dependencies for Selected Migration Resources or a Migration Package from Source Site REST API retrieve dependencies for selected migration resources or migration package from a source site by specifying an advanced query object (i.e. "q" criteria) as a request body parameter. This allows administrators to customize the query by specifying various combinations of criteria.

The following examples show how to search parts by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

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

Example of Dependencies of Selected Migration Resources from a Source Site

Request Body Sample

{
  "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"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Response Body Sample

{
  "items": [{
      "name": "Commerce",
      "category": "COMMERCE",
      "children": [{
          "name": "Test",
          "variableName": "test",
          "resourceType": "process",
          "resourceTypeLabel": "Commerce",
          "granular": true,
          "dependencies": [{
              "name": "Step Name",
              "category": "COMMERCE",
              "variableName": "stepName",
              "resourceType": "attribute",
              "resourceTypeLabel": "Attribute(s)",
              "type": "LOW_LEVEL",
              "hierarchy": "test~process/main~document/stepName~attribute",
              "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/Step Name",
              "source": [{
                  "name": "Save",
                  "variableName": "save",
                  "resourceType": "action",
                  "resourceTypeLabel": "Action(s)",
                  "hierarchyLabel": "Test/Document(s)/Main/Action(s)"
                }
              ]
            }, {
              "name": "HTML Field 1",
              "category": "COMMERCE",
              "variableName": "hTMLField1",
              "resourceType": "attribute",
              "resourceTypeLabel": "Attribute(s)",
              "type": "LOW_LEVEL",
              "hierarchy": "test~process/main~document/hTMLField1~attribute",
              "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/HTML Field 1",
              "source": [{
                  "name": "Save",
                  "variableName": "save",
                  "resourceType": "action",
                  "resourceTypeLabel": "Action(s)",
                  "hierarchyLabel": "Test/Document(s)/Main/Action(s)"
                }, {
                  "name": "Submit",
                  "variableName": "submit",
                  "resourceType": "action",
                  "resourceTypeLabel": "Action(s)",
                  "hierarchyLabel": "Test/Document(s)/Main/Action(s)"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Example of Dependencies of a Migration Package from a Source Site

Request Body Sample

{
  "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"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Response Body Sample

{
  "items": [{
      "name": "Commerce",
      "category": "COMMERCE",
      "children": [{
          "name": "Test",
          "variableName": "test",
          "resourceType": "process",
          "resourceTypeLabel": "Commerce",
          "granular": true,
          "dependencies": [{
              "name": "Step Name",
              "category": "COMMERCE",
              "variableName": "stepName",
              "resourceType": "attribute",
              "resourceTypeLabel": "Attribute(s)",
              "type": "LOW_LEVEL",
              "hierarchy": "test~process/main~document/stepName~attribute",
              "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/Step Name",
              "source": [{
                  "name": "Save",
                  "variableName": "save",
                  "resourceType": "action",
                  "resourceTypeLabel": "Action(s)",
                  "hierarchyLabel": "Test/Document(s)/Main/Action(s)"
                }
              ]
            }, {
              "name": "HTML Field 1",
              "category": "COMMERCE",
              "variableName": "hTMLField1",
              "resourceType": "attribute",
              "resourceTypeLabel": "Attribute(s)",
              "type": "LOW_LEVEL",
              "hierarchy": "test~process/main~document/hTMLField1~attribute",
              "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/HTML Field 1",
              "source": [{
                  "name": "Save",
                  "variableName": "save",
                  "resourceType": "action",
                  "resourceTypeLabel": "Action(s)",
                  "hierarchyLabel": "Test/Document(s)/Main/Action(s)"
                }, {
                  "name": "Submit",
                  "variableName": "submit",
                  "resourceType": "action",
                  "resourceTypeLabel": "Action(s)",
                  "hierarchyLabel": "Test/Document(s)/Main/Action(s)"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Back to Top