リクエストの実行

このセクションでは、要求ヘッダーリクエストボディ、およびクエリを使用してALM Octaneサーバーにリクエストを送信する手順について説明します。

要求ヘッダー

サポートされているすべての入力ヘッダーフィールドは、HTTP/1.1プロトコルに従います。HTTP/1.1ヘッダー定義ヘッダーフィールド定義を説明するリストを見つけることができます。以下に、ALM Octaneでサポートされている要求ヘッダーフィールドのリストを示します。

ヘッダー名


必須


機能

Accept

いいえ

  • クライアントが応答で受け入れることができるメディアタイプ。

  • 空の値または欠落しているヘッダーは、クライアントがすべてのメディアタイプを受け入れることができることを意味します。

  • サーバーがメディアタイプを提供できない場合、サーバーは406(受け入れられない) HTTPステータスコードを返す必要があります。

Accept: application/json,text/html, application/ xhtml+xml,application/xml;q=0.9, image/webp*/*;q=0.8

Accept-Encoding

いいえ

  • クライアントが応答で受け入れることができるコンテンツコーディングを制限します。

  • 空の値または欠落しているヘッダーは、クライアントがすべてのコンテンツコーディングを受け入れることができることを意味します。

  • サーバーがコーディングタイプを提供できない場合、サーバーは406(受け入れられない) HTTPステータスコードを返す必要があります。

Accept: Accept-Encoding: gzip、deflate、sdch

Content-Type

いいえ

  • リクエスト本文に使用されているメディアタイプを指定します。

  • 空の値または不明な値は、415(サポートされていないメディアタイプ) HTTPステータスコードで応答されます。

  • ヘッダーが欠落している場合、要求はWebサーバーの標準設定設定で解析されます。

Content-Type: application/json

Host

Yes

  • リソースが要求されているサーバーまたはゲートウェイの権限を表します。

  • 空の値、認識されない値、または欠落しているヘッダーは、400(不正な要求) HTTPステータスコードで応答する必要があります。

Host:  <server>:<port>

注: データを送信するときは、常にContent-Typeヘッダーを送信して、クライアントからサーバーに送信されるデータのタイプを指定します。

コンテンツが送信されない限りContent-Typeヘッダーを送信しないでください。

サーバーから受信するデータの形式を指定するには、常にAcceptヘッダーを送信します。

トップに戻る

リクエスト本文

APIは、要求と応答の両方でアプリケーション/json表現のみをサポートします。

リソースのリファレンスで特に指定されていない限り、データはJSON形式で送信および返されます。このAPIは ECMA 404仕様

サポートされているすべてのリクエストメソッドは、HTTP/1.1プロトコルに従います。HTTP/1.1リクエストメソッドを説明するリストについては、メソッド定義を参照してください。

  • GET

    リクエストURIに一致するリソースの表現をリクエストします。

  • PUT

    リソースがすでに存在する場合、囲まれた表現されたリソースが一致する要求URIの下に格納されることを要求します。

  • DELETE

    一致するリクエストURIで見つかったリソースの削除をリクエストします。

  • POST
    リクエストURIに一致するリソースコレクションの下に新しいリソースの作成をリクエストします。

トップに戻る

参照情報: