Jump to

• Request
• Response

Configure Backup

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/{databaseId}/actions/configureBackup

Configures database backup to the specified destination media. If the selected destination is an Oracle Zero Data Loss Recovery Appliance, then you must enable the ZDLRA Management Pack on the Recovery Appliance to use this API.

Request

Path Parameters

• databaseId(required): string
  Database Target GUID.

  Example:

  BD01EACD2378730AE053178145645588

Header Parameters

• ORCL-EM-DBTARGET-AUTHORIZATION(required):
  Database credentials used to connect to the databases.
• ORCL-EM-HOSTTARGET-AUTHORIZATION(required):
  Host credentials that are operating system credentials used to perform database backup and recovery operations.
• ORCL-EM-OCITARGET-AUTHORIZATION(required):
  Oracle Cloud Infrastructure credentials.
• ORCL-EM-RTUTARGET-AUTHORIZATION:
  Named credentials for Redo Transport User password.
• ORCL-EM-TDEWALLETTARGET-AUTHORIZATION:
  Named credentials for password protected TDE wallet.
• ORCL-EM-WALLETTARGET-AUTHORIZATION:
  Named credentials for password protected backup wallet.
• ORCL_EM_PROXYTARGET_AUTHORIZATION:
  Named credentials for Proxy Target Authorization.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Configure Backup Details.

Show Source

• backupConfiguration: object Discriminator: destinationMediaType
  Discriminator: { "propertyName":"destinationMediaType", "mapping":{ "OCI":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings", "RA":"#/components/schemas/ConfigBackupDetailsRA" } }

  Contains details of the backup configuration submitted.

{
    "type":"object",
    "description":"Configure Backup Details.",
    "properties":{
        "backupConfiguration":{
            "type":"object",
            "description":"Contains details of the backup configuration submitted.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings"
                },
                {
                    "$ref":"#/components/schemas/ConfigBackupDetailsRA"
                }
            ],
            "discriminator":{
                "propertyName":"destinationMediaType",
                "mapping":{
                    "OCI":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings",
                    "RA":"#/components/schemas/ConfigBackupDetailsRA"
                }
            }
        }
    }
}

Nested Schema : Discriminator: destinationMediaType

Type: object

Discriminator: destinationMediaType

Discriminator Values

• OCI
• RA

{
    "type":"object",
    "description":"Contains details of the backup configuration submitted.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings"
        },
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsRA"
        }
    ],
    "discriminator":{
        "propertyName":"destinationMediaType",
        "mapping":{
            "OCI":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings",
            "RA":"#/components/schemas/ConfigBackupDetailsRA"
        }
    }
}

Contains details of the backup configuration submitted.

Match One Schema

Show Source

• OCI - object ConfigBackupDetailsOCIWithOCIMediaSettings
  Configure Backup Details For Oracle Cloud Infrastructure.
• RA - object ConfigBackupDetailsRA
  Configure Backup Details for Recovery Appliance.

{
    "type":"object",
    "description":"Contains details of the backup configuration submitted.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings"
        },
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsRA"
        }
    ],
    "discriminator":{
        "propertyName":"destinationMediaType",
        "mapping":{
            "OCI":"#/components/schemas/ConfigBackupDetailsOCIWithOCIMediaSettings",
            "RA":"#/components/schemas/ConfigBackupDetailsRA"
        }
    }
}

Nested Schema : ConfigBackupDetailsOCIWithOCIMediaSettings

Type: object

Configure Backup Details For Oracle Cloud Infrastructure.

Show Source

• advanced: object advanced
  Advanced parameters.
• compartmentOCID(required): string
  Container OCID.

  Example: ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq
• destinationMediaType(required): string
  Destination media type.

  Example: OCI
• isOCIBucketImmutable: boolean
  Specifies if the bucket specified is an immutable bucket.

  Example: true
• ociBucket(required): string
  Bucket.

  Example: Backup1
• ociEndPoint(required): string
  API EndPoint.

  Example: https://objectstorage.us-ashburn-1.oraclecloud.com
• tempMetadataOCIBucket: string
  Temporary metadata bucket that will be used to store objects that need to be updated or deleted during backup if the ociBucket specified is an immutable bucket.

  Example: tempBucket1

