Jump to

• Request
• Response
• Examples

Get All Migration Tasks

get

/rest/v19/migrationTasks

This endpoint retrieves a list of all migration tasks.

Request

Query Parameters

• expand: string
  Expand the child content.

  Allowed Values: [ "categories" ]
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

All migration task information.

Body ()

Root Schema : migrationTask-collection

Type: object

Show Source

• items: array Migration Task List
  Title: Migration Task List

  List of migration tasks.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of migration tasks.",
            "title":"Migration Task List",
            "items":{
                "$ref":"#/definitions/migrationTask"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

Nested Schema : Migration Task List

Type: array

Title: Migration Task List

List of migration tasks.

Show Source

• Array of: object Migration Task Details
  Title: Migration Task Details

{
    "type":"array",
    "description":"List of migration tasks.",
    "title":"Migration Task List",
    "items":{
        "$ref":"#/definitions/migrationTask"
    }
}

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 referenceLinks
  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/referenceLinks"
    }
}

Nested Schema : Migration Task Details

Type: object

Title: Migration Task Details

Show Source

• categories: object migrationTaskCategory-collection
• date: string
  Title: date

  Completed date for migration task.
• description: string
  Title: description

  Description for the migration task.
• isCancel: boolean
  Title: isCancel

  Is migration task cancelable?
• isDelete: boolean
  Title: isDelete

  Is migration task deletable?
• isDownload: boolean
  Title: isDownload

  Is downloadable file available for the migration task?
• isRevertToSnapshot: boolean
  Title: isRevertToSnapshot

  Is revert to snapshot available for the migration task?
• isRollback: boolean
  Title: isRollback

  Is migration task rollbackable?
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• owner: string
  Title: owner

  User login name.
• status: string
  Title: status

  Status of the migration task.
• statusLabel: string
  Title: statusLabel

  Status display name.
• taskCategory: object taskCategory
  Title: taskCategory

  Category of Migration Task.
• taskId: number
  Title: taskId

  Id of the migration task.

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"number",
            "description":"Id of the migration task.",
            "title":"taskId"
        },
        "owner":{
            "type":"string",
            "description":"User login name.",
            "title":"owner"
        },
        "status":{
            "type":"string",
            "description":"Status of the migration task.",
            "title":"status"
        },
        "statusLabel":{
            "type":"string",
            "description":"Status display name.",
            "title":"statusLabel"
        },
        "description":{
            "type":"string",
            "description":"Description for the migration task.",
            "title":"description"
        },
        "date":{
            "type":"string",
            "description":"Completed date for migration task.",
            "title":"date"
        },
        "isRevertToSnapshot":{
            "type":"boolean",
            "description":"Is revert to snapshot available for the migration task?",
            "title":"isRevertToSnapshot"
        },
        "isDownload":{
            "type":"boolean",
            "description":"Is downloadable file available for the migration task?",
            "title":"isDownload"
        },
        "isCancel":{
            "type":"boolean",
            "description":"Is migration task cancelable?",
            "title":"isCancel"
        },
        "isDelete":{
            "type":"boolean",
            "description":"Is migration task deletable?",
            "title":"isDelete"
        },
        "isRollback":{
            "type":"boolean",
            "description":"Is migration task rollbackable?",
            "title":"isRollback"
        },
        "taskCategory":{
            "type":"object",
            "description":"Category of Migration Task.",
            "title":"taskCategory",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "categories":{
            "$ref":"#/definitions/migrationTaskCategory-collection"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"Migration Task Details"
}

Nested Schema : migrationTaskCategory-collection

Type: object

Show Source

• items: array Migration Task Category list
  Title: Migration Task Category list

  List of migration task sub categories.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of migration task sub categories.",
            "title":"Migration Task Category list",
            "items":{
                "$ref":"#/definitions/migrationTaskCategory"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

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 referenceLinks
  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/referenceLinks"
    }
}

Nested Schema : taskCategory

Type: object

Title: taskCategory

Category of Migration Task.

Show Source

