Jump to

• Request
• Response

Perform Operation

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fleetOperations

Performs all the individual maintenance tasks on the targets. Tasks include- deploy software, migrate listener, update, upgrade, rollback, cleanup, attachCdb, deployCdb, updatePdb, upgradePdb, rollbackPdb, emergencyDeploy, etc. Operations to be performed using FPP will require inputs related to the FPP operations

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match All

Show Source

• object CreateFleetOperationDetails
  Fleet operation inputs

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateFleetOperationDetails"
        }
    ]
}

Nested Schema : CreateFleetOperationDetails

Type: object

Fleet operation inputs

Match Any

Show Source

• object DeployDetails
  Deploy operation input
• object AttachCdbDetails
  Attach CDB operation input
• object DeployCdbDetails
  Deploy CDB operation input
• object EmergencyDeployDetails
  Emergency deploy operation input
• object MigrateListenerDetails
  Migrate listener operation input
• object UpdateDetails
  Update operation input
• object UpdatePdbDetails
  Update PDB operation input
• object UpgradeDetails
  Upgrade operation input
• object UpgradePdbDetails
  Upgrade PDB operation input
• object AttachCdbDetails
  Attach CDB operation input
• object RollbackDetails
  Rollback operation input
• object RollbackPdbDetails
  Rollback of PDBs operation input
• object RollbackListenerDetails
  Rollback of listerner operation input
• object CleanupDetails
  Cleanup operation input
• object CleanupCdbDetails
  Cleanup CDB operation input

{
    "description":"Fleet operation inputs",
    "type":"object",
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/DeployDetails"
        },
        {
            "$ref":"#/components/schemas/AttachCdbDetails"
        },
        {
            "$ref":"#/components/schemas/DeployCdbDetails"
        },
        {
            "$ref":"#/components/schemas/EmergencyDeployDetails"
        },
        {
            "$ref":"#/components/schemas/MigrateListenerDetails"
        },
        {
            "$ref":"#/components/schemas/UpdateDetails"
        },
        {
            "$ref":"#/components/schemas/UpdatePdbDetails"
        },
        {
            "$ref":"#/components/schemas/UpgradeDetails"
        },
        {
            "$ref":"#/components/schemas/UpgradePdbDetails"
        },
        {
            "$ref":"#/components/schemas/AttachCdbDetails"
        },
        {
            "$ref":"#/components/schemas/RollbackDetails"
        },
        {
            "$ref":"#/components/schemas/RollbackPdbDetails"
        },
        {
            "$ref":"#/components/schemas/RollbackListenerDetails"
        },
        {
            "$ref":"#/components/schemas/CleanupDetails"
        },
        {
            "$ref":"#/components/schemas/CleanupCdbDetails"
        }
    ]
}

Nested Schema : DeployDetails

Type: object

Deploy operation input

Show Source

• deploy: object deploy
  Deploy operation input

{
    "description":"Deploy operation input",
    "type":"object",
    "properties":{
        "deploy":{
            "description":"Deploy operation input",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeployOperationInput"
                }
            ]
        }
    }
}

Nested Schema : AttachCdbDetails

Type: object

Attach CDB operation input

Show Source

• attachCdb: attachCdb
  Attach CDB input

{
    "description":"Attach CDB operation input",
    "type":"object",
    "properties":{
        "attachCdb":{
            "description":"Attach CDB input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/AttachCdbOperationInput"
                }
            ]
        }
    }
}

Nested Schema : DeployCdbDetails

Type: object

Deploy CDB operation input

Show Source

• deployCdb: deployCdb
  Deploy CDB operation input

{
    "description":"Deploy CDB operation input",
    "type":"object",
    "properties":{
        "deployCdb":{
            "description":"Deploy CDB operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeployCdbOperationInput"
                }
            ]
        }
    }
}

Nested Schema : EmergencyDeployDetails

Type: object

Emergency deploy operation input

Show Source

• emergencyDeploy: emergencyDeploy
  Emergency deploy operation input

{
    "description":"Emergency deploy operation input",
    "type":"object",
    "properties":{
        "emergencyDeploy":{
            "description":"Emergency deploy operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/EmergencyDeployOperationInput"
                }
            ]
        }
    }
}

Nested Schema : MigrateListenerDetails

Type: object

Migrate listener operation input

Show Source

• migrateListener: migrateListener
  Migrate listener operation input

{
    "description":"Migrate listener operation input",
    "type":"object",
    "properties":{
        "migrateListener":{
            "description":"Migrate listener operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MigrateListenerOperationInput"
                }
            ]
        }
    }
}

Nested Schema : UpdateDetails

Type: object

Update operation input

Show Source

• update: update
  Update operation input

{
    "description":"Update operation input",
    "type":"object",
    "properties":{
        "update":{
            "description":"Update operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/UpdateOperationInput"
                }
            ]
        }
    }
}

Nested Schema : UpdatePdbDetails

Type: object

Update PDB operation input

Show Source

• updatePdb: updatePdb
  Update operation input

{
    "description":"Update PDB operation input",
    "type":"object",
    "properties":{
        "updatePdb":{
            "description":"Update operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/UpdatePdbOperationInput"
                }
            ]
        }
    }
}

Nested Schema : UpgradeDetails

Type: object

Upgrade operation input

Show Source

• upgrade: upgrade
  Upgrade operation input

{
    "description":"Upgrade operation input",
    "type":"object",
    "properties":{
        "upgrade":{
            "description":"Upgrade operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/UpgradeOperationInput"
                }
            ]
        }
    }
}

Nested Schema : UpgradePdbDetails

Type: object

Upgrade PDB operation input

Show Source

• upgradePdb: upgradePdb
  Upgrade PDB operation input

{
    "description":"Upgrade PDB operation input",
    "type":"object",
    "properties":{
        "upgradePdb":{
            "description":"Upgrade PDB operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/PdbPatchingInput"
                }
            ]
        }
    }
}

Nested Schema : RollbackDetails

Type: object

Rollback operation input

Show Source

• rollback: rollback
  Rollback operation input

{
    "description":"Rollback operation input",
    "type":"object",
    "properties":{
        "rollback":{
            "description":"Rollback operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/RollbackOperationInput"
                }
            ]
        }
    }
}

Nested Schema : RollbackPdbDetails

Type: object

Rollback of PDBs operation input

Show Source

• rollbackPdb: rollbackPdb
  Rollback of PDBs operation input

{
    "description":"Rollback of PDBs operation input",
    "type":"object",
    "properties":{
        "rollbackPdb":{
            "description":"Rollback of PDBs operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/RollbackPdbOperationInput"
                }
            ]
        }
    }
}

Nested Schema : RollbackListenerDetails

Type: object

Rollback of listerner operation input

Show Source

• rollbackListener: rollbackListener
  Rollback of listener operation input

{
    "description":"Rollback of listerner operation input",
    "type":"object",
    "properties":{
        "rollbackListener":{
            "description":"Rollback of listener operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MigrateListenerOperationInput"
                }
            ]
        }
    }
}

Nested Schema : CleanupDetails

Type: object

Cleanup operation input

Show Source

• cleanup: cleanup
  Cleanup operation input

{
    "description":"Cleanup operation input",
    "type":"object",
    "properties":{
        "cleanup":{
            "description":"Cleanup operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/CleanupOperationInput"
                }
            ]
        }
    }
}

Nested Schema : CleanupCdbDetails

Type: object

Cleanup CDB operation input

Show Source

• cleanupCdb: cleanupCdb
  Cleanup CDB operation input

{
    "description":"Cleanup CDB operation input",
    "type":"object",
    "properties":{
        "cleanupCdb":{
            "description":"Cleanup CDB operation input",
            "allOf":[
                {
                    "$ref":"#/components/schemas/CleanupCdbOperationInput"
                }
            ]
        }
    }
}

Nested Schema : deploy

Type: object

Deploy operation input

Match All

Show Source

• object allOf DeployOperationInput
  Input for 'deploy Oracle home' operation

{
    "description":"Deploy operation input",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeployOperationInput"
        }
    ]
}

Nested Schema : DeployOperationInput

Type: object

Input for 'deploy Oracle home' operation

Show Source

• additionalParam: string
  Additional parameters for database deployment

  Example: -J-Xint
• attachHome: string
  Param to indicate attach home
• customCVUComponent: string
  Custom CVU component
• dispatcherLocation: string
  Dispatcher location

  Example: /scratch/user/dispatchLoc
• gimrOsBackupDbaGroup: string
  Mandatory OsBackupDba (GIMR only) group for target deployment
• gimrOsDbaGroup: string
  Mandatory OsDba (GIMR only) group for target deployment
• gimrOsDgDbaGroup: string
  Mandatory OsDgDba (GIMR only) group for target deployment
• gimrOsInstallGroup: string
  Mandatory OsInstall (GIMR only) group for target deployment
• gimrOsKmDbaGroup: string
  Mandatory OsKmDba (GIMR only) group for target deployment
• gimrOsOperGroup: string
  Mandatory OsOper (GIMR only) group for target deployment
• gimrOsRacDbaGroup: string
  Mandatory OsRacDba (GIMR only) group for target deployment
• isBuiltInAccount: boolean
  Default Value: false

  Flag to indicate built in account
• isForce: boolean
  Default Value: false

  When set to true, this flag forces Oracle Home cleanup even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message.
• isPrerequisitesOnly: boolean
  Default Value: false

  Flag to indicate only prerequisite checks are to be performed
• isRedeploy: boolean
  Default Value: false

  Param to indicate redeploy home
• isRootPreStaged: boolean
  Default Value: false

  Flag to indicate root pre staged
• isRunCVUFromOH: boolean
  Default Value: false

  Flag to indicate run CVU from Oracle home
• isSkipCVUChecks: boolean
  Default Value: false

  Flag to indicate skipping CVU checks
• isSkipPrerequisites: boolean
  Default Value: false

  Flag to indicate skipping prerequisites
• isSkipRemoteHostValidations: boolean
  Default Value: false

  Flag to indicate skipping remote host validations
• isSkipValidations: boolean
  Default Value: false

  Flag to indicate skipping validations
• isSkipWindowsHomeAccountTypeCheck: boolean
  Default Value: false

  Flag to indicate skipping the Windows home account type check
• isStandByAutoDeploy: boolean
  Default Value: true

  Flag to indicate auto deployment on the standby databases
• isVirtualAccount: boolean
  Default Value: false

  Flag to indicate virtual account
• newOracleHomeLocation(required): string
  New Oracle home location

  Example: /scratch/user/oraclehome
• normalCredential(required): string
  Normal credential

  Example: HOST_CRED:ADMIN
• privilegeCredential: string
  Privilege credential

  Example: HOST_ROOT_CRED:ADMIN
• targetData: array targetData
  Heterogenous list of targets
• windowsSecurityCredential: string
  Windows security credential

  Example: WIN_SEC_CRED:ADMIN
• workingCopyPrefix: string
  Working copy prefix. This is mandatory if there is more than one target specified in target list for a deploy operation.

  Example: WC
• workingDirectory: string
  Working directory

  Example: /scratch/user/workDir