{
    "description":"Configure Backup Details For Oracle Cloud Infrastructure.",
    "type":"object",
    "required":[
        "destinationMediaType",
        "ociEndPoint",
        "ociBucket",
        "compartmentOCID"
    ],
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"OCI"
        },
        "ociEndPoint":{
            "type":"string",
            "description":"API EndPoint.",
            "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
        },
        "ociBucket":{
            "type":"string",
            "description":"Bucket.",
            "example":"Backup1"
        },
        "tempMetadataOCIBucket":{
            "type":"string",
            "description":"Temporary metadata bucket that will be used to store objects that need to be updated or deleted during backup if the ociBucket specified is an immutable bucket.",
            "example":"tempBucket1"
        },
        "isOCIBucketImmutable":{
            "type":"boolean",
            "description":"Specifies if the bucket specified is an immutable bucket.",
            "example":true
        },
        "compartmentOCID":{
            "type":"string",
            "description":"Container OCID.",
            "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
        },
        "advanced":{
            "type":"object",
            "description":"Advanced parameters.",
            "properties":{
                "parallelism":{
                    "type":"number",
                    "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
                    "example":1
                },
                "installerArgs":{
                    "type":"array",
                    "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
                    "items":{
                        "type":"string",
                        "example":"-newRSAKeyPair true"
                    },
                    "example":[
                        "-newRSAKeyPair true",
                        "-libPlatform linux64"
                    ]
                },
                "skipConfiguredDbs":{
                    "type":"boolean",
                    "description":"Specifies if databases that are already configured to backup to the specified destination media should be skipped.",
                    "example":true
                },
                "forceSerialExecution":{
                    "type":"boolean",
                    "description":"Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.",
                    "example":true
                },
                "proxyHost":{
                    "type":"string",
                    "description":"Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
                },
                "proxyPort":{
                    "type":"integer",
                    "description":"Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
                }
            }
        }
    }
}

Nested Schema : ConfigBackupDetailsRA

Type: object

Configure Backup Details for Recovery Appliance.

Show Source

• advanced: object advanced
  Advanced parameters.
• backupConfig: string
  Allowed Values: [ "NO_DG", "ALL_DG", "SPECIFIED_DB_DG" ]

  Backup configuration.

  Example: ALL_DG
• backupModuleParameters: object backupModuleParameters
  Backup module related parameters.
• destinationMediaType(required): string
  Destination media type.

  Example: RA
• isDatabaseRestartPermitted: boolean
  Specifies where it is permitted to restart the database if required by the configuration procedure.

  Example: false
• isEncryptRedo: boolean
  Specifies if the real-time redo has to be encrypted.

  Example: true
• isShipRedo: boolean
  Specifies if the real-time redo has to be shipped.

  Example: true
• isSkipControlfileAutobackup: boolean
  Specifies if control file backup should be skipped.

  Example: true
• isUpdateSnapshotControlfileLoc: boolean
  Specifies if snapshot control file should be updated.

  Example: false
• protocol: string
  Allowed Values: [ "TCP", "TCPS" ]

  Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.

  Example: TCP
• walletParameters: object walletParameters
  Wallet related parameters.