• displayValue: string
  Title: Display Value

  Display Value
• value: number
  Title: Value

  Value

{
    "type":"object",
    "description":"Category of Migration Task.",
    "title":"taskCategory",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Migration Task Category list

Type: array

Title: Migration Task Category list

List of migration task sub categories.

Show Source

• Array of: object Migration Task Category Details
  Title: Migration Task Category Details

{
    "type":"array",
    "description":"List of migration task sub categories.",
    "title":"Migration Task Category list",
    "items":{
        "$ref":"#/definitions/migrationTaskCategory"
    }
}

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 referenceLinks
  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/referenceLinks"
    }
}

Nested Schema : Migration Task Category Details

Type: object

Title: Migration Task Category Details

Show Source

• category: string
  Title: category

  Migration task sub category.
• categoryDetails: object Migration Task Category Logs Details
  Title: Migration Task Category Logs Details
• categoryLabel: string
  Title: categoryLabel

  Category display name.
• date: string
  Title: date

  Completed date for migration sub task.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• status: string
  Title: status

  Status of the migration sub task.
• statusLabel: string
  Title: statusLabel

  Status display name.
• statusMessage: string
  Title: statusMessage

  Task Status message.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"Migration task sub category.",
            "title":"category"
        },
        "categoryLabel":{
            "type":"string",
            "description":"Category display name.",
            "title":"categoryLabel"
        },
        "date":{
            "type":"string",
            "description":"Completed date for migration sub task.",
            "title":"date"
        },
        "status":{
            "type":"string",
            "description":"Status of the migration sub task.",
            "title":"status"
        },
        "statusLabel":{
            "type":"string",
            "description":"Status display name.",
            "title":"statusLabel"
        },
        "statusMessage":{
            "type":"string",
            "description":"Task Status message.",
            "title":"statusMessage"
        },
        "categoryDetails":{
            "$ref":"#/definitions/migrationTaskCategoryDetails"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"Migration Task Category Details"
}

Nested Schema : Migration Task Category Logs Details

Type: object

Title: Migration Task Category Logs Details

Show Source

• category: string
  Title: category

  Migration task sub category.
• categoryLabel: string
  Title: categoryLabel

  Category display name.
• events: array Migration Task Sub Category Log Event
  Title: Migration Task Sub Category Log Event

  List of migration task sub category log event.
• logs: array Migration Task Sub Category Logs
  Title: Migration Task Sub Category Logs

  List of migration task sub category logs.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"Migration task sub category.",
            "title":"category"
        },
        "categoryLabel":{
            "type":"string",
            "description":"Category display name.",
            "title":"categoryLabel"
        },
        "events":{
            "type":"array",
            "description":"List of migration task sub category log event.",
            "title":"Migration Task Sub Category Log Event",
            "items":{
                "$ref":"#/definitions/migrationTaskCategoryLogEvent"
            }
        },
        "logs":{
            "type":"array",
            "description":"List of migration task sub category logs.",
            "title":"Migration Task Sub Category Logs",
            "items":{
                "$ref":"#/definitions/migrationTaskCategoryLog"
            }
        }
    },
    "title":"Migration Task Category Logs 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 referenceLinks
  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/referenceLinks"
    }
}

Nested Schema : Migration Task Sub Category Log Event

Type: array

Title: Migration Task Sub Category Log Event

List of migration task sub category log event.

Show Source

• Array of: object Migration Task Sub Category Log Event
  Title: Migration Task Sub Category Log Event

{
    "type":"array",
    "description":"List of migration task sub category log event.",
    "title":"Migration Task Sub Category Log Event",
    "items":{
        "$ref":"#/definitions/migrationTaskCategoryLogEvent"
    }
}

Nested Schema : Migration Task Sub Category Logs

Type: array

Title: Migration Task Sub Category Logs

List of migration task sub category logs.

Show Source

• Array of: object Migration Task Sub Category Log Messages
  Title: Migration Task Sub Category Log Messages

