Oracle Backup

Select

SaaS

Customer Managed

This operation is used to trigger Oracle backups.

application/json

Request Body

• taskInfo object

  task object

  taskType required

  Possible values: [IMMEDIATE, SCHEDULE, SAVED_REPORT, SCHEDULE_POLICY]

  associations object[]

  clientName string required

  Client Name

  displayName string

  Display Name of the client

  instanceName string required

  Instance Name

  appName string required

  Default value: Oracle

  applicationId integer required

  Default value: 22

  subclientName string required

  Subclient Name

  subTasks object[]

  subTask object

  subTaskType string

  Default value: BACKUP

  operationType string

  Default value: BACKUP

  options object

  backupOpts object

  backupLevel required

  Possible values: [FULL, INCREMENTAL]

  Select desired type of backup

  oracleOptions object

  cumulative boolean

  Enable this to perform Oracle differential backups

  commonOpts object

  notifyUserOnJobCompletion boolean

  Default value: true

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

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

{
  "taskId": 58798,
  "jobIds": [
    "3400891"
  ]
}

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
}

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "associations": [
      {
        "clientName": "string",
        "displayName": "string",
        "instanceName": "string",
        "appName": "Oracle",
        "applicationId": 22,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'