RAC Backup

This operation is used to trigger OracleRAC backups.

application/json

Request Body

taskInfo object
associations object[] required
clientName string required
Client Name
instanceName string required
displayName string
Display Name of the client
appName string required
backupsetName string
applicationId integer required
subclientName string required
Subclient Name
task object
taskType string required
Possible values: [IMMEDIATE, SCHEDULE, SAVED_REPORT, SCHEDULE_POLICY]
subTasks object[]
subTask object
subTaskType integer
operationType integer
options object
backupOpts object
backupLevel string required
Possible values: [FULL, INCREMENTAL, INCREMENTAL CUMULATIVE]
oracleOptions object
cumulative boolean
commonOpts object
notifyUserOnJobCompletion boolean
adminOpts object
clientInstallOption object
installerOption object
User object
userId integer
userName string

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

taskId integer
jobIds string[]

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

{
  "taskId": 478798,
  "jobIds": [
    "63001"
  ]
}

POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/commandcenter/api

token

Body

Default
Example 1
Example 2
Example 3

{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "oracleOptions": {
              "cumulative": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

RAC Backup​

Authorization

Request

RAC Backup