API
HTTP DELETE
概要
このブロックは、指定されたURL(HTTPサーバー)へ、HTTPのDELETEメソッドを使って要求(リクエスト)を送り、応答(レスポンス)としてリソース(データ)を取得します。
- リクエストには、任意のクエリーパラメーターやリクエストヘッダーを含められます。
- レスポンスは、変数に格納されます。
- 本ブロックを使うことで、HTTP DELETEメソッドのWeb APIと連携可能です。
- レスポンスの"HTTP Status"が400番台・500番台のときは、ブロックの実行が失敗します。
プロパティ
プロパティ名 | 説明 |
---|---|
ブロック名 |
編集パネルに配置した当該ブロックの表示名が変更できます。 ブロックリストパネル中のブロック名は変更されません。 |
URL | リクエストするURLを指定します。 |
クエリーパラメーター |
クエリーパラメーターを指定します。キーとバリューの組み合わせで指定します。 |
ブロックメモ | このブロックに関するメモが記載できます。このブロックの処理に影響しません。 |
エラー時の繰り返し回数 | リクエストエラー時の繰り返し回数を指定します。 |
繰り返し間隔 | リクエストエラー時の繰り返し間隔を秒単位で指定します。 |
レスポンスを格納する変数 |
HTTPサーバーが返すレスポンスを格納する変数を指定します。 変数に格納する値は、レスポンスのメッセージ・ボティのみです。レスポンスの「Content-Type」ヘッダーが「application/json」の場合は、メッセージ・ボディをデコードした結果を変数に格納します。 詳細については、「出力仕様>HTTP GET/HTTP POST/HTTP PUT」を参照してください。 |
リクエストヘッダー |
リクエストヘッダーを指定します。キーとバリューの組み合わせで指定します。 「Bearerトークン認証」や「Basci認証」などのように、Web APIによっては追加のリクエストヘッダーが必要な場合があります。このプロパティは、そのような場合に使用します。 以下は、「Bearerトークン認証」を指定した例です。 |
使用例
ここでは、JSONPlaceholderを使用して、「HTTP DELETE」ブロックの使い方を紹介します
JSONPlaceholderは、ウェブ開発者がデータをモックアップするためのWebサービスで、JSON形式でデータを返します。RESTfulなAPIとして機能し、HTTPリクエスト(POST、GET、PUT、DELETEなど)を受け付けます。
JSONPlaceholderを使用したHTTP DELETEの例について簡単に説明します。以下は、ブログなどの投稿記事を削除するAPIの仕様です。
- URL:https://jsonplaceholder.typicode.com/posts/{id}
{id}は、削除する投稿記事のIDです。 - パラメーター:なし
これを、「HTTP DELETE」ブロックで実現すると以下のようになります。
設定するプロパティと値は以下のとおりです。
プロパティ | 値 |
---|---|
URL | https://jsonplaceholder.typicode.com/posts/1 投稿IDが1の投稿を削除 |
レスポンスを格納する変数 | response |
このブロックを実行すると、以下のようなレスポンスが返ってきます。
{ }
このレスポンスには、削除された投稿に関する情報は含まれていません。HTTP DELETEメソッドは、成功した場合に空のレスポンスを返すことが一般的です。
完成したフローは以下のとおりです。