{
    "description":"Input for 'deploy Oracle home' operation",
    "type":"object",
    "required":[
        "newOracleHomeLocation",
        "normalCredential"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/OperationInput"
        }
    ],
    "properties":{
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "attachHome":{
            "description":"Param to indicate attach home",
            "type":"string"
        },
        "isRedeploy":{
            "description":"Param to indicate redeploy home",
            "type":"boolean",
            "default":false
        },
        "newOracleHomeLocation":{
            "description":"New Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "isStandByAutoDeploy":{
            "description":"Flag to indicate auto deployment on the standby databases",
            "type":"boolean",
            "default":true
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping CVU checks",
            "type":"boolean",
            "default":false
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping prerequisites",
            "type":"boolean",
            "default":false
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"boolean",
            "default":false
        },
        "isForce":{
            "description":"When set to true, this flag forces Oracle Home cleanup even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message.",
            "type":"boolean",
            "default":false
        },
        "isRootPreStaged":{
            "description":"Flag to indicate root pre staged",
            "type":"boolean",
            "default":false
        },
        "isVirtualAccount":{
            "description":"Flag to indicate virtual account",
            "type":"boolean",
            "default":false
        },
        "isBuiltInAccount":{
            "description":"Flag to indicate built in account",
            "type":"boolean",
            "default":false
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Flag to indicate skipping the Windows home account type check",
            "type":"boolean",
            "default":false
        },
        "isRunCVUFromOH":{
            "description":"Flag to indicate run CVU from Oracle home",
            "type":"boolean",
            "default":false
        },
        "customCVUComponent":{
            "description":"Custom CVU component",
            "type":"string"
        },
        "targetData":{
            "description":"Heterogenous list of targets",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Target"
            }
        },
        "workingCopyPrefix":{
            "description":"Working copy prefix. This is mandatory if there is more than one target specified in target list for a deploy operation.",
            "type":"string",
            "example":"WC"
        },
        "gimrOsDbaGroup":{
            "description":"Mandatory OsDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsOperGroup":{
            "description":"Mandatory OsOper (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsBackupDbaGroup":{
            "description":"Mandatory OsBackupDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsDgDbaGroup":{
            "description":"Mandatory OsDgDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsKmDbaGroup":{
            "description":"Mandatory OsKmDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsRacDbaGroup":{
            "description":"Mandatory OsRacDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsInstallGroup":{
            "description":"Mandatory OsInstall (GIMR only) group for target deployment",
            "type":"string"
        },
        "additionalParam":{
            "description":"Additional parameters for database deployment",
            "type":"string",
            "example":"-J-Xint"
        }
    }
}

Match All

Show Source

• object TargetList
  List of targets
• object OperationInput
  Common Input for operations

{
    "description":"Input for 'deploy Oracle home' operation",
    "type":"object",
    "required":[
        "newOracleHomeLocation",
        "normalCredential"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/OperationInput"
        }
    ],
    "properties":{
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "attachHome":{
            "description":"Param to indicate attach home",
            "type":"string"
        },
        "isRedeploy":{
            "description":"Param to indicate redeploy home",
            "type":"boolean",
            "default":false
        },
        "newOracleHomeLocation":{
            "description":"New Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "isStandByAutoDeploy":{
            "description":"Flag to indicate auto deployment on the standby databases",
            "type":"boolean",
            "default":true
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping CVU checks",
            "type":"boolean",
            "default":false
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping prerequisites",
            "type":"boolean",
            "default":false
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"boolean",
            "default":false
        },
        "isForce":{
            "description":"When set to true, this flag forces Oracle Home cleanup even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message.",
            "type":"boolean",
            "default":false
        },
        "isRootPreStaged":{
            "description":"Flag to indicate root pre staged",
            "type":"boolean",
            "default":false
        },
        "isVirtualAccount":{
            "description":"Flag to indicate virtual account",
            "type":"boolean",
            "default":false
        },
        "isBuiltInAccount":{
            "description":"Flag to indicate built in account",
            "type":"boolean",
            "default":false
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Flag to indicate skipping the Windows home account type check",
            "type":"boolean",
            "default":false
        },
        "isRunCVUFromOH":{
            "description":"Flag to indicate run CVU from Oracle home",
            "type":"boolean",
            "default":false
        },
        "customCVUComponent":{
            "description":"Custom CVU component",
            "type":"string"
        },
        "targetData":{
            "description":"Heterogenous list of targets",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Target"
            }
        },
        "workingCopyPrefix":{
            "description":"Working copy prefix. This is mandatory if there is more than one target specified in target list for a deploy operation.",
            "type":"string",
            "example":"WC"
        },
        "gimrOsDbaGroup":{
            "description":"Mandatory OsDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsOperGroup":{
            "description":"Mandatory OsOper (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsBackupDbaGroup":{
            "description":"Mandatory OsBackupDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsDgDbaGroup":{
            "description":"Mandatory OsDgDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsKmDbaGroup":{
            "description":"Mandatory OsKmDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsRacDbaGroup":{
            "description":"Mandatory OsRacDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsInstallGroup":{
            "description":"Mandatory OsInstall (GIMR only) group for target deployment",
            "type":"string"
        },
        "additionalParam":{
            "description":"Additional parameters for database deployment",
            "type":"string",
            "example":"-J-Xint"
        }
    }
}

Match One Schema

Show Source

{
    "description":"Input for 'deploy Oracle home' operation",
    "type":"object",
    "required":[
        "newOracleHomeLocation",
        "normalCredential"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/OperationInput"
        }
    ],
    "properties":{
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "attachHome":{
            "description":"Param to indicate attach home",
            "type":"string"
        },
        "isRedeploy":{
            "description":"Param to indicate redeploy home",
            "type":"boolean",
            "default":false
        },
        "newOracleHomeLocation":{
            "description":"New Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "isStandByAutoDeploy":{
            "description":"Flag to indicate auto deployment on the standby databases",
            "type":"boolean",
            "default":true
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping CVU checks",
            "type":"boolean",
            "default":false
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping prerequisites",
            "type":"boolean",
            "default":false
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"boolean",
            "default":false
        },
        "isForce":{
            "description":"When set to true, this flag forces Oracle Home cleanup even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message.",
            "type":"boolean",
            "default":false
        },
        "isRootPreStaged":{
            "description":"Flag to indicate root pre staged",
            "type":"boolean",
            "default":false
        },
        "isVirtualAccount":{
            "description":"Flag to indicate virtual account",
            "type":"boolean",
            "default":false
        },
        "isBuiltInAccount":{
            "description":"Flag to indicate built in account",
            "type":"boolean",
            "default":false
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Flag to indicate skipping the Windows home account type check",
            "type":"boolean",
            "default":false
        },
        "isRunCVUFromOH":{
            "description":"Flag to indicate run CVU from Oracle home",
            "type":"boolean",
            "default":false
        },
        "customCVUComponent":{
            "description":"Custom CVU component",
            "type":"string"
        },
        "targetData":{
            "description":"Heterogenous list of targets",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Target"
            }
        },
        "workingCopyPrefix":{
            "description":"Working copy prefix. This is mandatory if there is more than one target specified in target list for a deploy operation.",
            "type":"string",
            "example":"WC"
        },
        "gimrOsDbaGroup":{
            "description":"Mandatory OsDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsOperGroup":{
            "description":"Mandatory OsOper (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsBackupDbaGroup":{
            "description":"Mandatory OsBackupDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsDgDbaGroup":{
            "description":"Mandatory OsDgDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsKmDbaGroup":{
            "description":"Mandatory OsKmDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsRacDbaGroup":{
            "description":"Mandatory OsRacDba (GIMR only) group for target deployment",
            "type":"string"
        },
        "gimrOsInstallGroup":{
            "description":"Mandatory OsInstall (GIMR only) group for target deployment",
            "type":"string"
        },
        "additionalParam":{
            "description":"Additional parameters for database deployment",
            "type":"string",
            "example":"-J-Xint"
        }
    }
}

Nested Schema : TargetList

Type: object

List of targets

Show Source

• targetList: array targetList
  Array of target names
• targetType: string
  Target type

  Example: oracle_database

{
    "description":"List of targets",
    "type":"object",
    "properties":{
        "targetList":{
            "description":"Array of target names",
            "type":"array",
            "items":{
                "type":"string",
                "example":"db1, db2"
            }
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Nested Schema : OperationInput

Type: object

Common Input for operations

Show Source

• customPostScriptURN: string
  Custom post script URN
• customPreScriptURN: string
  Custom pre script URN
• deploymentProcedureNamePrefix: string
  Deployment procedure name prefix
• description: string
  Description of the operation
• fppOptions: object fppOptions
  Additional Properties Allowed: true

  Additional key, value inputs for FPP operations
• fppRestUser: string
  REST user to be used for an FPP REST call

  Example: rest_cuser
• isRunPostScriptAsRoot: boolean
  Default Value: false

  Runs post script as root
• isRunPreScriptAsRoot: boolean
  Default Value: false

  Runs pre script as root
• metadataCheckCorrection: string
  Default Value: ignore

  Performs metadata check correction
• name: string
  Name of the operation
• schedule: object Schedule
  Schedule details

{
    "description":"Common Input for operations",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the operation",
            "type":"string"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string"
        },
        "deploymentProcedureNamePrefix":{
            "description":"Deployment procedure name prefix",
            "type":"string"
        },
        "customPreScriptURN":{
            "description":"Custom pre script URN",
            "type":"string"
        },
        "customPostScriptURN":{
            "description":"Custom post script URN",
            "type":"string"
        },
        "isRunPreScriptAsRoot":{
            "description":"Runs pre script as root",
            "type":"boolean",
            "default":false
        },
        "isRunPostScriptAsRoot":{
            "description":"Runs post script as root",
            "type":"boolean",
            "default":false
        },
        "metadataCheckCorrection":{
            "description":"Performs metadata check correction",
            "type":"string",
            "default":"ignore"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "fppRestUser":{
            "description":"REST user to be used for an FPP REST call",
            "type":"string",
            "example":"rest_cuser"
        },
        "fppOptions":{
            "description":"Additional key, value inputs for FPP operations",
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : targetList

Type: array

Array of target names

Show Source

• Array of: string
  Example: db1, db2

{
    "description":"Array of target names",
    "type":"array",
    "items":{
        "type":"string",
        "example":"db1, db2"
    }
}

Nested Schema : fppOptions

Type: object

Additional Properties Allowed: true

Additional key, value inputs for FPP operations

Nested Schema : Schedule

Type: object

Schedule details

Show Source

• isTargetZone: boolean
  To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition
• recurring: string
  Frequency at which the operation must be executed repeatedly

  Example: frequency:weekly;days:2,
• scheduleType: string
  Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON.
• startGracePeriodInMinutes: integer
  Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.

  Example: 60
• timeToEnd: string (date-time)
  End time
• timeToStart: string (date-time)
  Start time

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":60
        }
    }
}

Nested Schema : attachCdb

Attach CDB input

Match All

Show Source

• object allOf AttachCdbOperationInput
  Input for the 'attach CDB' operation

{
    "description":"Attach CDB input",
    "allOf":[
        {
            "$ref":"#/components/schemas/AttachCdbOperationInput"
        }
    ]
}

Nested Schema : AttachCdbOperationInput

Type: object

Input for the 'attach CDB' operation

Show Source

• targetData: array targetData
  Target data for the 'attach CDB' operation

{
    "description":"Input for the 'attach CDB' operation",
    "type":"object",
    "required":[
        "name"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "targetData":{
            "description":"Target data for the 'attach CDB' operation",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "destinationCdb":{
                        "type":"string",
                        "example":"sales_cdb"
                    }
                }
            }
        }
    }
}

Match All

Show Source

• object allOf PdbPatchingInput
  PDB patching operation common details

{
    "description":"Input for the 'attach CDB' operation",
    "type":"object",
    "required":[
        "name"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "targetData":{
            "description":"Target data for the 'attach CDB' operation",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "destinationCdb":{
                        "type":"string",
                        "example":"sales_cdb"
                    }
                }
            }
        }
    }
}

Match One Schema

Show Source

{
    "description":"Input for the 'attach CDB' operation",
    "type":"object",
    "required":[
        "name"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "targetData":{
            "description":"Target data for the 'attach CDB' operation",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "destinationCdb":{
                        "type":"string",
                        "example":"sales_cdb"
                    }
                }
            }
        }
    }
}

Nested Schema : PdbPatchingInput

Type: object

PDB patching operation common details

Show Source

• databaseCredential: string
  Database credential

  Example: DB_CRED:ADMIN
• databaseName: string
  Name of the database

  Example: pdb1
• databasePrefix: string
  Prefix of the database name

  Example: pdb
• destinationCdb: string
  Destination CDB

  Example: sales_cdb
• destinationOracleHomeLocation: string
  Destination Oracle home location

  Example: /scratch/user/oraclehome
• destinationPrefix: string
  Prefix of destination CDB

  Example: sales
• isForce: string
  Flag used in emergency patching

  Example: true
• isPrerequisitesOnly: boolean
  Default Value: false

  Flag to indicate only prerequisite checks are to be performed
• isSkipRemoteHostValidations: boolean
  Default Value: false

  Flag to indicate skipping the remote host validations
• isSkipValidations: string
  Flag to indicate skipping validations

  Example: true
• normalCredential: string
  Normal credential

  Example: HOST_CRED:ADMIN
• privilegeCredential: string
  Privilege credential

  Example: HOST_ROOT_CRED:ADMIN
• workingDirectory: string
  Working directory

  Example: /tmp

{
    "description":"PDB patching operation common details",
    "type":"object",
    "required":[
        "name",
        "targetList",
        "targetType"
    ],
    "oneOf":[
        {
            "required":[
                "databasePrefix",
                "destinationCdb"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/OperationInput"
        }
    ],
    "properties":{
        "destinationCdb":{
            "description":"Destination CDB",
            "type":"string",
            "example":"sales_cdb"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "databaseCredential":{
            "description":"Database credential",
            "type":"string",
            "example":"DB_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Destination Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "destinationPrefix":{
            "description":"Prefix of destination CDB",
            "type":"string",
            "example":"sales"
        },
        "databaseName":{
            "description":"Name of the database",
            "type":"string",
            "example":"pdb1"
        },
        "databasePrefix":{
            "description":"Prefix of the database name",
            "type":"string",
            "example":"pdb"
        },
        "isForce":{
            "description":"Flag used in emergency patching",
            "type":"string",
            "example":"true"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping the remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"string",
            "example":"true"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/tmp"
        }
    }
}

Match All

Show Source

• object TargetList
  List of targets
• object OperationInput
  Common Input for operations

{
    "description":"PDB patching operation common details",
    "type":"object",
    "required":[
        "name",
        "targetList",
        "targetType"
    ],
    "oneOf":[
        {
            "required":[
                "databasePrefix",
                "destinationCdb"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/OperationInput"
        }
    ],
    "properties":{
        "destinationCdb":{
            "description":"Destination CDB",
            "type":"string",
            "example":"sales_cdb"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "databaseCredential":{
            "description":"Database credential",
            "type":"string",
            "example":"DB_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Destination Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "destinationPrefix":{
            "description":"Prefix of destination CDB",
            "type":"string",
            "example":"sales"
        },
        "databaseName":{
            "description":"Name of the database",
            "type":"string",
            "example":"pdb1"
        },
        "databasePrefix":{
            "description":"Prefix of the database name",
            "type":"string",
            "example":"pdb"
        },
        "isForce":{
            "description":"Flag used in emergency patching",
            "type":"string",
            "example":"true"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping the remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"string",
            "example":"true"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/tmp"
        }
    }
}

Match One Schema

Show Source

{
    "description":"PDB patching operation common details",
    "type":"object",
    "required":[
        "name",
        "targetList",
        "targetType"
    ],
    "oneOf":[
        {
            "required":[
                "databasePrefix",
                "destinationCdb"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/OperationInput"
        }
    ],
    "properties":{
        "destinationCdb":{
            "description":"Destination CDB",
            "type":"string",
            "example":"sales_cdb"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "databaseCredential":{
            "description":"Database credential",
            "type":"string",
            "example":"DB_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Destination Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "destinationPrefix":{
            "description":"Prefix of destination CDB",
            "type":"string",
            "example":"sales"
        },
        "databaseName":{
            "description":"Name of the database",
            "type":"string",
            "example":"pdb1"
        },
        "databasePrefix":{
            "description":"Prefix of the database name",
            "type":"string",
            "example":"pdb"
        },
        "isForce":{
            "description":"Flag used in emergency patching",
            "type":"string",
            "example":"true"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping the remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"string",
            "example":"true"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/tmp"
        }
    }
}

Nested Schema : deployCdb

Deploy CDB operation input

Match All

Show Source

• object allOf DeployCdbOperationInput
  Input for the CDB deployment operation

{
    "description":"Deploy CDB operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeployCdbOperationInput"
        }
    ]
}

Nested Schema : DeployCdbOperationInput

Type: object

Input for the CDB deployment operation

Show Source

• targetData: array targetData
  Target data for the 'deploy CDB' operation

{
    "description":"Input for the CDB deployment operation",
    "type":"object",
    "required":[
        "name"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "targetData":{
            "description":"Target data for the 'deploy CDB' operation",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "destinationCdb":{
                        "type":"string",
                        "example":"sales_cdb"
                    },
                    "destinationPrefix":{
                        "type":"string",
                        "example":"sales"
                    }
                }
            }
        }
    }
}

Match All

Show Source

• object allOf PdbPatchingInput
  PDB patching operation common details

{
    "description":"Input for the CDB deployment operation",
    "type":"object",
    "required":[
        "name"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "targetData":{
            "description":"Target data for the 'deploy CDB' operation",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "destinationCdb":{
                        "type":"string",
                        "example":"sales_cdb"
                    },
                    "destinationPrefix":{
                        "type":"string",
                        "example":"sales"
                    }
                }
            }
        }
    }
}

Match One Schema

Show Source

{
    "description":"Input for the CDB deployment operation",
    "type":"object",
    "required":[
        "name"
    ],
    "oneOf":[
        {
            "required":[
                "targetList",
                "targetType"
            ]
        },
        {
            "required":[
                "targetData"
            ]
        }
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "targetData":{
            "description":"Target data for the 'deploy CDB' operation",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "destinationCdb":{
                        "type":"string",
                        "example":"sales_cdb"
                    },
                    "destinationPrefix":{
                        "type":"string",
                        "example":"sales"
                    }
                }
            }
        }
    }
}

Nested Schema : emergencyDeploy

Emergency deploy operation input

Match All

Show Source

• object allOf EmergencyDeployOperationInput
  Input for emergency deploy operation

{
    "description":"Emergency deploy operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/EmergencyDeployOperationInput"
        }
    ]
}

Nested Schema : EmergencyDeployOperationInput

Type: object

Input for emergency deploy operation

Show Source

• description: string
  Description of the operation

  Example: emergency deploy
• dispatcherLocation: string
  Dispatcher location

  Example: /scratch/user/dispatchLoc
• isPrerequisitesOnly: boolean
  Default Value: false

  Flag for prerequisites only
• isSkipCVUChecks: boolean
  Default Value: false

  Flag to indicate skipping the CVU checks
• isSkipPrerequisites: boolean
  Default Value: false

  Flag to indicate skipping prerequisite checks
• isSkipRemoteHostValidations: boolean
  Default Value: false

  Flag to skip remote host validations
• isStandByAutoDeploy: boolean
  Default Value: true

  Flag to indicate a deploy operation on standby databases
• metadataCheckCorrection: string
  Flag for metadata check correction
• name: string
  Nmae of the operation

  Example: emergency deploy
• newOracleHomeLocation(required): string
  Path for the new Oracle Home
• normalCredential: string
  Normal credential

  Example: HOST_CRED:ADMIN
• patchList(required): array patchList
  List of patches to be applied
• privilegeCredential: string
  Privilege credential

  Example: HOST_ROOT_CRED:ADMIN
• targetName(required): string
  Name of the target to be patched

  Example: salesdb
• targetType(required): string
  Target type

  Example: oracle_database
• workingDirectory: string
  Working directory

  Example: /scratch/user/workDir

{
    "description":"Input for emergency deploy operation",
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ],
    "required":[
        "patchList",
        "targetName",
        "targetType",
        "newOracleHomeLocation"
    ],
    "type":"object",
    "properties":{
        "name":{
            "description":"Nmae of the operation",
            "type":"string",
            "example":"emergency deploy"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string",
            "example":"emergency deploy"
        },
        "targetName":{
            "description":"Name of the target to be patched",
            "type":"string",
            "example":"salesdb"
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "newOracleHomeLocation":{
            "description":"Path for the new Oracle Home",
            "type":"string"
        },
        "isStandByAutoDeploy":{
            "description":"Flag to indicate a deploy operation on standby databases",
            "type":"boolean",
            "default":true
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping prerequisite checks",
            "type":"boolean",
            "default":false
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping the CVU checks",
            "type":"boolean",
            "default":false
        },
        "patchList":{
            "description":"List of patches to be applied",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "metadataCheckCorrection":{
            "description":"Flag for metadata check correction",
            "type":"string"
        },
        "isPrerequisitesOnly":{
            "description":"Flag for prerequisites only",
            "type":"boolean",
            "default":false
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to skip remote host validations",
            "type":"boolean",
            "default":false
        }
    }
}

Match All

Show Source

• object Schedule
  Schedule details

{
    "description":"Input for emergency deploy operation",
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ],
    "required":[
        "patchList",
        "targetName",
        "targetType",
        "newOracleHomeLocation"
    ],
    "type":"object",
    "properties":{
        "name":{
            "description":"Nmae of the operation",
            "type":"string",
            "example":"emergency deploy"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string",
            "example":"emergency deploy"
        },
        "targetName":{
            "description":"Name of the target to be patched",
            "type":"string",
            "example":"salesdb"
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "newOracleHomeLocation":{
            "description":"Path for the new Oracle Home",
            "type":"string"
        },
        "isStandByAutoDeploy":{
            "description":"Flag to indicate a deploy operation on standby databases",
            "type":"boolean",
            "default":true
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping prerequisite checks",
            "type":"boolean",
            "default":false
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping the CVU checks",
            "type":"boolean",
            "default":false
        },
        "patchList":{
            "description":"List of patches to be applied",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "metadataCheckCorrection":{
            "description":"Flag for metadata check correction",
            "type":"string"
        },
        "isPrerequisitesOnly":{
            "description":"Flag for prerequisites only",
            "type":"boolean",
            "default":false
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to skip remote host validations",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : migrateListener

Migrate listener operation input

Match All

Show Source

• object allOf MigrateListenerOperationInput
  Input for migrate listener operation

{
    "description":"Migrate listener operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/MigrateListenerOperationInput"
        }
    ]
}

Nested Schema : MigrateListenerOperationInput

Type: object

Input for migrate listener operation

Show Source

• deploymentProcedureNamePrefix: string
  Deployment procedure name prefix
• description: string
  Description of the operation
• isForce: boolean
  Default Value: false

  When set to true this flag forces Oracle Home cleanup to occur even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message
• isPrerequisitesOnly: boolean
  Default Value: false

  Flag to indicate only prerequisite checks are to be performed
• isSkipRemoteHostValidations: boolean
  Default Value: false

  Flag to indicate skipping the remote host validations
• isSkipValidations: boolean
  Default Value: false

  Flag to indicate skipping validations
• isSkipWindowsHomeAccountTypeCheck: boolean
  Default Value: false

  Flag to indicate skip Windows home account type check
• metadataCheckCorrection: string
  Default Value: ignore

  Performs metadata check correction
• name(required): string
  Name of the operation
• newOracleHomeLocation: string
  New Oracle home location

  Example: /scratch/user/oraclehome
• normalCredential: string
  Normal credential

  Example: HOST_CRED:ADMIN
• privilegeCredential: string
  Privilege credential

  Example: HOST_ROOT_CRED:ADMIN
• schedule: object Schedule
  Schedule details
• windowsSecurityCredential: string
  Windows security credential

  Example: WIN_SEC_CRED:ADMIN
• workingDirectory: string
  Working directory

  Example: /scratch/user/workDir

{
    "description":"Input for migrate listener operation",
    "required":[
        "name",
        "targetList",
        "targetType"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "name":{
            "description":"Name of the operation",
            "type":"string"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string"
        },
        "deploymentProcedureNamePrefix":{
            "description":"Deployment procedure name prefix",
            "type":"string"
        },
        "metadataCheckCorrection":{
            "description":"Performs metadata check correction",
            "type":"string",
            "default":"ignore"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "newOracleHomeLocation":{
            "description":"New Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping the remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"boolean",
            "default":false
        },
        "isForce":{
            "description":"When set to true this flag forces Oracle Home cleanup to occur even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message",
            "type":"boolean",
            "default":false
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Flag to indicate skip Windows home account type check",
            "type":"boolean",
            "default":false
        }
    }
}

Match All

Show Source

• object TargetList
  List of targets

{
    "description":"Input for migrate listener operation",
    "required":[
        "name",
        "targetList",
        "targetType"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "name":{
            "description":"Name of the operation",
            "type":"string"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string"
        },
        "deploymentProcedureNamePrefix":{
            "description":"Deployment procedure name prefix",
            "type":"string"
        },
        "metadataCheckCorrection":{
            "description":"Performs metadata check correction",
            "type":"string",
            "default":"ignore"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "newOracleHomeLocation":{
            "description":"New Oracle home location",
            "type":"string",
            "example":"/scratch/user/oraclehome"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping the remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping validations",
            "type":"boolean",
            "default":false
        },
        "isForce":{
            "description":"When set to true this flag forces Oracle Home cleanup to occur even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message",
            "type":"boolean",
            "default":false
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Flag to indicate skip Windows home account type check",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : update

Update operation input

Match All

Show Source

• object allOf UpdateOperationInput
  Input for the update operation

{
    "description":"Update operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateOperationInput"
        }
    ]
}

Nested Schema : UpdateOperationInput

Type: object

Input for the update operation

Match All

Show Source

• object OperationInput
  Common Input for operations
• object TargetList
  List of targets
• object allOf UpdateDBOperationInput
  Input for the update database operation

{
    "description":"Input for the update operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/OperationInput"
        },
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/UpdateDBOperationInput"
        }
    ]
}

Nested Schema : UpdateDBOperationInput

Type: object

Input for the update database operation

Show Source

• auto: string
  Auto parameter
• blackoutId: string
  ID of the black out
• cleanpids: string
  Clean PIDs
• databaseList: string
  Database list
• databaseToPdbData: array databaseToPdbData
  Input to convert the database to PDB
• dataguardRole: string
  Enum for Data Guard role
• deleteSourceDatabase: string
  Indicates if the source database can be deleted
• description: string
  Description of the update operation
• destinationCdbCredential: string
  Destination CDB credential

  Example: HOST_CDB_CRED:ADMIN
• destinationHostCredential: string
  Destination host credential

  Example: HOST_CRED:ADMIN
• destinationPdbDisplayName: string
  Destination PDB name
• destinationPdbName: string
  Destination PDB name

  Example: hrpdb
• destinationWalletPassword: string
  Destination database wallet password, only for TDE enabled databases
• destinationWorkingDirectory: string
  Working directory in the destination host
• disconnect: string
  Disconnect parameter
• dispatcherLocation: string
  Dispatcher location

  Example: /scratch/user/dispatchLoc
• drainTimeout: string
  Drain time out
• excludeDatabaseList: string
  Exclude database list parameter
• fppOptions: object fppOptions
  Additional Properties Allowed: true

  Additional key, value inputs for FPP operations
• gimrOperation: string
  Identifies the Grid Infrastructure Management Repository (GIMR) operation
• ignoreDatabaseStartError: string
  Ignore database start error parameter
• isBuiltinAccount: boolean
  Built in account, only for Windows deployments
• isDisableDataguard: boolean
  Default Value: false

  Flag to indicate the operation to disable Data Guard role
• isEnableDataguard: boolean
  Default Value: false

  Flag to indicate the operation to enable Data Guard role
• isEnableFSFO: boolean
  Default Value: false

  Flag to indicate the operation to enable FSFO
• isForce: boolean
  Forces the execution
• isIgnoreStandbyPrerequisites: boolean
  Default Value: false

  This disables the verification check if the standby is on same image version that the primary is being moved to
• isNonCdbToPdb: boolean
  Flag to identify non CDB to PDB operation
• isPrerequisitesOnly: boolean
  Default Value: false

  Flag to indicate only prerequisite checks are to be performed
• isRolling: boolean
  Default Value: false

  Flag to indicate a rolling patch operation
• isSkipCVUChecks: boolean
  Default Value: false

  Flag to indicate skipping the CVU checks
• isSkipLocalSaveState: boolean
  Skip local state saving
• isSkipPrerequisites: boolean
  Default Value: false

  Flag to indicate skipping the prerequisite checks
• isSkipRemoteHostValidations: boolean
  Default Value: false

  Flag to indicate skipping remote host validations
• isSkipSwitchDatabase: boolean
  It should be set to true. It skips switching of the database to the patched home since it is already performed in earlier steps.
• isSkipValidations: boolean
  Default Value: false

  Flag to indicate skipping the validations
• isSkipWindowsHomeAccountTypeCheck: boolean
  Skip the Windows home account type check
• isStartupAfterSwitch: boolean
  For non-rolling patches, it is necessary to bring up the Primary database first from the patched home. It will ensure that the standby is left in the shutdown state during the update operation. The standby database will be started in a separate step after the primary is patched and started.
• isStartupDatabase: boolean
  Startup the database after the patch is completed
• isStartupDBAfterSwitch: boolean
  Default Value: true

  It is used for node-wise patching in order to leave a database instance down after a cluster instance is patched
• isVirtualAccount: boolean
  Virtual account, only for Windows deployments
• migrateDatabase: string
  Indicates the migrate database operation
• migrateType: string
  Enum for migrate type
• newOracleHomeLocation: string
  Path for the new Oracle Home
• nodeList: string
  comma separated list of nodes
• normalCredential: string
  Normal credential

  Example: HOST_CRED:ADMIN
• parallelism: string
  Parallelism parameter

  Example: 4
• pdbAdminName: string
  PDB admin name
• primaryDatabaseHostCredential: string
  Host credential for the primary database
• privilegeCredential: string
  Privilege credential

  Example: HOST_ROOT_CRED:ADMIN
• sourceWalletPassword: string
  Source database wallet password, only for TDE enabled databases
• sourceWorkingDirectory: string
  Working directory on source database

  Example: /scratch/user/workdir
• sqlSequence: string
  SQL sequence
• standbyStartOption: string
  Standby start up option after the patch
• startupStandby: string
  Startup standby
• targetNode: string
  Target node
• windowsCredential: string
  Windows credential, only for Windows deployments
• windowsSecurityCredential: string
  Windows security credential

  Example: WIN_SEC_CRED:ADMIN
• workingDirectory: string
  Working directory

  Example: /scratch/user/workDir

{
    "description":"Input for the update database operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/OperationInput"
        },
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "isRolling":{
            "description":"Flag to indicate a rolling patch operation",
            "type":"boolean",
            "default":false
        },
        "sqlSequence":{
            "description":"SQL sequence",
            "type":"string"
        },
        "nodeList":{
            "description":"comma separated list of nodes",
            "type":"string"
        },
        "dataguardRole":{
            "$ref":"#/components/schemas/DataguardRoleEnum"
        },
        "isStartupAfterSwitch":{
            "description":"For non-rolling patches, it is necessary to bring up the Primary database first from the patched home. It will ensure that the standby is left in the shutdown state during the update operation. The standby database will be started in a separate step after the primary is patched and started.",
            "type":"boolean"
        },
        "isStartupDatabase":{
            "description":"Startup the database after the patch is completed",
            "type":"boolean"
        },
        "isStartupDBAfterSwitch":{
            "description":"It is used for node-wise patching in order to leave a database instance down after a cluster instance is patched",
            "type":"boolean",
            "default":true
        },
        "isSkipSwitchDatabase":{
            "description":"It should be set to true. It skips switching of the database to the patched home since it is already performed in earlier steps.",
            "type":"boolean"
        },
        "isIgnoreStandbyPrerequisites":{
            "description":"This disables the verification check if the standby is on same image version that the primary is being moved to",
            "type":"boolean",
            "default":false
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping the CVU checks",
            "type":"boolean",
            "default":false
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping the prerequisite checks",
            "type":"boolean",
            "default":false
        },
        "blackoutId":{
            "description":"ID of the black out",
            "type":"string"
        },
        "isSkipLocalSaveState":{
            "description":"Skip local state saving",
            "type":"boolean"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "description":{
            "description":"Description of the update operation",
            "type":"string"
        },
        "isForce":{
            "description":"Forces the execution",
            "type":"boolean"
        },
        "newOracleHomeLocation":{
            "description":"Path for the new Oracle Home",
            "type":"string"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping the validations",
            "type":"boolean",
            "default":false
        },
        "isEnableDataguard":{
            "description":"Flag to indicate the operation to enable Data Guard role",
            "type":"boolean",
            "default":false
        },
        "isEnableFSFO":{
            "description":"Flag to indicate the operation to enable FSFO",
            "type":"boolean",
            "default":false
        },
        "isDisableDataguard":{
            "description":"Flag to indicate the operation to disable Data Guard role",
            "type":"boolean",
            "default":false
        },
        "standbyStartOption":{
            "description":"Standby start up option after the patch",
            "type":"string"
        },
        "primaryDatabaseHostCredential":{
            "description":"Host credential for the primary database",
            "type":"string"
        },
        "sourceWalletPassword":{
            "description":"Source database wallet password, only for TDE enabled databases",
            "type":"string"
        },
        "destinationWalletPassword":{
            "description":"Destination database wallet password, only for TDE enabled databases",
            "type":"string"
        },
        "startupStandby":{
            "description":"Startup standby",
            "type":"string"
        },
        "drainTimeout":{
            "description":"Drain time out",
            "type":"string"
        },
        "windowsCredential":{
            "description":"Windows credential, only for Windows deployments",
            "type":"string"
        },
        "isVirtualAccount":{
            "description":"Virtual account, only for Windows deployments",
            "type":"boolean"
        },
        "isBuiltinAccount":{
            "description":"Built in account, only for Windows deployments",
            "type":"boolean"
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Skip the Windows home account type check",
            "type":"boolean"
        },
        "gimrOperation":{
            "description":"Identifies the Grid Infrastructure Management Repository (GIMR) operation",
            "type":"string"
        },
        "isNonCdbToPdb":{
            "description":"Flag to identify non CDB to PDB operation",
            "type":"boolean"
        },
        "migrateType":{
            "$ref":"#/components/schemas/MigrateTypeEnum"
        },
        "sourceWorkingDirectory":{
            "description":"Working directory on source database",
            "type":"string",
            "example":"/scratch/user/workdir"
        },
        "destinationPdbName":{
            "description":"Destination PDB name",
            "type":"string",
            "example":"hrpdb"
        },
        "destinationCdbCredential":{
            "description":"Destination CDB credential",
            "type":"string",
            "example":"HOST_CDB_CRED:ADMIN"
        },
        "destinationHostCredential":{
            "description":"Destination host credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "parallelism":{
            "description":"Parallelism parameter",
            "type":"string",
            "example":4
        },
        "migrateDatabase":{
            "description":"Indicates the migrate database operation",
            "type":"string"
        },
        "destinationWorkingDirectory":{
            "description":"Working directory in the destination host",
            "type":"string"
        },
        "deleteSourceDatabase":{
            "description":"Indicates if the source database can be deleted",
            "type":"string"
        },
        "destinationPdbDisplayName":{
            "description":"Destination PDB name",
            "type":"string"
        },
        "pdbAdminName":{
            "description":"PDB admin name",
            "type":"string"
        },
        "databaseToPdbData":{
            "description":"Input to convert the database to PDB",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "targetName":{
                        "description":"Name of the target",
                        "type":"string",
                        "example":"db1"
                    },
                    "destinationPdbName":{
                        "type":"string",
                        "example":"pdb1"
                    }
                }
            }
        },
        "auto":{
            "description":"Auto parameter",
            "type":"string"
        },
        "cleanpids":{
            "description":"Clean PIDs",
            "type":"string"
        },
        "databaseList":{
            "description":"Database list",
            "type":"string"
        },
        "disconnect":{
            "description":"Disconnect parameter",
            "type":"string"
        },
        "excludeDatabaseList":{
            "description":"Exclude database list parameter",
            "type":"string"
        },
        "ignoreDatabaseStartError":{
            "description":"Ignore database start error parameter",
            "type":"string"
        },
        "targetNode":{
            "description":"Target node",
            "type":"string"
        },
        "fppOptions":{
            "description":"Additional key, value inputs for FPP operations",
            "type":"object",
            "additionalProperties":true
        }
    }
}

Match All

Show Source

• object OperationInput
  Common Input for operations
• object TargetList
  List of targets

{
    "description":"Input for the update database operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/OperationInput"
        },
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "isRolling":{
            "description":"Flag to indicate a rolling patch operation",
            "type":"boolean",
            "default":false
        },
        "sqlSequence":{
            "description":"SQL sequence",
            "type":"string"
        },
        "nodeList":{
            "description":"comma separated list of nodes",
            "type":"string"
        },
        "dataguardRole":{
            "$ref":"#/components/schemas/DataguardRoleEnum"
        },
        "isStartupAfterSwitch":{
            "description":"For non-rolling patches, it is necessary to bring up the Primary database first from the patched home. It will ensure that the standby is left in the shutdown state during the update operation. The standby database will be started in a separate step after the primary is patched and started.",
            "type":"boolean"
        },
        "isStartupDatabase":{
            "description":"Startup the database after the patch is completed",
            "type":"boolean"
        },
        "isStartupDBAfterSwitch":{
            "description":"It is used for node-wise patching in order to leave a database instance down after a cluster instance is patched",
            "type":"boolean",
            "default":true
        },
        "isSkipSwitchDatabase":{
            "description":"It should be set to true. It skips switching of the database to the patched home since it is already performed in earlier steps.",
            "type":"boolean"
        },
        "isIgnoreStandbyPrerequisites":{
            "description":"This disables the verification check if the standby is on same image version that the primary is being moved to",
            "type":"boolean",
            "default":false
        },
        "isSkipCVUChecks":{
            "description":"Flag to indicate skipping the CVU checks",
            "type":"boolean",
            "default":false
        },
        "isSkipPrerequisites":{
            "description":"Flag to indicate skipping the prerequisite checks",
            "type":"boolean",
            "default":false
        },
        "blackoutId":{
            "description":"ID of the black out",
            "type":"string"
        },
        "isSkipLocalSaveState":{
            "description":"Skip local state saving",
            "type":"boolean"
        },
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "windowsSecurityCredential":{
            "description":"Windows security credential",
            "type":"string",
            "example":"WIN_SEC_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Dispatcher location",
            "type":"string",
            "example":"/scratch/user/dispatchLoc"
        },
        "description":{
            "description":"Description of the update operation",
            "type":"string"
        },
        "isForce":{
            "description":"Forces the execution",
            "type":"boolean"
        },
        "newOracleHomeLocation":{
            "description":"Path for the new Oracle Home",
            "type":"string"
        },
        "isSkipRemoteHostValidations":{
            "description":"Flag to indicate skipping remote host validations",
            "type":"boolean",
            "default":false
        },
        "isPrerequisitesOnly":{
            "description":"Flag to indicate only prerequisite checks are to be performed",
            "type":"boolean",
            "default":false
        },
        "isSkipValidations":{
            "description":"Flag to indicate skipping the validations",
            "type":"boolean",
            "default":false
        },
        "isEnableDataguard":{
            "description":"Flag to indicate the operation to enable Data Guard role",
            "type":"boolean",
            "default":false
        },
        "isEnableFSFO":{
            "description":"Flag to indicate the operation to enable FSFO",
            "type":"boolean",
            "default":false
        },
        "isDisableDataguard":{
            "description":"Flag to indicate the operation to disable Data Guard role",
            "type":"boolean",
            "default":false
        },
        "standbyStartOption":{
            "description":"Standby start up option after the patch",
            "type":"string"
        },
        "primaryDatabaseHostCredential":{
            "description":"Host credential for the primary database",
            "type":"string"
        },
        "sourceWalletPassword":{
            "description":"Source database wallet password, only for TDE enabled databases",
            "type":"string"
        },
        "destinationWalletPassword":{
            "description":"Destination database wallet password, only for TDE enabled databases",
            "type":"string"
        },
        "startupStandby":{
            "description":"Startup standby",
            "type":"string"
        },
        "drainTimeout":{
            "description":"Drain time out",
            "type":"string"
        },
        "windowsCredential":{
            "description":"Windows credential, only for Windows deployments",
            "type":"string"
        },
        "isVirtualAccount":{
            "description":"Virtual account, only for Windows deployments",
            "type":"boolean"
        },
        "isBuiltinAccount":{
            "description":"Built in account, only for Windows deployments",
            "type":"boolean"
        },
        "isSkipWindowsHomeAccountTypeCheck":{
            "description":"Skip the Windows home account type check",
            "type":"boolean"
        },
        "gimrOperation":{
            "description":"Identifies the Grid Infrastructure Management Repository (GIMR) operation",
            "type":"string"
        },
        "isNonCdbToPdb":{
            "description":"Flag to identify non CDB to PDB operation",
            "type":"boolean"
        },
        "migrateType":{
            "$ref":"#/components/schemas/MigrateTypeEnum"
        },
        "sourceWorkingDirectory":{
            "description":"Working directory on source database",
            "type":"string",
            "example":"/scratch/user/workdir"
        },
        "destinationPdbName":{
            "description":"Destination PDB name",
            "type":"string",
            "example":"hrpdb"
        },
        "destinationCdbCredential":{
            "description":"Destination CDB credential",
            "type":"string",
            "example":"HOST_CDB_CRED:ADMIN"
        },
        "destinationHostCredential":{
            "description":"Destination host credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "parallelism":{
            "description":"Parallelism parameter",
            "type":"string",
            "example":4
        },
        "migrateDatabase":{
            "description":"Indicates the migrate database operation",
            "type":"string"
        },
        "destinationWorkingDirectory":{
            "description":"Working directory in the destination host",
            "type":"string"
        },
        "deleteSourceDatabase":{
            "description":"Indicates if the source database can be deleted",
            "type":"string"
        },
        "destinationPdbDisplayName":{
            "description":"Destination PDB name",
            "type":"string"
        },
        "pdbAdminName":{
            "description":"PDB admin name",
            "type":"string"
        },
        "databaseToPdbData":{
            "description":"Input to convert the database to PDB",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "targetName":{
                        "description":"Name of the target",
                        "type":"string",
                        "example":"db1"
                    },
                    "destinationPdbName":{
                        "type":"string",
                        "example":"pdb1"
                    }
                }
            }
        },
        "auto":{
            "description":"Auto parameter",
            "type":"string"
        },
        "cleanpids":{
            "description":"Clean PIDs",
            "type":"string"
        },
        "databaseList":{
            "description":"Database list",
            "type":"string"
        },
        "disconnect":{
            "description":"Disconnect parameter",
            "type":"string"
        },
        "excludeDatabaseList":{
            "description":"Exclude database list parameter",
            "type":"string"
        },
        "ignoreDatabaseStartError":{
            "description":"Ignore database start error parameter",
            "type":"string"
        },
        "targetNode":{
            "description":"Target node",
            "type":"string"
        },
        "fppOptions":{
            "description":"Additional key, value inputs for FPP operations",
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : updatePdb

Update operation input

Match All

Show Source

• object allOf UpdatePdbOperationInput
  Input for the 'update PDB' operation

{
    "description":"Update operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdatePdbOperationInput"
        }
    ]
}

