このページを共有

# 応答の受信

このセクションでは、ALM Octaneサーバーから応答を受信する手順について説明します。

このトピックの内容:

## 概要

出力は、次の方法でサーバーから返されます。

- ステータスコード。エラーとステータスコードを参照してください。

- 応答ヘッダー。応答ヘッダーを参照してください。

- 応答本文。応答本文を参照してください。

トップに戻る

## 応答ヘッダー

サポートされているすべての出力ヘッダーフィールドは、HTTP/1.1プロトコルに従います。HTTP/1.1ヘッダー定義を説明するリストについては、ヘッダーフィールド定義を参照してください。以下に、ALM Octaneでサポートされている応答ヘッダーフィールドのリストを示します。

ヘッダー名 | 機能
--- | ---
Content-Encoding | 応答本文に適用されたコーディングを指定します。 Accept-Encoding要求ヘッダーで指定されたコーディングのサブリストである必要があります。 必須。 例: Content-Encoding: gzip
Content-Type | 応答本文に使用されているメディアタイプを指定します。 戻りメディアタイプは、Accept要求ヘッダーで指定されたメディアタイプのサブリストである必要があります。 必須。 例: Content-Type:application/json;q=0.9
日付 | メッセージが発信された日時を指定します。 日付と時刻の形式は、RFC 1123で提供されているガイドラインに従います。 例外: 次のステータスコードが返される場合、サーバーは日付応答ヘッダーを省略できます。100、101、500、503 必須。 例: Date: Mon, 24 Mar 2014 12:11:05 GMT
Server | サーバーが要求を処理するために使用するソフトウェアを指定します。 フォワードプロキシはこの応答ヘッダーを変更してはならず、代わりにVia応答ヘッダーを使用する必要があります。 例: Server: Jetty
Via | リクエストをサーバーに転送したプロキシまたはゲートウェイソフトウェアを指定します。 オプション。 例: Via: server.com (Apache/2.1)

トップに戻る

## 応答本文

標準設定では、JSON表現のみがすべてのリソースインスタンスとリソースコレクションでサポートされています。

JSON表現は、「JSONデータ交換形式」と呼ばれるECMA-404標準に従います。

トップに戻る

GET操作の応答本文

GET操作の応答には、通常、次のものが含まれます。

- 関連するIDフィールドとtypeフィールド、およびその他の標準設定フィールド。追加のフィールドを表示するには、フィールドの選択を参照してください。

- GET操作によって返された項目のtotal_count。

  MAX_PAGE_SIZE構成パラメーターを使用して、返される項目の最大数を設定できます。詳細については、REST APIを使用した設定パラメーターの設定を参照してください。

- exceeds_total_count値は、GET操作によって返される項目の最大数に達したかどうかを示します。値がtrueの場合、GET応答は部分的です。

GET応答

    {
        "total_count": 2,
        "data": [
            {
                "type": "defect",
                "id": "1014"
            },
            {
                "type": "defect"
                "id": "1012"
            }
        ],
        "exceeds_total_count": false
    }

トップに戻る

PUT、POST、およびDELETE操作の応答本文

GET操作の応答には、通常、次のものが含まれます。

- 関連するIDおよびtypeフィールド。追加のフィールドを表示するには、フィールドの選択を参照してください。

- GET操作によって返された項目のtotal_count。

- エラーが返され、そのエラーが名前の重複やルールの検証に失敗したエンティティなどのビジネス上の性質のものである場合は、business_error値が含まれる可能性があります。

エラーを示すPOST応答

    {
        "total_count": 2,
        "data": [
            ...

            ...

            ...

        ],
        "exceeds_total_count": false

    "errors": [
        {
          "error_code": "platform.duplicate_entity_error",
          "correlation_id": "gxwk4vw6l51k2bp30z6r6o5yd",
          "description": "A release with this name already exists.",
          "description_translated": "A release with this name already exists.",
          "properties": {
            "entity_type": "release",

           "message": "service=[CreateServiceImpl],
                       blFlowCommand=[BinaryEntitiesWriter],
                       token=[ReleaseEntityToken] has thrown an exception and
                       terminated BL flow. See service result log message for details.
                       Error=[Failed to add data to DB due to unique
                       constraint violation with the following field names:
                      [name, workspace_id] for release entity.]",

            "field_name": "name"
          },
          "stack_trace": "",
          "business_error": true
        }
      ]

    }

トップに戻る

参照情報:

- リクエストの実行

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべて ローカルヘルプセンターを表示 オンラインヘルプセンターを表示 戻る ブラウザーの履歴内を戻る 進む ブラウザーの履歴内を進む 検索のハイライトを削除する 次のトピック 次のトピックに進む 前のトピック 前のトピックに戻る 現在のトピックを印刷 バージョン: