WebApi: put()

HTTP の PUT メソッドの要求に対する処理を実装します。

この関数は非同期関数です。

構文

webApi.put(params) => Promise<object>

引数

• params: object

  クライアントから送られてきたリクエストのパラメタです。これらは URL に含まれるクエリパラメタとリクエストのボディから取得されます。

  [path][path] が変数ラベルを含む場合、クライアントから送信されたリクエストのパスから、変数ラベルに対応する単語がパラメタとして取り出されます。詳細は get() を参照してください。

返値: Promise<object>

リクエストの結果です。この値はレスポンスのボディに書き込まれます。

ただしオブジェクトにプロパティ statusCode が指定されている場合、これはレスポンスのステータスコードの値に使用されます。

もし statusCode が 200 から 599 までの整数値でなければその値は無視されます。

オブジェクトにプロパティ created が設定されていてその値が true なら、代わりにステータスコードを 201 Created に設定します。

オブジェクトにプロパティ noContent が指定されていてその値が true なら、代わりにステータスコードを 204 No Content に設定します。

プロパティ created、noContent、statusCode が混在する場合、ステータスコードは 200 OK に設定され、これらのプロパティは無視されます。

ステータスコードが 204 No Content の場合、レスポンスにボディが設定されず、他のプロパティの値は無視されます。

例外

• MethodNotAllowedError
  • 基底クラスの実装が呼び出された場合。

解説

既定の実装では MethodNotAllowedError を発生させます。

PUT HTTP メソッドを使用する場合は派生クラスのメソッドとしてオーバライドする必要があります。