Nested Schema : UpdatePdbOperationInput

Type: object

Input for the 'update PDB' operation

Show Source

• destinationCdbName: string
  Destination CDB name

  Example: sales_cdb

{
    "description":"Input for the 'update PDB' operation",
    "type":"object",
    "required":[
        "databaseCredential",
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "destinationCdbName":{
            "description":"Destination CDB name",
            "type":"string",
            "example":"sales_cdb"
        }
    }
}

Match All

Show Source

• object allOf PdbPatchingInput
  PDB patching operation common details

{
    "description":"Input for the 'update PDB' operation",
    "type":"object",
    "required":[
        "databaseCredential",
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "destinationCdbName":{
            "description":"Destination CDB name",
            "type":"string",
            "example":"sales_cdb"
        }
    }
}

Nested Schema : upgrade

Upgrade operation input

Match All

Show Source

• object allOf UpgradeOperationInput
  Details for Upgrade operation

{
    "description":"Upgrade operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpgradeOperationInput"
        }
    ]
}

Nested Schema : UpgradeOperationInput

Type: object

Details for Upgrade operation

Show Source

• autoUpgradeAdditionalInput: object AutoUpgradeAdditionalInput
  Additional input for upgrade using auto upgrade tool.

{
    "description":"Details for Upgrade operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateOperationInput"
        }
    ],
    "properties":{
        "autoUpgradeAdditionalInput":{
            "$ref":"#/components/schemas/AutoUpgradeAdditionalInput"
        }
    }
}

