Create a REST handler parameter
post
/ords/_/db-api/stable/ords/rest/parameters/
Creates a REST handler parameter.
Request
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
access_method(optional):
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(optional):
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(optional):
string
Comment text.
-
handler_id:
integer
ID for specific module handler.
-
name:
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(optional):
string
The native type of the parameter. Valid values: STRING, INT, DOUBLE, BOOLEAN, LONG, TIMESTAMP.
-
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.
-
source_type(optional):
string
The type identifies if the parameter originates in the URI Template or a HTTP Header. Valid values: HEADER, RESPONSE, URI.
Response
Supported Media Types
- application/json
201 Response
Details of the REST handler parameter that has been successfully created.
400 Response
No name parameter provided.
404 Response
No handler specified.
409 Response
Parameter name or bind variable already exists.