Skip to main content

Create Oracle Subclient​

Select

SaaS
Customer Managed

Create Oracle Subclient

Request Body
  • subClientProperties object
  • subClientEntity object
  • subclientName string required

    Subclient Name.

  • instanceName string

    Instance Name

  • applicationId integer

    Default value: 22

  • appName string

    Default value: Oracle

  • clientName string required

    Client Name

  • entityInfo object

    Internal Fields

  • companyId integer
  • companyName string

    Company Name

  • multiCommcellId integer
  • commonProperties object
  • oracleSubclientProp object
  • selectiveOnlineFull boolean

    Set to true for selective online full subclients.

  • backupMode

    Possible values: [ONLINE_DB, ONLINE_SUBSET_DB, OFFLINE_DB]

  • data boolean

    Set to true for data backups

  • lightsOutScript boolean

    This is set to true for offline backups

  • enableTableBrowse boolean

    Set this to true if you want table level metadata to be collected.

  • backupArchiveLog boolean

    Enable this option to backup oracle archivelogs

  • archiveDelete boolean

    Set this to true if you want backup up archivelogs to be deleted on the client

  • dataThresholdStreams integer

    Default value: 2

  • archiveDeleteAll boolean

    Default value: false

  • content object[]

    This object is relevant for Online_Subset_DB backups

  • oracleContent object

    Select content that needs to be backed up

  • tableSpace string
  • contentOperationType string

    Default value: ADD

  • planEntity object
  • planName string

    Associate plan to subclient

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer

    SubclientId of new subclient

POST /subclient

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "subClientProperties": {

    "subClientEntity": {

      "subclientName": "string",

      "instanceName": "string",

      "applicationId": 22,

      "appName": "Oracle",

      "clientName": "string",

      "entityInfo": {

        "companyId": 0,

        "companyName": "string",

        "multiCommcellId": 0

      }

    },

    "commonProperties": {},

    "oracleSubclientProp": {

      "selectiveOnlineFull": true,

      "data": true,

      "lightsOutScript": true,

      "enableTableBrowse": true,

      "backupArchiveLog": true,

      "archiveDelete": true,

      "dataThresholdStreams": 2,

      "archiveDeleteAll": false

    },

    "content": [

      {

        "oracleContent": {

          "tableSpace": "string"

        }

      }

    ],

    "contentOperationType": "ADD",

    "planEntity": {

      "planName": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "instanceName": "string",
      "applicationId": 22,
      "appName": "Oracle",
      "clientName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      }
    },
    "commonProperties": {},
    "oracleSubclientProp": {
      "selectiveOnlineFull": true,
      "data": true,
      "lightsOutScript": true,
      "enableTableBrowse": true,
      "backupArchiveLog": true,
      "archiveDelete": true,
      "dataThresholdStreams": 2,
      "archiveDeleteAll": false
    },
    "content": [
      {
        "oracleContent": {
          "tableSpace": "string"
        }
      }
    ],
    "contentOperationType": "ADD",
    "planEntity": {
      "planName": "string"
    }
  }
}'