Informix Restore Operations

Select

SaaS

Customer Managed

This operation is used to run Informix restores

application/json

Request Body

• taskInfo object

  associations object[]

  clientName string required

  Client Name

  instanceName string required

  Instance Name

  displayName string

  instanceId integer

  instanceGUID string

  clientId integer

  appName string required

  Default value: Informix

  Application Name

  applicationId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  entityName string

  commCellId integer

  _type_ string

  task object

  taskType integer

  initiatedFrom integer

  subTasks object[]

  subTask object

  subTaskType integer

  operationType integer required

  Operation type

  options object

  restoreOptions object

  browseOption object

  commCellId integer

  timeRange object

  fromTime integer

  toTime integer

  destination object

  destClient object

  clientName string required

  Destination client name

  instanceName string required

  Destination instance name

  displayName string

  instanceId integer

  instanceGUID string

  clientId integer

  appName string required

  Application name

  applicationId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  entityName string

  commCellId integer

  destinationInstance object

  clientName string required

  Destination client name

  instanceName string required

  Destination instance name

  displayName string

  instanceId integer

  instanceGUID string

  clientId integer

  appName string required

  Application name

  applicationId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  entityName string

  commCellId integer

  oracleOpt object

  fileOption object

  sourceItem string[]

  List of contents to restore

  commonOptions object

  jobIds object[]

  informixOption object

  physical boolean required

  Flag to determine physical restore

  logical boolean required

  Flag to determine logical restore

  numRestoreStreams integer required

  Number of restore streams

  informixRestoreOptionType string

  informixRestoreType integer

  restoreEmergencyBootFile boolean required

  Flag to determine ixbar file restore

  restoreOnConfigFile boolean required

  Flag to determine onconfig file restore

  commonOpts object

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

Response Headers

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• taskId integer
• jobIds string[]

  JobId of install job triggered

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 2176,
  "jobIds": [
    "35886"
  ]
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Forbidden

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "User [Remote User] does not have required capability [In Place Recover] for this subclient and this operation.",
  "errorCode": 587204041
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to start backups as no eligible subclients were found.",
  "errorCode": 587207178
}

Loading...