Informix Backup Operations

This operation is used to run Informix backups

application/json

Request Body

• taskInfo object

  associations object[]

  subclientId integer

  Subclient ID

  displayName string

  clientId integer

  Client ID

  instanceName string required

  Instance Name

  appName string required

  Default value: Informix

  Application Name

  applicationId integer

  Default value: 3

  Application ID

  clientName string required

  Client Name

  backupsetId integer

  instanceId integer

  Instance ID

  subclientName string required

  Subclient Name

  backupsetName string

  task object

  taskType integer

  subTasks object[]

  subTask object required

  subTaskType integer

  operationType integer

  Operation Type

  options object

  backupOpts object

  backupLevel string required

  Backup level

  commonOpts object

  notifyUserOnJobCompletion boolean

  adminOpts object

  clientInstallOption object

  installerOption object

  User object

  userId integer

  userName string

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": 71945,
  "jobIds": [
    "3587112"
  ]
}

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 [Data Protection/Management Operations] for this client [ifxauto1] and this operation.",
  "errorCode": 587203022
}

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...