Restore
Select
SaaS
Customer Managed
Restore operation on object storage instance
- application/json
Request Body
taskInfo object
Responses
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 1087,
"jobIds": [
"9669"
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Wrong payload example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Failed to run task.",
"errorCode": 587203993
}
POST /createtask
Request
Request
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"taskInfo": {
"task": {
"policyType": "string",
"taskType": "string",
"initiatedFrom": "string"
},
"associations": [
{
"applicationId": 0,
"clientName": "string",
"backupsetId": 0,
"backupsetName": "string",
"instanceId": 0,
"instanceName": "string",
"clientId": 0,
"_type_": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "string",
"operationType": "string"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0
},
"destination": {
"noOfStreams": 0,
"destClient": {
"clientId": 0,
"clientName": "string"
},
"destinationInstance": {
"instanceId": 0,
"instanceName": "string"
},
"destAppId": 0,
"inPlace": true
},
"qrOption": {
"destAppTypeId": 0
},
"fileOption": {
"sourceItem": [
"string"
]
},
"commonOptions": {
"stripLevelType": "string",
"restoreACLs": true,
"unconditionalOverwrite": true
},
"cloudAppsRestoreOptions": {
"instanceType": "string",
"cloudStorageRestoreOptions": {
"restoreToFileSystem": true,
"restoreDestination": {
"instanceType": "string"
}
}
}
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'