Add SAP Oracle instance
This operation adds an Oracle Instance.
- application/json
Request Body
Request body to add an Oracle Instance
instanceProperties object
instance object
instanceName string requiredName of the Instance
applicationId integerDefault value:
61clientName string requiredclient name
commCellId integerDefault value:
2credentialEntity object
Credential used to connect to DB. Must be of type 'SAP Oracle'
credentialName string requiredplanEntity object
planName string requiredsapOracleInstance object required
oracleHome string requiredOracle Home directory
sapDataPath string requiredData path
sapExeFolder string requiredSAP exe folder path
sqlConnect object
userName stringUsername to use to connect to the SAP for Oracle DB. Set '/' for OS auth. Please create a credential for all other connect strings
osUserCredInfo object
Applicable only for Windows clients. Used for impersonation
credentialId integeruseSAPSecureStore booleanDefault value:
falseSAP Secure store key
Responses
- 200
- 400
- 401
- 409
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_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
}
Conflict
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
entity object
subclientId integerclientId integer_SubclType_ integerinstanceName stringinstanceId integer_type_ integer
{
"errorMessage": "string",
"errorCode": 0,
"entity": {
"subclientId": 0,
"clientId": 0,
"_SubclType_": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
{
"errorMessage": "An instance by this name already exists.",
"errorCode": 3,
"entity": {
"subclientId": 0,
"clientId": 465,
"_SubclType_": 0,
"instanceName": "N742",
"instanceId": -1,
"_type_": 0
}
}
Loading...