Jump to

• Request
• Response

Get current ORDS schema and count of all current schema REST objects and count of all REST modules

get

/ords/rest/overview/

Describes the current ORDS schema and summarizes all the REST objects in the current schema and Summary of all the published, unpublished, fully protected, partially protected and unique protected REST modules, get current ORDS schema auto-REST authorization

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the current ORDS schema. This includes the connection type, pattern, REST status, auto-REST authorization, operations allowed and pre hook and ummary of all the REST objects in the current schema and summarizes all the published, unpublished, fully protected, partially protected and unique protected REST modules, etails of the current ORDS schema auto-REST authorization

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links: array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top