Jump to

• Request
• Response

REST enable an object

post

/ords/_/db-api/stable/ords/rest/autorest/

ENABLE_OBJECT enables Oracle REST Data Services access to a specified table or view in a schema.

Request

Supported Media Types

• application/json

Body ()

Root Schema : schema

Type: object

Show Source

• auth: boolean
  Controls whether Oracle REST Data Services should require user authorization before allowing access to the Oracle REST Data Services metadata for this object. If this value is TRUE, then the service is protected by the following roles: oracle.dbtools.autorest.any.schema, oracle.dbtools.role.autorest...
• object_alias: string
  Alias of the object.
• object_name: string
  Name of the table or view.
• run_mode(optional): string
  Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution.

{
    "type":"object",
    "required":[
        "object_name",
        "object_alias",
        "auth"
    ],
    "properties":{
        "object_name":{
            "type":"string",
            "description":"Name of the table or view."
        },
        "object_alias":{
            "type":"string",
            "description":"Alias of the object."
        },
        "auth":{
            "type":"boolean",
            "description":"Controls whether Oracle REST Data Services should require user authorization before allowing access to the Oracle REST Data Services metadata for this object. If this value is TRUE, then the service is protected by the following roles: oracle.dbtools.autorest.any.schema, oracle.dbtools.role.autorest.<SCHEMANAME>.<OBJECTNAME>."
        },
        "run_mode":{
            "type":"string",
            "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

A REST enabled object in the schema.

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links(optional): array links

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href: string
• rel: string

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

403 Response

You do not have permission to enable a REST object.

404 Response

A REST Object does not exist.

409 Response

A REST enabled object with that alias already exists.

Back to Top