ジャンプ先

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

RESTテンプレート・ハンドラの作成

POST

/ords/rest/handlers/

RESTテンプレート・ハンドラを作成します。

リクエスト

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

• application/json

本文 ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• comments(optional): string
  コメント・テキスト。
• items_per_page(optional): integer
  リソース・ハンドラHTTP操作GETメソッドのデフォルトのページ区切り、つまり、データベース問合せに基づくJSON書式結果セットのページごとに戻される行の数です。デフォルト: NULL (リソース・モジュール設定に従います)。
• method(optional): string
  このハンドラの応答先のHTTPメソッドです。有効な値: GET、POST、PUT、DELETE。
• mimes_allowed(optional): string
  ハンドラが受け入れるMIMEタイプのカンマ区切りリストです。PUTおよびPOSTにのみ適用されます。
• run_mode(optional): string
  この値は「codePreview」で、エンドポイントはバックエンドが実行したコードで応答します。パラメータが指定されていない場合、エンドポイントは操作の実行結果で応答します。
• source: string
  選択したHTTPメソッドのソース実装です。
• source_type(optional): string
  このハンドラのHTTPリクエスト・メソッドです。有効な値: source_type_collection_feed、source_type_collection_item、source_type_media、source_type_plsql、source_type_query || source_type_csv_query、source_type_query_one_row、source_type_feed、path/to/feed/{id}。
• template_id: integer
  ハンドラが属するテンプレートのID。

{
    "type":"object",
    "required":[
        "template_id",
        "source"
    ],
    "properties":{
        "template_id":{
            "type":"integer",
            "description":"ID of the template the handler belongs to."
        },
        "source":{
            "type":"string",
            "description":"The source implementation for the selected HTTP method."
        },
        "source_type":{
            "type":"string",
            "description":"The HTTP request method for this handler. Valid values: source_type_collection_feed, source_type_collection_item, source_type_media, source_type_plsql, source_type_query || source_type_csv_query, source_type_query_one_row, source_type_feed, path/to/feed/{id}."
        },
        "method":{
            "type":"string",
            "description":"The HTTP method to which this handler will respond. Valid values: GET, POST, PUT, DELETE."
        },
        "items_per_page":{
            "type":"integer",
            "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: NULL (defers to the resource module setting)."
        },
        "mimes_allowed":{
            "type":"string",
            "description":"Comma-separated list of MIME types that the handler will accept. Applies to PUT and POST only."
        },
        "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レスポンス

ハンドラはすでに存在します。

先頭に戻る