Jump to

• Request
• Response

Update or disables a REST enabled object

put

/ords/rest/autorest/{id}

Updates or disables a REST enabled object,

Request

Path Parameters

• id(required): integer
  ID of the module for the REST Enabled Object.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• action: string
  Its value can be 'DISABLE' which would make the endpoint disables a REST enabled object or 'UPDATE' which would make the endpoint update a REST enabled object.
• auth(required): 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(required): string
  Alias of the object.

{
    "type":"object",
    "required":[
        "object_alias",
        "auth"
    ],
    "properties":{
        "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>."
        },
        "action":{
            "type":"string",
            "description":"Its value can be 'DISABLE' which would make the endpoint disables a REST enabled object or 'UPDATE' which would make the endpoint update a REST enabled object."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the REST enabled object that has been successfully updated or disables.

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

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