REST API for Oracle Enterprise Manager

Get Protected Database Details

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectedDatabases/{protectedDatabaseName}

Get details of a protected database on a Recovery Appliance.

Request

Path Parameters

protectedDatabaseName(required): string
Protected database unique name or target name. If the value specified is a database target name in Enterprise Manager, then targetType parameter must also be specified in the URL. If targetType is not specified, this name will be assumed to be the protected database unique name.
Example:
```
PROTDB1
```
raTargetId(required): string
Recovery Appliance Target id.
Example:
```
F76BBCCBD8A0D4719A8AA588375FA8BE
```

Query Parameters

targetType: string
Protected Database target type. This can be oracle_database or rac_database. If this parameter is not specified, the protectedDatabaseName specified will be assumed to be the protected database unique name.
Example:
```
oracle_database
```

Header Parameters

ORCL-EM-ZDLRATARGET-AUTHORIZATION(required): string
Recovery Appliance Administrator Credentials. The format must be NAMED: (e.g. NAMED:ORSADMIN) or PREFERRED: (e.g. PREFERRED:PREF_ORSADMIN). If no value is specified, the system will use preferred credentials.
Example:
```
NAMED:ORSADMIN
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful Operation

Root Schema : ProtectedDatabase

Type: object

Protected database properties.

Show Source

allowBackupDeletion: string

The setting that controls whether RMAN backups for databases that use this protection policy can be deleted.
backupRedoFailover: string

Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy.
copyToCloudEnabled: string

Enabled (YES) or disabled (NO) of copy-to-cloud operation for this database.
copyToTapeEnabled: string

Enabled (YES) or disabled (NO) of copy-to-tape operation for this database.
creationTime: string

The time of task creation.
databaseKey: string

The primary key for this database in the Recovery Appliance metadata database.
databaseSize: string

Database size.
databaseVersion: string

Database version.
dbid: string

The DBID for this protected database.
dbUniqueName: string

Database unique name.
deduplicationFactor: string

The ratio of the total size of virtual full backups to the actual consumed space on the appliance for this protected database.
deleting: string

YES if this database is currently being deleted.
diskRecoveryWindowCurrent: string

The current value (in seconds) of the recovery window for this protected database.
diskRecoveryWindowGoal: string

Recovery window goal that the Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.
diskRecoveryWindowNeededSpace: string

The estimated space (in GB) that is needed to meet the recovery window goal.
diskReservedSpace: string

The amount of disk space(in GB) reserved for the exclusive use of this database.
finalChangeNumber: string

The highest SCN to which this database can be recovered when using backups and redo logs available on Recovery Appliance.
guaranteedBackupCopy: string

Always accept new backups even if it requires purging existing backups not yet copied to media or replicated.
keepSpace: string

The space used to hold KEEP backups for the database.
lastCompleteBackup: string

The latest time for which a backup of all datafiles in the database exists.
lastCopyToCloud: string

The timestamp of the last complete copy-to-cloud operation for this database.
lastCopyToTape: string

The timestamp of the last complete copy-to-tape operation for this database.
lastReplication: string

The timestamp of the last complete replication operation for this database.
maxDiskBackupRetention: string

A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be be retained beyond the disk recovery window goal as space permits.
mediaManagerRecoveryWindowGoal: string

A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.
minimumRecoveryNeeded: string

The minimum interval needed to restore the protected database to the present.
name: string

Protected database target name or database unique name.
nzdlActive: string

YES if real-time redo transport is active. NO if redo has not recently been received.
protectionPolicyName: string

The name of the protection policy used by this database.
replicationEnabled: string

Enabled (YES) or disabled (NO) of replication operation for this database.
replicationServerList: string

The list of replication server configurations associated with this protection policy.
replicationSetupStatus: string

The status of the setup for the downstream replication appliance for this database.
restoreWindow: string

The time range used to compute the value of the estimated space that is needed to meet the recovery window goal.
spaceUsage: string

The amount of disk space (in GB) currently used by this protected database.
storageLocation: string

The name of the Recovery Appliance storage location used by this protected database.
targetName: string

Protected database target name.
targetType: string

Target type corresponding to the target specified by targetName. This can be oracle_database, rac_database or composite.
timeZone: string

The time zone offset of the protected database.
unprotectedDataWindowCurrent: string

The point beyond which recovery is impossible unless additional redo is available.
unprotectedDataWindowThreshold: string

The maximum amount of time in which there is potential data loss exposure for databases associated with this protected database.
vpcUser: string

The list of Recovery Appliance recovery catalog user for this protected database.

{
    "description":"Protected database properties.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Protected database target name or database unique name.",
            "type":"string"
        },
        "targetName":{
            "description":"Protected database target name.",
            "type":"string"
        },
        "targetType":{
            "description":"Target type corresponding to the target specified by targetName. This can be oracle_database, rac_database or composite.",
            "type":"string"
        },
        "dbUniqueName":{
            "description":"Database unique name.",
            "type":"string"
        },
        "databaseVersion":{
            "description":"Database version.",
            "type":"string"
        },
        "databaseSize":{
            "description":"Database size.",
            "type":"string"
        },
        "protectionPolicyName":{
            "description":"The name of the protection policy used by this database.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"Recovery window goal that the Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.",
            "type":"string"
        },
        "diskRecoveryWindowCurrent":{
            "description":"The current value (in seconds) of the recovery window for this protected database.",
            "type":"string"
        },
        "diskRecoveryWindowNeededSpace":{
            "description":"The estimated space (in GB) that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protected database.",
            "type":"string"
        },
        "unprotectedDataWindowCurrent":{
            "description":"The point beyond which recovery is impossible unless additional redo is available.",
            "type":"string"
        },
        "mediaManagerRecoveryWindowGoal":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "maxDiskBackupRetention":{
            "description":"A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be be retained beyond the disk recovery window goal as space permits.",
            "type":"string"
        },
        "guaranteedBackupCopy":{
            "description":"Always accept new backups even if it requires purging existing backups not yet copied to media or replicated.",
            "type":"string"
        },
        "backupRedoFailover":{
            "description":"Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy.",
            "type":"string"
        },
        "lastCompleteBackup":{
            "description":"The latest time for which a backup of all datafiles in the database exists.",
            "type":"string"
        },
        "lastCopyToTape":{
            "description":"The timestamp of the last complete copy-to-tape operation for this database.",
            "type":"string"
        },
        "lastCopyToCloud":{
            "description":"The timestamp of the last complete copy-to-cloud operation for this database.",
            "type":"string"
        },
        "lastReplication":{
            "description":"The timestamp of the last complete replication operation for this database.",
            "type":"string"
        },
        "copyToCloudEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-cloud operation for this database.",
            "type":"string"
        },
        "copyToTapeEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-tape operation for this database.",
            "type":"string"
        },
        "replicationEnabled":{
            "description":"Enabled (YES) or disabled (NO) of replication operation for this database.",
            "type":"string"
        },
        "finalChangeNumber":{
            "description":"The highest SCN to which this database can be recovered when using backups and redo logs available on Recovery Appliance.",
            "type":"string"
        },
        "replicationServerList":{
            "description":"The list of replication server configurations associated with this protection policy.",
            "type":"string"
        },
        "databaseKey":{
            "description":"The primary key for this database in the Recovery Appliance metadata database.",
            "type":"string"
        },
        "deleting":{
            "description":"YES if this database is currently being deleted.",
            "type":"string"
        },
        "dbid":{
            "description":"The DBID for this protected database.",
            "type":"string"
        },
        "creationTime":{
            "description":"The time of task creation.",
            "type":"string"
        },
        "storageLocation":{
            "description":"The name of the Recovery Appliance storage location used by this protected database.",
            "type":"string"
        },
        "timeZone":{
            "description":"The time zone offset of the protected database.",
            "type":"string"
        },
        "spaceUsage":{
            "description":"The amount of disk space (in GB) currently used by this protected database.",
            "type":"string"
        },
        "keepSpace":{
            "description":"The space used to hold KEEP backups for the database.",
            "type":"string"
        },
        "diskReservedSpace":{
            "description":"The amount of disk space(in GB) reserved for the exclusive use of this database.",
            "type":"string"
        },
        "replicationSetupStatus":{
            "description":"The status of the setup for the downstream replication appliance for this database.",
            "type":"string"
        },
        "restoreWindow":{
            "description":"The time range used to compute the value of the estimated space that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "minimumRecoveryNeeded":{
            "description":"The minimum interval needed to restore the protected database to the present.",
            "type":"string"
        },
        "nzdlActive":{
            "description":"YES if real-time redo transport is active. NO if redo has not recently been received.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"The setting that controls whether RMAN backups for databases that use this protection policy can be deleted.",
            "type":"string"
        },
        "deduplicationFactor":{
            "description":"The ratio of the total size of virtual full backups to the actual consumed space on the appliance for this protected database.",
            "type":"string"
        },
        "vpcUser":{
            "description":"The list of Recovery Appliance recovery catalog user for this protected database.",
            "type":"string"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

Match All

Protected database properties.

Show Source

object ChildDetailsLink

Object details Link.
object ProtectedDatabase-allOf[1]

{
    "description":"Protected database properties.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Protected database target name or database unique name.",
            "type":"string"
        },
        "targetName":{
            "description":"Protected database target name.",
            "type":"string"
        },
        "targetType":{
            "description":"Target type corresponding to the target specified by targetName. This can be oracle_database, rac_database or composite.",
            "type":"string"
        },
        "dbUniqueName":{
            "description":"Database unique name.",
            "type":"string"
        },
        "databaseVersion":{
            "description":"Database version.",
            "type":"string"
        },
        "databaseSize":{
            "description":"Database size.",
            "type":"string"
        },
        "protectionPolicyName":{
            "description":"The name of the protection policy used by this database.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"Recovery window goal that the Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.",
            "type":"string"
        },
        "diskRecoveryWindowCurrent":{
            "description":"The current value (in seconds) of the recovery window for this protected database.",
            "type":"string"
        },
        "diskRecoveryWindowNeededSpace":{
            "description":"The estimated space (in GB) that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protected database.",
            "type":"string"
        },
        "unprotectedDataWindowCurrent":{
            "description":"The point beyond which recovery is impossible unless additional redo is available.",
            "type":"string"
        },
        "mediaManagerRecoveryWindowGoal":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "maxDiskBackupRetention":{
            "description":"A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be be retained beyond the disk recovery window goal as space permits.",
            "type":"string"
        },
        "guaranteedBackupCopy":{
            "description":"Always accept new backups even if it requires purging existing backups not yet copied to media or replicated.",
            "type":"string"
        },
        "backupRedoFailover":{
            "description":"Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy.",
            "type":"string"
        },
        "lastCompleteBackup":{
            "description":"The latest time for which a backup of all datafiles in the database exists.",
            "type":"string"
        },
        "lastCopyToTape":{
            "description":"The timestamp of the last complete copy-to-tape operation for this database.",
            "type":"string"
        },
        "lastCopyToCloud":{
            "description":"The timestamp of the last complete copy-to-cloud operation for this database.",
            "type":"string"
        },
        "lastReplication":{
            "description":"The timestamp of the last complete replication operation for this database.",
            "type":"string"
        },
        "copyToCloudEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-cloud operation for this database.",
            "type":"string"
        },
        "copyToTapeEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-tape operation for this database.",
            "type":"string"
        },
        "replicationEnabled":{
            "description":"Enabled (YES) or disabled (NO) of replication operation for this database.",
            "type":"string"
        },
        "finalChangeNumber":{
            "description":"The highest SCN to which this database can be recovered when using backups and redo logs available on Recovery Appliance.",
            "type":"string"
        },
        "replicationServerList":{
            "description":"The list of replication server configurations associated with this protection policy.",
            "type":"string"
        },
        "databaseKey":{
            "description":"The primary key for this database in the Recovery Appliance metadata database.",
            "type":"string"
        },
        "deleting":{
            "description":"YES if this database is currently being deleted.",
            "type":"string"
        },
        "dbid":{
            "description":"The DBID for this protected database.",
            "type":"string"
        },
        "creationTime":{
            "description":"The time of task creation.",
            "type":"string"
        },
        "storageLocation":{
            "description":"The name of the Recovery Appliance storage location used by this protected database.",
            "type":"string"
        },
        "timeZone":{
            "description":"The time zone offset of the protected database.",
            "type":"string"
        },
        "spaceUsage":{
            "description":"The amount of disk space (in GB) currently used by this protected database.",
            "type":"string"
        },
        "keepSpace":{
            "description":"The space used to hold KEEP backups for the database.",
            "type":"string"
        },
        "diskReservedSpace":{
            "description":"The amount of disk space(in GB) reserved for the exclusive use of this database.",
            "type":"string"
        },
        "replicationSetupStatus":{
            "description":"The status of the setup for the downstream replication appliance for this database.",
            "type":"string"
        },
        "restoreWindow":{
            "description":"The time range used to compute the value of the estimated space that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "minimumRecoveryNeeded":{
            "description":"The minimum interval needed to restore the protected database to the present.",
            "type":"string"
        },
        "nzdlActive":{
            "description":"YES if real-time redo transport is active. NO if redo has not recently been received.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"The setting that controls whether RMAN backups for databases that use this protection policy can be deleted.",
            "type":"string"
        },
        "deduplicationFactor":{
            "description":"The ratio of the total size of virtual full backups to the actual consumed space on the appliance for this protected database.",
            "type":"string"
        },
        "vpcUser":{
            "description":"The list of Recovery Appliance recovery catalog user for this protected database.",
            "type":"string"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ChildDetailsLink

Type: object

Object details Link.

Show Source

links(required): object links

Navigation links.

{
    "description":"Object details Link.",
    "type":"object",
    "required":[
        "links"
    ],
    "properties":{
        "links":{
            "type":"object",
            "description":"Navigation links.",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : ProtectedDatabase-allOf[1]

Type: object

Nested Schema : links

Type: object

Navigation links.

Show Source

self: object Link

A link

{
    "type":"object",
    "description":"Navigation links.",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Link

Type: object

A link

Show Source

href(required): string

URL for link

{
    "description":"A link",
    "type":"object",
    "required":[
        "href"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for link"
        }
    }
}

400 Response

Bad Request

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

code(required): string

HTTP Status Code
errors(required): array errors

List of errors and their details.
message(required): string

Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

object ErrorResponse

Response sent back in the case of an Error

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

Array of: object ErrorResponse

Response sent back in the case of an Error

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested 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

Unauthorized

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

code(required): string

HTTP Status Code
errors(required): array errors

List of errors and their details.
message(required): string

Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

object ErrorResponse

Response sent back in the case of an Error

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

Array of: object ErrorResponse

Response sent back in the case of an Error

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested 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

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

code(required): string

HTTP Status Code
errors(required): array errors

List of errors and their details.
message(required): string

Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

object ErrorResponse

Response sent back in the case of an Error

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

Array of: object ErrorResponse

Response sent back in the case of an Error

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested 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

Not Found

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

code(required): string

HTTP Status Code
errors(required): array errors

List of errors and their details.
message(required): string

Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

object ErrorResponse

Response sent back in the case of an Error

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

Array of: object ErrorResponse

Response sent back in the case of an Error

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested 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

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

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"
        }
    }
}