Create SAP HANA Subclient

SAP HANA Subclient creation

application/json

Request Body

• subClientProperties object

  subClientEntity object

  subclientName string required

  Subclient name

  backupsetId integer required

  HANA backupset ID

  backupsetName string required

  HANA Backupset name

  instanceId integer required

  HANA Instance ID

  instanceName string required

  Hana Instance name

  applicationId integer required

  Default value: 135

  appName string required

  Default value: SAP HANA

  clientId integer required

  HANA Pseudo client ID

  clientName string required

  HANA Pseudo client name

  displayName string

  HANA Pseudo client name

  entityInfo object

  companyId integer

  companyName string

  Default value: Commcell

  commonProperties object

  storageDevice object

  dataBackupStoragePolicy object

  storagePolicyId integer

  contentOperationType string

  Default value: ADD

  sapHANASubclientProp object

  numberOfBackupStreams integer

  Default value: 4

  planEntity object

  planId integer

  Plan ID

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 313,
      "_type_": 0
    }
  }
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

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

POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientName": "string",
      "backupsetId": 0,
      "backupsetName": "string",
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 135,
      "appName": "SAP HANA",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "Commcell"
      }
    },
    "commonProperties": {
      "storageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    },
    "contentOperationType": "ADD",
    "sapHANASubclientProp": {
      "numberOfBackupStreams": 4
    },
    "planEntity": {
      "planId": 0
    }
  }
}'