ジャンプ先

• リクエスト
• レスポンス

RESTハンドラ・パラメータの作成

POST

/ords/rest/parameters/

RESTハンドラ・パラメータを作成します。

リクエスト

サポートされるメディア・タイプ

• application/json

本文 ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• access_method(optional): string
  パラメータ・アクセス・メソッドです。パラメータが入力値か、出力値か、またはその両方かどうかを示します。有効な値: IN、OUT、INOUT。
• bind_variable_name(optional): string
  SQLで呼ばれるパラメータの名前です。NULLが指定された場合、パラメータはバインドされません。
• comments(optional): string
  コメント・テキスト。
• handler_id: integer
  特定のモジュール・ハンドラのID。
• name: string
  URIテンプレートまたはHTTPヘッダーで呼ばれるパラメータの名前です。有効なSQLパラメータ名ではない名前のマップに使用されます。
• param_type(optional): string
  パラメータのネイティブ・タイプです。有効な値: STRING、INT、DOUBLE、BOOLEAN、LONG、TIMESTAMP。
• run_mode(optional): string
  この値は「codePreview」で、エンドポイントはバックエンドが実行したコードで応答します。パラメータが指定されていない場合、エンドポイントは操作の実行結果で応答します。
• source_type(optional): string
  タイプにより、パラメータがURIテンプレートまたはHTTPヘッダーで発生するかどうかが識別されます。有効な値: 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."
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

201レスポンス

正常に作成されたRESTハンドラ・パラメータの詳細。

本文 ()

ルート・スキーマ: ResourceItem

タイプ: object

使用可能なその他のプロパティ: true

ソースの表示

• links(optional): array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

400 レスポンス

名前パラメータが指定されていません。

404レスポンス

ハンドラが指定されていません。

409レスポンス

パラメータ名またはバインド変数はすでに存在します。

先頭に戻る