Match All

Show Source

• object allOf UpdateOperationInput
  Input for the update operation

{
    "description":"Details for Upgrade operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateOperationInput"
        }
    ],
    "properties":{
        "autoUpgradeAdditionalInput":{
            "$ref":"#/components/schemas/AutoUpgradeAdditionalInput"
        }
    }
}

Nested Schema : upgradePdb

Upgrade PDB operation input

Match All

Show Source

• object allOf PdbPatchingInput
  PDB patching operation common details

{
    "description":"Upgrade PDB operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ]
}

Nested Schema : rollback

Rollback operation input

Match All

Show Source

• object allOf RollbackOperationInput
  Input to create rollback to old Oracle home

{
    "description":"Rollback operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/RollbackOperationInput"
        }
    ]
}

Nested Schema : RollbackOperationInput

Type: object

Input to create rollback to old Oracle home

Show Source

• isdowngradeOperation: boolean
  It should be set to true for downgrade GI / SIHA operations.
• isReportOnly: boolean
  Default Value: false

  Flag indicates report only
• targetName(required): string
  Name of the target

  Example: db1

{
    "description":"Input to create rollback to old Oracle home",
    "required":[
        "name",
        "targetName",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DeployOperationInput"
        }
    ],
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"db1"
        },
        "isdowngradeOperation":{
            "description":"It should be set to true for downgrade GI / SIHA operations.",
            "type":"boolean"
        },
        "isReportOnly":{
            "description":"Flag indicates report only",
            "type":"boolean",
            "default":false
        }
    }
}

