Jump to

• Request
• Response

Set an ORDS property value for a schema

put

/ords/properties/{schema}/{key}

Set a specfic ORDS property value in the database for the specified schema. ORDS property values that are defined at SCHEMA scope can be managed through this endpoint. A client requires SQL Administrator role to invoke this service.

Request

Supported Media Types

• application/json

Path Parameters

• key: string
  The name of the ORDS property.
• schema: string
  The name of the REST Enabled database schema.

Body ()

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

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

Back to Top