Modify SAP Oracle instance
Select
SAP Oracle instance modify
Path Parameters
- instanceId string required
- application/json
Request Body
instanceProperties object
instance object
instanceId integer requiredInstanceId of the SAP oracle instance to be modified
instanceName stringName of the SAP oracle instance
applicationId integer requiredDefault value:
61
61 for SAP Oracle
clientId integer requiredClientId of SAp Oracle client on which instance is present
appName stringDefault value:
SAP for Oracle
clientName stringSAP Oracle client on which instance is present
commCellId integerDefault value:
2
planEntity object
planId integerPlanID of plan to be associated to the client
credentialEntity object
Credential used to connect to DB. Must be of type 'SAP Oracle'
credentialId integerUse when you want to specify a connect string. For OS auth, this is not needed, send only '/' as username in sqlConnect
sapOracleInstance object
oracleHome stringEnter the Oracle application home path.
sapDataPath stringSAP Oracle DATA home path
sapExeFolder stringSAP Oracle EXE path
sqlConnect object
userName stringDefault value:
/
Username 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:
false
SAP Oracle SecureStore
- 200
- 404
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": "exitval",
"value": "0"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "",
"instanceId": 0
}
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Unknown Instance information. Please provide valid instance id to\ncomplete the operation.",
"errorCode": 587206385
}