{
    "description":"Configure Backup Details for Recovery Appliance.",
    "type":"object",
    "required":[
        "destinationMediaType"
    ],
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"RA"
        },
        "isShipRedo":{
            "type":"boolean",
            "description":"Specifies if the real-time redo has to be shipped.",
            "example":true
        },
        "isEncryptRedo":{
            "type":"boolean",
            "description":"Specifies if the real-time redo has to be encrypted.",
            "example":true
        },
        "isSkipControlfileAutobackup":{
            "type":"boolean",
            "description":"Specifies if control file backup should be skipped.",
            "example":true
        },
        "isUpdateSnapshotControlfileLoc":{
            "type":"boolean",
            "description":"Specifies if snapshot control file should be updated.",
            "example":false
        },
        "isDatabaseRestartPermitted":{
            "type":"boolean",
            "description":"Specifies where it is permitted to restart the database if required by the configuration procedure.",
            "example":false
        },
        "backupConfig":{
            "type":"string",
            "description":"Backup configuration.",
            "example":"ALL_DG",
            "enum":[
                "NO_DG",
                "ALL_DG",
                "SPECIFIED_DB_DG"
            ]
        },
        "protocol":{
            "type":"string",
            "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "walletParameters":{
            "type":"object",
            "description":"Wallet related parameters.",
            "properties":{
                "walletLocation":{
                    "type":"string",
                    "description":"Wallet location.",
                    "example":"$ORACLE_HOME/dbs/wallet"
                },
                "isUpdateSQLNet":{
                    "type":"boolean",
                    "description":"Specifies if the SQLNET.WALLET_LOCATION has to be updated.",
                    "example":false
                },
                "isUpdateCRSEnv":{
                    "type":"boolean",
                    "description":"Specifies if the required environment variables (ORACLE_HOME, ORACLE_BASE, DB_UNIQUE_NAME, ORACLE_UNQNAME) should be updated in Cluster Ready Services (CRS) via the SRVCTL command.",
                    "example":false
                },
                "isSetWalletRoot":{
                    "type":"boolean",
                    "description":"Specifies if the WALLET_ROOT database initialization parameter has be set.",
                    "example":false
                }
            }
        },
        "backupModuleParameters":{
            "type":"object",
            "description":"Backup module related parameters.",
            "properties":{
                "isDownloadBackupModule":{
                    "type":"boolean",
                    "description":"Specifies if the latest backup module has to be downloaded into the Software Library.",
                    "example":false
                },
                "isForceInstallBackupModule":{
                    "type":"boolean",
                    "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
                    "example":false
                },
                "moduleLocation":{
                    "type":"string",
                    "description":"Cutom location of the backup module. Default is $ORACLE_HOME/lib.",
                    "example":"$ORACLE_HOME/lib"
                }
            }
        },
        "advanced":{
            "type":"object",
            "description":"Advanced parameters.",
            "properties":{
                "parallelism":{
                    "type":"number",
                    "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
                    "example":1
                }
            }
        }
    }
}

Nested Schema : advanced

Type: object

Advanced parameters.

Show Source

• forceSerialExecution: boolean
  Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.

  Example: true
• installerArgs: array installerArgs
  Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.
• parallelism: number
  Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.

  Example: 1
• proxyHost: string
  Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host.
• proxyPort: integer
  Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host.
• skipConfiguredDbs: boolean
  Specifies if databases that are already configured to backup to the specified destination media should be skipped.

  Example: true

{
    "type":"object",
    "description":"Advanced parameters.",
    "properties":{
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
            "example":1
        },
        "installerArgs":{
            "type":"array",
            "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
            "items":{
                "type":"string",
                "example":"-newRSAKeyPair true"
            },
            "example":[
                "-newRSAKeyPair true",
                "-libPlatform linux64"
            ]
        },
        "skipConfiguredDbs":{
            "type":"boolean",
            "description":"Specifies if databases that are already configured to backup to the specified destination media should be skipped.",
            "example":true
        },
        "forceSerialExecution":{
            "type":"boolean",
            "description":"Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.",
            "example":true
        },
        "proxyHost":{
            "type":"string",
            "description":"Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
        },
        "proxyPort":{
            "type":"integer",
            "description":"Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
        }
    }
}

Nested Schema : installerArgs

Type: array

Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.

Show Source

• Array of: string
  Example: -newRSAKeyPair true

{
    "type":"array",
    "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
    "items":{
        "type":"string",
        "example":"-newRSAKeyPair true"
    },
    "example":[
        "-newRSAKeyPair true",
        "-libPlatform linux64"
    ]
}

Example:

[
    "-newRSAKeyPair true",
    "-libPlatform linux64"
]

Nested Schema : advanced

Type: object

Advanced parameters.

Show Source

• parallelism: number
  Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.

  Example: 1

{
    "type":"object",
    "description":"Advanced parameters.",
    "properties":{
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
            "example":1
        }
    }
}

Nested Schema : backupModuleParameters

Type: object

Backup module related parameters.

Show Source

• isDownloadBackupModule: boolean
  Specifies if the latest backup module has to be downloaded into the Software Library.

  Example: false