Match All

Show Source

• object allOf DeployOperationInput
  Input for 'deploy Oracle home' operation

{
    "description":"Input to create rollback to old Oracle home",
    "required":[
        "name",
        "targetName",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DeployOperationInput"
        }
    ],
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"db1"
        },
        "isdowngradeOperation":{
            "description":"It should be set to true for downgrade GI / SIHA operations.",
            "type":"boolean"
        },
        "isReportOnly":{
            "description":"Flag indicates report only",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : rollbackPdb

Rollback of PDBs operation input

Match All

Show Source

• object allOf RollbackPdbOperationInput
  Rollback PDB details

{
    "description":"Rollback of PDBs operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/RollbackPdbOperationInput"
        }
    ]
}

Nested Schema : RollbackPdbOperationInput

Type: object

Rollback PDB details

Show Source

• isReportOnly: boolean
  Default Value: false

  Flag indicates report only

{
    "description":"Rollback PDB details",
    "type":"object",
    "required":[
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "isReportOnly":{
            "description":"Flag indicates report only",
            "type":"boolean",
            "default":false
        }
    }
}

Match All

Show Source

• object allOf PdbPatchingInput
  PDB patching operation common details

{
    "description":"Rollback PDB details",
    "type":"object",
    "required":[
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PdbPatchingInput"
        }
    ],
    "properties":{
        "isReportOnly":{
            "description":"Flag indicates report only",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : rollbackListener

Rollback of listener operation input

Match All

Show Source

• object allOf MigrateListenerOperationInput
  Input for migrate listener operation

{
    "description":"Rollback of listener operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/MigrateListenerOperationInput"
        }
    ]
}

