Jump to

• Request
• Response

Update a REST handler parameter

put

/ords/rest/parameters/{id}

Updates a REST handler parameter.

Request

Path Parameters

• id(required): integer
  ID for specific parameter.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• access_method(required): string
  The parameter access method. Indicates if the parameter is an input value, output value, or both. Valid values: IN, OUT, INOUT.
• bind_variable_name: string
  The name of the parameter, as it will be referred to in the SQL. If NULL is specified, then the parameter is unbound.
• comments: string
  Comment text.
• handler_id(required): integer
  ID for specific handler.
• name(required): string
  The name of the parameter, as it is named in the URI Template or HTTP Header. Used to map names that are not valid SQL parameter names.
• param_type(required): string
  The native type of the parameter. Valid values: STRING, INT, DOUBLE, BOOLEAN, LONG, TIMESTAMP.
• source_type(required): string
  The type identifies if the parameter originates in the URI Template or a HTTP Header. Valid values: HEADER, RESPONSE, URI.

{
    "type":"object",
    "required":[
        "handler_id",
        "name",
        "source_type",
        "param_type",
        "access_method"
    ],
    "properties":{
        "handler_id":{
            "type":"integer",
            "description":"ID for specific handler."
        },
        "name":{
            "type":"string",
            "description":"The name of the parameter, as it is named in the URI Template or HTTP Header. Used to map names that are not valid SQL parameter names."
        },
        "bind_variable_name":{
            "type":"string",
            "description":"The name of the parameter, as it will be referred to in the SQL. If NULL is specified, then the parameter is unbound."
        },
        "source_type":{
            "type":"string",
            "description":"The type identifies if the parameter originates in the URI Template or a HTTP Header. Valid values: HEADER, RESPONSE, URI."
        },
        "param_type":{
            "type":"string",
            "description":"The native type of the parameter. Valid values: STRING, INT, DOUBLE, BOOLEAN, LONG, TIMESTAMP."
        },
        "access_method":{
            "type":"string",
            "description":"The parameter access method. Indicates if the parameter is an input value, output value, or both. Valid values: IN, OUT, INOUT."
        },
        "comments":{
            "type":"string",
            "description":"Comment text."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the REST handler parameter that has been successfully updated.

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

400 Response

No name parameter provided.

404 Response

Parameter does not exist.

409 Response

Parameter name or bind variable already exists.

Back to Top