Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Jump to

• Request
• Response

Get Schema

get

/20211130/projects/{projectId}/schemas/{schemaId}

Gets a Schema resource by identifier

Request

Path Parameters

• projectId: string
  Project OCID
• schemaId: string
  unique Schema identifier

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the Schema resource with the given id

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Schema

Type: object

A schema is a collection of database objects. A schema is owned by a database user and has the same name as that user. Schema objects are logical structures created by users.

Show Source

• id: string
  Minimum Length: 1

  Maximum Length: 255

  The uuid of the Schema resource
• name: string
  Minimum Length: 1

  Maximum Length: 128

  Database Schema Name

{
    "description":"A schema is a collection of database objects. A schema is owned by a database user and has the same name as that user. Schema objects are logical structures created by users.",
    "x-obmcs-splat":{
        "resourceKind":"query-schema",
        "adLocality":"regional",
        "ocidEntityType":"notreviewedplaceholder",
        "activeLifecycleStates":[
            "active"
        ],
        "deletedLifecycleStates":[
            "deleted"
        ],
        "getOperationId":"GetSchema",
        "listResourcesOperationId":"ListSchemas"
    },
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "description":"The uuid of the Schema resource",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "name":{
            "description":"Database Schema Name",
            "type":"string",
            "minLength":1,
            "maxLength":128
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Back to Top