{
    "type":"array",
    "description":"List of migration task sub category logs.",
    "title":"Migration Task Sub Category Logs",
    "items":{
        "$ref":"#/definitions/migrationTaskCategoryLog"
    }
}

Nested Schema : Migration Task Sub Category Log Event

Type: object

Title: Migration Task Sub Category Log Event

Show Source

• name: string
  Title: name

  Name of the log event.
• status: string
  Title: status

  Status of the event.
• statusLabel: string
  Title: statusLabel

  Event status display name.
• statusMessage: string
  Title: statusMessage

  Event status message.
• timeStamp: string
  Title: timeStamp

  Event completed timestamp.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the log event.",
            "title":"name"
        },
        "timeStamp":{
            "type":"string",
            "description":"Event completed timestamp.",
            "title":"timeStamp"
        },
        "status":{
            "type":"string",
            "description":"Status of the event.",
            "title":"status"
        },
        "statusLabel":{
            "type":"string",
            "description":"Event status display name.",
            "title":"statusLabel"
        },
        "statusMessage":{
            "type":"string",
            "description":"Event status message.",
            "title":"statusMessage"
        }
    },
    "title":"Migration Task Sub Category Log Event"
}

Nested Schema : Migration Task Sub Category Log Messages

Type: object

Title: Migration Task Sub Category Log Messages

Show Source

• displayName: string
  Title: displayName

  Display Name of the log Messages.
• items: array Migration Task Sub Category Log Messages
  Title: Migration Task Sub Category Log Messages

  List of migration log messages.

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Display Name of the log Messages.",
            "title":"displayName"
        },
        "items":{
            "type":"array",
            "description":"List of migration log messages.",
            "title":"Migration Task Sub Category Log Messages",
            "items":{
                "$ref":"#/definitions/message"
            }
        }
    },
    "title":"Migration Task Sub Category Log Messages"
}

Nested Schema : Migration Task Sub Category Log Messages

Type: array

Title: Migration Task Sub Category Log Messages

List of migration log messages.

Show Source

• Array of: string
  Title: Message

  Message

{
    "type":"array",
    "description":"List of migration log messages.",
    "title":"Migration Task Sub Category Log Messages",
    "items":{
        "$ref":"#/definitions/message"
    }
}

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

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

Back to Top

Examples

The following example shows how to retrieve a list of all migration tasks by submitting a GET 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" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/migrationTasks

Response Body Sample

{
  "items": [{
      "taskId": 3023634117,
      "owner": "adminuser1",
      "taskCategory": {
        "value": 22,
        "displayValue": "Snapshot"
      },
      "status": "Snapshot Cancelled",
      "statusLabel": "Snapshot Cancelled",
      "date": "2025-02-14T05:27:40.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/migrationTasks/3023634117"
        }
      ],
      "isRevertToSnapshot": false,
      "isDownload": false,
      "isDelete": false,
      "isRollback": false,
      "isCancel": false
    }, {
      "taskId": 3023628792,
      "owner": "adminuser1",
      "taskCategory": {
        "value": 33,
        "displayValue": "Rollback of a migration"
      },
      "description": "Rollback for migration dated 02/12/2025 6:41 AM",
      "status": "Successful",
      "statusLabel": "Successful",
      "date": "2025-02-14T05:40:07.250Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/migrationTasks/3023628792"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/migrationTasks/3023628792/categories"
        }
      ],
      "isRevertToSnapshot": false,
      "isDownload": false,
      "isDelete": true,
      "isRollback": false,
      "isCancel": false
    }, {
      "taskId": 3023628791,
      "owner": "adminuser1",
      "taskCategory": {
        "value": 32,
        "displayValue": "Migration Rollback Helper"
      },
      "description": "User Initiated Rollback",
      "status": "Successful",
      "statusLabel": "Successful",
      "date": "2025-02-14T05:25:18.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/migrationTasks/3023628791"
        }
      ],
      "isRevertToSnapshot": false,
      "isDownload": false,
      "isDelete": true,
      "isRollback": false,
      "isCancel": false
    }
  ]
}

Back to Top