Oracle REST Data Services API

Set an ORDS property value

put

/ords/_/db-api/stable/ords/properties/{key}

Set a specfic ORDS property value in the database. Depending on the associated database account permissions the data will be returned from USER_ORDS_PROPERTIES view for that correspond REST Enabled schema or all REST Enabled schemas if the database account has access to them. Users can set their own ORDS property values that are defined at SCHEMA scope through this endpoint. ORDS properties that are defined at DATABASE scope can be set through this endpoint by an administrator. A client requires SQL Developer or SQL Administrator role to invoke this service.

Request

Supported Media Types

application/json

Path Parameters

key: string

The name of the ORDS property.

Root Schema : schema

Type: object

Show Source

value(optional): string

The value to set for the property.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The value to set for the property."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Information about a specific ORDS property value in the database that is visible to the user.

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