Nested Schema : cleanup

Cleanup operation input

Match All

Show Source

• object allOf CleanupOperationInput
  Input to cleanup old Oracle home

{
    "description":"Cleanup operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/CleanupOperationInput"
        }
    ]
}

Nested Schema : CleanupOperationInput

Type: object

Input to cleanup old Oracle home

Show Source

• databaseCredential: string
  Database credential

  Example: DB_CRED:ADMIN
• description: string
  Description of the operation

  Example: Clean up database homes
• dispatcherLocation: string
  Location of dispatcher

  Example: /scratch/user/dispatcherLoc
• fppOptions: object fppOptions
  Additional Properties Allowed: true

  Additional key, value inputs for FPP operations
• isForce: boolean
  Default Value: false

  When set to true this flag forces an Oracle Home cleanup to occur even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message in the EM CLI console.
• isReportOnly: boolean
  Default Value: false

  Flag indicates report only
• normalCredential: string
  Normal credential

  Example: HOST_CRED:ADMIN
• privilegeCredential: string
  Privilege credential

  Example: HOST_ROOT_CRED:ADMIN
• workingDirectory(required): string
  Working directory

  Example: /scratch/user/workDir

{
    "description":"Input to cleanup old Oracle home",
    "type":"object",
    "required":[
        "name",
        "targetList",
        "targetType",
        "workingDirectory"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/OperationInput"
        },
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "databaseCredential":{
            "description":"Database credential",
            "type":"string",
            "example":"DB_CRED:ADMIN"
        },
        "isForce":{
            "description":"When set to true this flag forces an Oracle Home cleanup to occur even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message in the EM CLI console.",
            "type":"boolean",
            "default":false
        },
        "isReportOnly":{
            "description":"Flag indicates report only",
            "type":"boolean",
            "default":false
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Location of dispatcher",
            "type":"string",
            "example":"/scratch/user/dispatcherLoc"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string",
            "example":"Clean up database homes"
        },
        "fppOptions":{
            "description":"Additional key, value inputs for FPP operations",
            "type":"object",
            "additionalProperties":true
        }
    }
}

Match All

Show Source

• object OperationInput
  Common Input for operations
• object TargetList
  List of targets

{
    "description":"Input to cleanup old Oracle home",
    "type":"object",
    "required":[
        "name",
        "targetList",
        "targetType",
        "workingDirectory"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/OperationInput"
        },
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "normalCredential":{
            "description":"Normal credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "privilegeCredential":{
            "description":"Privilege credential",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "databaseCredential":{
            "description":"Database credential",
            "type":"string",
            "example":"DB_CRED:ADMIN"
        },
        "isForce":{
            "description":"When set to true this flag forces an Oracle Home cleanup to occur even if there are potential conflicts, like a break within the lineage, with the databases contained within. In its default value of false, should conflicts arise, when performing Oracle Home cleanup the process stops and you see a warning message in the EM CLI console.",
            "type":"boolean",
            "default":false
        },
        "isReportOnly":{
            "description":"Flag indicates report only",
            "type":"boolean",
            "default":false
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "example":"/scratch/user/workDir"
        },
        "dispatcherLocation":{
            "description":"Location of dispatcher",
            "type":"string",
            "example":"/scratch/user/dispatcherLoc"
        },
        "description":{
            "description":"Description of the operation",
            "type":"string",
            "example":"Clean up database homes"
        },
        "fppOptions":{
            "description":"Additional key, value inputs for FPP operations",
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : cleanupCdb

Cleanup CDB operation input

Match All

Show Source

• object allOf CleanupCdbOperationInput
  Input for cleanup of CDB and oracle homes

{
    "description":"Cleanup CDB operation input",
    "allOf":[
        {
            "$ref":"#/components/schemas/CleanupCdbOperationInput"
        }
    ]
}

Nested Schema : CleanupCdbOperationInput

Type: object

Input for cleanup of CDB and oracle homes

Match All

Show Source

• object allOf CleanupOperationInput
  Input to cleanup old Oracle home

{
    "description":"Input for cleanup of CDB and oracle homes",
    "type":"object",
    "required":[
        "name",
        "targetList",
        "targetType",
        "workingDirectory"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/CleanupOperationInput"
        }
    ]
}

Examples

Select an example Payload for Deploy Payload for Upgrade Payload for Upgrade with autoupgade options Payload for Rollback Payload for Rollback DB with Report Only Payload for Cleanup Payload for PDB Patching Payload for Rollback PDB Payload for Rollback PDB with Report Only Payload for Upgrade DB using AutoUpgrade

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted. Fleet operation(s) is(are) submitted.

Body ()

Root Schema : FleetOperationsResult

Type: object

Response of fleet operations

Match Any

Show Source

• object DeployOperationSubmission
  Deploy submission details
• object EmergencyDeployOperationSubmission
  Emergency deploy submission details
• object DeployCdbSubmission
  Deploy CDB submission details
• object AttachCdbSubmission
  Attach CDB submission details
• object UpdateSubmission
  Update submission details
• object UpdatePdbSubmission
  Update PDB submission details
• object UpgradeSubmission
  Upgrade submission details
• object UpgradePdbSubmission
  Upgrade PDB submission details
• object MigrateListenerSubmission
  Migrate listener submission details
• object RollbackSubmission
  Rollback submission details
• object RollbackPdbSubmission
  Rollback PDB submission details
• object RollbackListenerSubmission
  Rollback listener submission details
• object CleanupSubmission
  Cleanup submission details
• object CleanupCdbSubmission
  Cleanup CDB submission details

{
    "description":"Response of fleet operations",
    "type":"object",
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/DeployOperationSubmission"
        },
        {
            "$ref":"#/components/schemas/EmergencyDeployOperationSubmission"
        },
        {
            "$ref":"#/components/schemas/DeployCdbSubmission"
        },
        {
            "$ref":"#/components/schemas/AttachCdbSubmission"
        },
        {
            "$ref":"#/components/schemas/UpdateSubmission"
        },
        {
            "$ref":"#/components/schemas/UpdatePdbSubmission"
        },
        {
            "$ref":"#/components/schemas/UpgradeSubmission"
        },
        {
            "$ref":"#/components/schemas/UpgradePdbSubmission"
        },
        {
            "$ref":"#/components/schemas/MigrateListenerSubmission"
        },
        {
            "$ref":"#/components/schemas/RollbackSubmission"
        },
        {
            "$ref":"#/components/schemas/RollbackPdbSubmission"
        },
        {
            "$ref":"#/components/schemas/RollbackListenerSubmission"
        },
        {
            "$ref":"#/components/schemas/CleanupSubmission"
        },
        {
            "$ref":"#/components/schemas/CleanupCdbSubmission"
        }
    ]
}

Nested Schema : DeployOperationSubmission

Type: object

Deploy submission details

Show Source

• deployDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Deploy submission details",
    "type":"object",
    "properties":{
        "deployDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : EmergencyDeployOperationSubmission

Type: object

Emergency deploy submission details

Show Source

• emergencyDeployDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Emergency deploy submission details",
    "type":"object",
    "properties":{
        "emergencyDeployDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : DeployCdbSubmission

Type: object

Deploy CDB submission details

Show Source

• deployCdbDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Deploy CDB submission details",
    "type":"object",
    "properties":{
        "deployCdbDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : AttachCdbSubmission

Type: object

Attach CDB submission details

Show Source

• attachCdbDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Attach CDB submission details",
    "type":"object",
    "properties":{
        "attachCdbDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : UpdateSubmission

Type: object

Update submission details

Show Source

• updateDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Update submission details",
    "type":"object",
    "properties":{
        "updateDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : UpdatePdbSubmission

Type: object

Update PDB submission details

Show Source

• updatePdbDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Update PDB submission details",
    "type":"object",
    "properties":{
        "updatePdbDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : UpgradeSubmission

Type: object

Upgrade submission details

Show Source

• upgradeDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Upgrade submission details",
    "type":"object",
    "properties":{
        "upgradeDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : UpgradePdbSubmission

Type: object

Upgrade PDB submission details

Show Source

• upgradePdbDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Upgrade PDB submission details",
    "type":"object",
    "properties":{
        "upgradePdbDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : MigrateListenerSubmission

Type: object

Migrate listener submission details

Show Source

• migratelistenerDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Migrate listener submission details",
    "type":"object",
    "properties":{
        "migratelistenerDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : RollbackSubmission

Type: object

Rollback submission details

Show Source

• rollbackDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Rollback submission details",
    "type":"object",
    "properties":{
        "rollbackDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : RollbackPdbSubmission

Type: object

Rollback PDB submission details

Show Source

• rollbackPdbDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Rollback PDB submission details",
    "type":"object",
    "properties":{
        "rollbackPdbDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : RollbackListenerSubmission

Type: object

Rollback listener submission details

Show Source

• rollbackListenerDetails: object FleetOperation
  Response for the fleet operation

{
    "description":"Rollback listener submission details",
    "type":"object",
    "properties":{
        "rollbackListenerDetails":{
            "$ref":"#/components/schemas/FleetOperation"
        }
    }
}

Nested Schema : CleanupSubmission

Type: object

Cleanup submission details

Show Source

• cleanupDetails: object CleanupOperationResult
  Cleanup operation response. Fleet operation validations are not applicable for cleanup and cleanup CDB. Hence validations are not be available under 'submissions'.

{
    "description":"Cleanup submission details",
    "type":"object",
    "properties":{
        "cleanupDetails":{
            "$ref":"#/components/schemas/CleanupOperationResult"
        }
    }
}

Nested Schema : CleanupCdbSubmission

Type: object

Cleanup CDB submission details

Show Source

• cleanupCdbDetails: object CleanUpCdbAndHomesOperationResultCollection
  Response for cleanup CDB and Oracle Homes operation

{
    "description":"Cleanup CDB submission details",
    "type":"object",
    "properties":{
        "cleanupCdbDetails":{
            "$ref":"#/components/schemas/CleanUpCdbAndHomesOperationResultCollection"
        }
    }
}

Nested Schema : FleetOperation

Type: object

Response for the fleet operation

Show Source

• isPrerequisitesOnly: boolean
  Default Value: false

  Indicates if the operation is a prerequisites
• targetSubmissions: array targetSubmissions
  Array of submissions for Targets

{
    "description":"Response for the fleet operation",
    "type":"object",
    "properties":{
        "isPrerequisitesOnly":{
            "description":"Indicates if the operation is a prerequisites",
            "type":"boolean",
            "default":false
        },
        "targetSubmissions":{
            "description":"Array of submissions for Targets",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetSubmissions"
            }
        }
    }
}

Nested Schema : targetSubmissions

Type: array

Array of submissions for Targets

Show Source

• Array of: object TargetSubmissions
  Array of submissions for targets

{
    "description":"Array of submissions for Targets",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetSubmissions"
    }
}

Nested Schema : TargetSubmissions

Type: object

Array of submissions for targets

Show Source

• status: string
  Enum for status
• submissions: array submissions
  Submissions of operation for the target

{
    "description":"Array of submissions for targets",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "submissions":{
            "description":"Submissions of operation for the target",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Submission"
            }
        },
        "status":{
            "$ref":"#/components/schemas/StatusEnum"
        }
    }
}

Match All

Show Source

• object TargetList
  List of targets

{
    "description":"Array of submissions for targets",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "properties":{
        "submissions":{
            "description":"Submissions of operation for the target",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Submission"
            }
        },
        "status":{
            "$ref":"#/components/schemas/StatusEnum"
        }
    }
}

Nested Schema : submissions

Type: array

Submissions of operation for the target

Show Source

• Array of: object Submission
  Submission summary of target for an operation

{
    "description":"Submissions of operation for the target",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Submission"
    }
}

Nested Schema : TargetList

Type: object

List of targets

Show Source

• targetList: array targetList
  Array of target names
• targetType: string
  Target type

  Example: oracle_database

{
    "description":"List of targets",
    "type":"object",
    "properties":{
        "targetList":{
            "description":"Array of target names",
            "type":"array",
            "items":{
                "type":"string",
                "example":"db1, db2"
            }
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Nested Schema : Submission

Type: object

Submission summary of target for an operation

Show Source

• messages: string
  Messages of submission

{
    "description":"Submission summary of target for an operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/TargetValidation"
        },
        {
            "$ref":"#/components/schemas/SubmissionError"
        }
    ],
    "properties":{
        "messages":{
            "description":"Messages of submission",
            "type":"string"
        }
    }
}

Match All

Show Source

• object TargetList
  List of targets

{
    "description":"Submission summary of target for an operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/TargetValidation"
        },
        {
            "$ref":"#/components/schemas/SubmissionError"
        }
    ],
    "properties":{
        "messages":{
            "description":"Messages of submission",
            "type":"string"
        }
    }
}

Match Any

Show Source

• object TargetValidation
  Fleet operation target validation results
• object SubmissionError
  Submission error details

{
    "description":"Submission summary of target for an operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ],
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/TargetValidation"
        },
        {
            "$ref":"#/components/schemas/SubmissionError"
        }
    ],
    "properties":{
        "messages":{
            "description":"Messages of submission",
            "type":"string"
        }
    }
}

Nested Schema : TargetValidation

Type: object

Fleet operation target validation results

Show Source

• links: object links
  Links of procedure execution and tracking
• status: string
  Enum for status
• validations: array validations
  Array of validation results

{
    "description":"Fleet operation target validation results",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ValidationSummary"
        }
    ],
    "properties":{
        "validations":{
            "type":"array",
            "description":"Array of validation results",
            "items":{
                "$ref":"#/components/schemas/Validation"
            }
        },
        "status":{
            "$ref":"#/components/schemas/StatusEnum"
        },
        "links":{
            "description":"Links of procedure execution and tracking",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProcedureLink"
                },
                {
                    "$ref":"#/components/schemas/TrackingLink"
                }
            ]
        }
    }
}

Match All

Show Source

• object ValidationSummary
  Validation result summary

{
    "description":"Fleet operation target validation results",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ValidationSummary"
        }
    ],
    "properties":{
        "validations":{
            "type":"array",
            "description":"Array of validation results",
            "items":{
                "$ref":"#/components/schemas/Validation"
            }
        },
        "status":{
            "$ref":"#/components/schemas/StatusEnum"
        },
        "links":{
            "description":"Links of procedure execution and tracking",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProcedureLink"
                },
                {
                    "$ref":"#/components/schemas/TrackingLink"
                }
            ]
        }
    }
}

Nested Schema : SubmissionError

Type: object

Submission error details

Show Source

• errorMessages: string
  Error message for the failed submission
• status: string
  Status of the submission

{
    "description":"Submission error details",
    "properties":{
        "status":{
            "description":"Status of the submission",
            "type":"string"
        },
        "errorMessages":{
            "description":"Error message for the failed submission",
            "type":"string"
        }
    }
}

Nested Schema : targetList

Type: array

Array of target names

Show Source

• Array of: string
  Example: db1, db2

{
    "description":"Array of target names",
    "type":"array",
    "items":{
        "type":"string",
        "example":"db1, db2"
    }
}

Nested Schema : links

Type: object

Links of procedure execution and tracking

Match All

Show Source

• object ProcedureLink
  Represents a link to the deployment procedure execution
• object TrackingLink
  Represents a link to the REST API to track status

{
    "description":"Links of procedure execution and tracking",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProcedureLink"
        },
        {
            "$ref":"#/components/schemas/TrackingLink"
        }
    ]
}

Nested Schema : validations

Type: array

Array of validation results

Show Source

• Array of: object Validation
  Validation details

{
    "type":"array",
    "description":"Array of validation results",
    "items":{
        "$ref":"#/components/schemas/Validation"
    }
}

Nested Schema : ValidationSummary

Type: object

Validation result summary

Show Source

• failed: integer
  Total count of failed validations

  Example: 0
• submitted: integer
  0 Indicates the deployment procedure for the validation is not submitted, 1 indicates the deployment procedure for the validation is submitted

  Example: 0
• succeeded: integer
  Total count of succeeded validations

  Example: 8
• totalValidations: integer
  Total count of validations

  Example: 8
• warnings: integer
  Total count of warnings

  Example: 0

{
    "description":"Validation result summary",
    "properties":{
        "totalValidations":{
            "description":"Total count of validations",
            "type":"integer",
            "example":8
        },
        "succeeded":{
            "description":"Total count of succeeded validations",
            "type":"integer",
            "example":8
        },
        "failed":{
            "description":"Total count of failed validations",
            "type":"integer",
            "example":0
        },
        "warnings":{
            "description":"Total count of warnings",
            "type":"integer",
            "example":0
        },
        "submitted":{
            "description":"0 Indicates the deployment procedure for the validation is not submitted, 1 indicates the deployment procedure for the validation is submitted",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : ProcedureLink

Type: object

Represents a link to the deployment procedure execution

Show Source

• procedureExecution: object procedureExecution
  Web URL to poll status of the deployment procedure execution

{
    "type":"object",
    "description":"Represents a link to the deployment procedure execution",
    "properties":{
        "procedureExecution":{
            "description":"Web URL to poll status of the deployment procedure execution",
            "type":"object",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"URL for link",
                    "example":"https://myhost.com:4473/em/faces/core-jobs-procedureExecutionTracking?executionGUID=E6E32C11DC0A6E8DE05380FE4564A6B2"
                }
            }
        }
    }
}

Nested Schema : TrackingLink

Type: object

Represents a link to the REST API to track status

Show Source

• tracking: object tracking
  Tracking URL to poll status of the deployment procedure execution

{
    "type":"object",
    "description":"Represents a link to the REST API to track status",
    "properties":{
        "tracking":{
            "description":"Tracking URL to poll status of the deployment procedure execution",
            "type":"object",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"URL for the link",
                    "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                }
            }
        }
    }
}

Nested Schema : procedureExecution

Type: object

Web URL to poll status of the deployment procedure execution

Show Source

• href: string
  URL for link

  Example: https://myhost.com:4473/em/faces/core-jobs-procedureExecutionTracking?executionGUID=E6E32C11DC0A6E8DE05380FE4564A6B2

{
    "description":"Web URL to poll status of the deployment procedure execution",
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for link",
            "example":"https://myhost.com:4473/em/faces/core-jobs-procedureExecutionTracking?executionGUID=E6E32C11DC0A6E8DE05380FE4564A6B2"
        }
    }
}

Nested Schema : tracking

Type: object

Tracking URL to poll status of the deployment procedure execution

Show Source

• href: string
  URL for the link

  Example: /deploymentProcedureInstances/{deploymentProcedureInstanceId}

{
    "description":"Tracking URL to poll status of the deployment procedure execution",
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link",
            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
        }
    }
}

Nested Schema : Validation

Type: object

Validation details

Show Source

• description: string
  Description of the validation

  Example: Verfied that the EM user has "configure target" privileges on the target.
• id: string
  ID of the validation

  Example: CONFIG_TARGET_USER_PRIV_VALIDATION