• isForceInstallBackupModule: boolean
  Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.

  Example: false
• moduleLocation: string
  Cutom location of the backup module. Default is $ORACLE_HOME/lib.

  Example: $ORACLE_HOME/lib

{
    "type":"object",
    "description":"Backup module related parameters.",
    "properties":{
        "isDownloadBackupModule":{
            "type":"boolean",
            "description":"Specifies if the latest backup module has to be downloaded into the Software Library.",
            "example":false
        },
        "isForceInstallBackupModule":{
            "type":"boolean",
            "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
            "example":false
        },
        "moduleLocation":{
            "type":"string",
            "description":"Cutom location of the backup module. Default is $ORACLE_HOME/lib.",
            "example":"$ORACLE_HOME/lib"
        }
    }
}

Nested Schema : walletParameters

Type: object

Wallet related parameters.

Show Source

• isSetWalletRoot: boolean
  Specifies if the WALLET_ROOT database initialization parameter has be set.

  Example: false
• isUpdateCRSEnv: boolean
  Specifies if the required environment variables (ORACLE_HOME, ORACLE_BASE, DB_UNIQUE_NAME, ORACLE_UNQNAME) should be updated in Cluster Ready Services (CRS) via the SRVCTL command.

  Example: false
• isUpdateSQLNet: boolean
  Specifies if the SQLNET.WALLET_LOCATION has to be updated.

  Example: false
• walletLocation: string
  Wallet location.

  Example: $ORACLE_HOME/dbs/wallet

{
    "type":"object",
    "description":"Wallet related parameters.",
    "properties":{
        "walletLocation":{
            "type":"string",
            "description":"Wallet location.",
            "example":"$ORACLE_HOME/dbs/wallet"
        },
        "isUpdateSQLNet":{
            "type":"boolean",
            "description":"Specifies if the SQLNET.WALLET_LOCATION has to be updated.",
            "example":false
        },
        "isUpdateCRSEnv":{
            "type":"boolean",
            "description":"Specifies if the required environment variables (ORACLE_HOME, ORACLE_BASE, DB_UNIQUE_NAME, ORACLE_UNQNAME) should be updated in Cluster Ready Services (CRS) via the SRVCTL command.",
            "example":false
        },
        "isSetWalletRoot":{
            "type":"boolean",
            "description":"Specifies if the WALLET_ROOT database initialization parameter has be set.",
            "example":false
        }
    }
}

Examples

Select an example OCI Object Storage Recovery Appliance

Back to Top

Response

Supported Media Types

• application/json

202 Response

Execution details of the deployment procedure submitted.

Headers

• Content-Location:
  Status of the deployment procedure submitted can be viewed in this location.

Body ()

Root Schema : DatabaseBackupResponse

Type: object

Response of the operation submitted.

Show Source

• executionId(required): string
  Deployment procedure execution ID.

  Example: DE8676BE8CD73086E053DE0D4B64D288
• location: string
  URI to verify the status of the deployment procedure submitted.

  Example: /em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288
• procedureId(required): string
  Deployment procedure submission ID.

  Example: DE8676BE8CD73086E053DE0D4B64D288
• submissionBy(required): string
  User that submitted the deployment procedure.

  Example: SYSMAN
• submissionName(required): string
  Name of the deployment procedure submitted.

  Example: BACKUP_RA_CONFIG_121222220321

{
    "description":"Response of the operation submitted.",
    "type":"object",
    "required":[
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId"
    ],
    "properties":{
        "submissionName":{
            "description":"Name of the deployment procedure submitted.",
            "type":"string",
            "example":"BACKUP_RA_CONFIG_121222220321"
        },
        "submissionBy":{
            "description":"User that submitted the deployment procedure.",
            "type":"string",
            "example":"SYSMAN"
        },
        "executionId":{
            "description":"Deployment procedure execution ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "procedureId":{
            "description":"Deployment procedure submission ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "location":{
            "description":"URI to verify the status of the deployment procedure submitted.",
            "type":"string",
            "example":"/em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

401 Response

Client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

404 Response

Resource not found or not authorized for access

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

503 Response

Indicates that a required service is not available

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

Back to Top