Jump to

• Request
• Response

Create a REST handler parameter

post

/ords/rest/parameters/

Creates a REST handler parameter.

Request

Supported Media Types

• application/json

Body ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "required":[
        "handler_id",
        "name"
    ],
    "properties":{
        "handler_id":{
            "type":"integer",
            "description":"ID for specific module 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."
        },
        "run_mode":{
            "type":"string",
            "description":"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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

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

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