• links: object links
  Links of procedure execution and tracking
• name: string
  Name of the validation

  Example: Configure target privilege validation
• status: string
  Enum for validation status

  Example: success

{
    "description":"Validation details",
    "properties":{
        "id":{
            "description":"ID of the validation",
            "type":"string",
            "example":"CONFIG_TARGET_USER_PRIV_VALIDATION"
        },
        "name":{
            "description":"Name of the validation",
            "type":"string",
            "example":"Configure target privilege validation"
        },
        "status":{
            "$ref":"#/components/schemas/ValidationStatusEnum"
        },
        "description":{
            "description":"Description of the validation",
            "type":"string",
            "example":"Verfied that the EM user has \"configure target\" privileges on the target."
        },
        "links":{
            "description":"Links of procedure execution and tracking",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProcedureLink"
                },
                {
                    "$ref":"#/components/schemas/TrackingLink"
                }
            ]
        }
    }
}

Nested Schema : links

Type: object

Links of procedure execution and tracking

Match All

Show Source

• object ProcedureLink
  Represents a link to the deployment procedure execution
• object TrackingLink
  Represents a link to the REST API to track status

{
    "description":"Links of procedure execution and tracking",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProcedureLink"
        },
        {
            "$ref":"#/components/schemas/TrackingLink"
        }
    ]
}

Nested Schema : CleanupOperationResult

Type: object

Cleanup operation response. Fleet operation validations are not applicable for cleanup and cleanup CDB. Hence validations are not be available under 'submissions'.

Match All

Show Source

• object FleetOperation
  Response for the fleet operation
• object CleanupReport
  Response for CleanUp Oracle Home Operation

{
    "description":"Cleanup operation response. Fleet operation validations are not applicable for cleanup and cleanup CDB. Hence validations are not be available under 'submissions'.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FleetOperation"
        },
        {
            "$ref":"#/components/schemas/CleanupReport"
        }
    ]
}

Nested Schema : CleanupReport

Type: object

Response for CleanUp Oracle Home Operation

Show Source

• report: object report
  CleanUp Report

{
    "description":"Response for CleanUp Oracle Home Operation",
    "properties":{
        "report":{
            "description":"CleanUp Report",
            "type":"object",
            "properties":{
                "countEligibleOracleHomes":{
                    "description":"Eligible Oracle Homes count",
                    "type":"integer"
                },
                "countIneligibleOracleHomes":{
                    "description":"InEligible Oracle Homes count",
                    "type":"integer"
                },
                "eligibleOracleHomes":{
                    "description":"Eligible Oracle Homes",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/OracleHomeDetails"
                    }
                },
                "ineligibleOracleHomes":{
                    "description":"InEligible Oracle Homes",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/OracleHomeDetails"
                    }
                },
                "message":{
                    "description":"Report related message",
                    "type":"string",
                    "example":"Report Generated Successfully"
                }
            }
        }
    }
}

Nested Schema : report

Type: object

CleanUp Report

Show Source

• countEligibleOracleHomes: integer
  Eligible Oracle Homes count
• countIneligibleOracleHomes: integer
  InEligible Oracle Homes count
• eligibleOracleHomes: array eligibleOracleHomes
  Eligible Oracle Homes
• ineligibleOracleHomes: array ineligibleOracleHomes
  InEligible Oracle Homes
• message: string
  Report related message

  Example: Report Generated Successfully

{
    "description":"CleanUp Report",
    "type":"object",
    "properties":{
        "countEligibleOracleHomes":{
            "description":"Eligible Oracle Homes count",
            "type":"integer"
        },
        "countIneligibleOracleHomes":{
            "description":"InEligible Oracle Homes count",
            "type":"integer"
        },
        "eligibleOracleHomes":{
            "description":"Eligible Oracle Homes",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OracleHomeDetails"
            }
        },
        "ineligibleOracleHomes":{
            "description":"InEligible Oracle Homes",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OracleHomeDetails"
            }
        },
        "message":{
            "description":"Report related message",
            "type":"string",
            "example":"Report Generated Successfully"
        }
    }
}

Nested Schema : eligibleOracleHomes

Type: array

Eligible Oracle Homes

Show Source

• Array of: object OracleHomeDetails
  Oracle Home details

{
    "description":"Eligible Oracle Homes",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OracleHomeDetails"
    }
}

Nested Schema : ineligibleOracleHomes

Type: array

InEligible Oracle Homes

Show Source

• Array of: object OracleHomeDetails
  Oracle Home details

{
    "description":"InEligible Oracle Homes",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OracleHomeDetails"
    }
}

Nested Schema : OracleHomeDetails

Type: object

Oracle Home details

Show Source

• countAssociatedTargets: integer
  Associated targets count
• homeLocation: string
  Location of Oracle Home

  Example: /scratch/cuser/deployedHome
• hostName: string
  Host of Oracle home

  Example: myhost.com
• targetName: string
  Name of the target

  Example: db1

{
    "description":"Oracle Home details",
    "type":"object",
    "properties":{
        "hostName":{
            "description":"Host of Oracle home",
            "type":"string",
            "example":"myhost.com"
        },
        "homeLocation":{
            "description":"Location of Oracle Home",
            "type":"string",
            "example":"/scratch/cuser/deployedHome"
        },
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"db1"
        },
        "countAssociatedTargets":{
            "description":"Associated targets count",
            "type":"integer"
        }
    }
}

Nested Schema : CleanUpCdbAndHomesOperationResultCollection

Type: object

Response for cleanup CDB and Oracle Homes operation

Match All

Show Source

• object FleetOperation
  Response for the fleet operation
• object CleanupCdbReport
  Report for Cleanup CDB and Homes

{
    "description":"Response for cleanup CDB and Oracle Homes operation",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FleetOperation"
        },
        {
            "$ref":"#/components/schemas/CleanupCdbReport"
        }
    ]
}

Nested Schema : CleanupCdbReport

Type: object

Report for Cleanup CDB and Homes

Show Source

• report: object report
  Cleanup CDB Report

{
    "type":"object",
    "description":"Report for Cleanup CDB and Homes",
    "properties":{
        "report":{
            "description":"Cleanup CDB Report",
            "type":"object",
            "properties":{
                "countEligibleCdbs":{
                    "description":"Eligible CDBs count",
                    "type":"integer"
                },
                "countIneligibleCdbs":{
                    "description":"Ineligible CDBs count",
                    "type":"integer"
                },
                "eligibleCdbs":{
                    "description":"Eligible CDBs",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CdbDetails"
                    }
                },
                "ineligibleCdbs":{
                    "description":"Ineligible CDBs",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CdbDetails"
                    }
                },
                "countIneligibleOracleHomes":{
                    "description":"Ineligible Oracle Homes count",
                    "type":"integer"
                },
                "countEligibleOracleHomes":{
                    "description":"Eligible Oracle Homes count",
                    "type":"integer"
                },
                "eligibleOracleHomes":{
                    "description":"Eligible Oracle Homes",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/OracleHomeDetails"
                    }
                },
                "ineligibleOracleHomes":{
                    "description":"InEligible Homes",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/OracleHomeDetails"
                    }
                },
                "message":{
                    "description":"Report related message",
                    "type":"string",
                    "example":"Report Generated Successfully"
                }
            }
        }
    }
}

Nested Schema : report

Type: object

Cleanup CDB Report

Show Source

• countEligibleCdbs: integer
  Eligible CDBs count
• countEligibleOracleHomes: integer
  Eligible Oracle Homes count
• countIneligibleCdbs: integer
  Ineligible CDBs count
• countIneligibleOracleHomes: integer
  Ineligible Oracle Homes count
• eligibleCdbs: array eligibleCdbs
  Eligible CDBs
• eligibleOracleHomes: array eligibleOracleHomes
  Eligible Oracle Homes
• ineligibleCdbs: array ineligibleCdbs
  Ineligible CDBs
• ineligibleOracleHomes: array ineligibleOracleHomes
  InEligible Homes
• message: string
  Report related message

  Example: Report Generated Successfully

{
    "description":"Cleanup CDB Report",
    "type":"object",
    "properties":{
        "countEligibleCdbs":{
            "description":"Eligible CDBs count",
            "type":"integer"
        },
        "countIneligibleCdbs":{
            "description":"Ineligible CDBs count",
            "type":"integer"
        },
        "eligibleCdbs":{
            "description":"Eligible CDBs",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CdbDetails"
            }
        },
        "ineligibleCdbs":{
            "description":"Ineligible CDBs",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CdbDetails"
            }
        },
        "countIneligibleOracleHomes":{
            "description":"Ineligible Oracle Homes count",
            "type":"integer"
        },
        "countEligibleOracleHomes":{
            "description":"Eligible Oracle Homes count",
            "type":"integer"
        },
        "eligibleOracleHomes":{
            "description":"Eligible Oracle Homes",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OracleHomeDetails"
            }
        },
        "ineligibleOracleHomes":{
            "description":"InEligible Homes",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OracleHomeDetails"
            }
        },
        "message":{
            "description":"Report related message",
            "type":"string",
            "example":"Report Generated Successfully"
        }
    }
}

Nested Schema : eligibleCdbs

Type: array

Eligible CDBs

Show Source

• Array of: object CdbDetails
  CDB details

{
    "description":"Eligible CDBs",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CdbDetails"
    }
}

Nested Schema : eligibleOracleHomes

Type: array

Eligible Oracle Homes

Show Source

• Array of: object OracleHomeDetails
  Oracle Home details

{
    "description":"Eligible Oracle Homes",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OracleHomeDetails"
    }
}

Nested Schema : ineligibleCdbs

Type: array

Ineligible CDBs

Show Source

• Array of: object CdbDetails
  CDB details

{
    "description":"Ineligible CDBs",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CdbDetails"
    }
}

Nested Schema : ineligibleOracleHomes

Type: array

InEligible Homes

Show Source

• Array of: object OracleHomeDetails
  Oracle Home details

{
    "description":"InEligible Homes",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OracleHomeDetails"
    }
}

Nested Schema : CdbDetails

Type: object

CDB details

Show Source

• countAssociatedPdbs: integer
  Associated PDBs count
• hostName: string
  Host of Oracle home

  Example: myhost.com
• id: string
  ID of a CDB target

  Example: EF17D657C6AD7C1BE05375FD4564B913
• name: string
  Name of a CDB

  Example: cdb1
• oracleHomeLocation: string
  Oracle home path

  Example: /scratch/cuser/deployedHome

{
    "description":"CDB details",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of a CDB target",
            "type":"string",
            "example":"EF17D657C6AD7C1BE05375FD4564B913"
        },
        "name":{
            "description":"Name of a CDB",
            "type":"string",
            "example":"cdb1"
        },
        "hostName":{
            "description":"Host of Oracle home",
            "type":"string",
            "example":"myhost.com"
        },
        "oracleHomeLocation":{
            "description":"Oracle home path",
            "type":"string",
            "example":"/scratch/cuser/deployedHome"
        },
        "countAssociatedPdbs":{
            "description":"Associated PDBs count",
            "type":"integer"
        }
    }
}

Examples

Select an example Payload for Deploy Payload for Upgrade Payload for Rollback Payload for Rollback DB with Report Only Payload for Cleanup Payload for Rollback PDB Payload for Rollback PDB with Report Only

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top