HTTP リクエストを作成し、ポータル Web API のエラーを処理する

Web API とのやりとりには、必要なヘッダーを含む HTTP リクエストの作成と、エラーを含む HTTP 応答の処理が含まれます。

Web API URL およびバージョン管理

次のテーブルの形式を使用して、Web API URLを作成します。

たとえば、ケースを参照する場合は次の形式を使用します。

https://contoso.powerappsportals.com/_api/case

すべての Web API リソースは、Web ロールを持つコンテキスト内のそれぞれの ポータル テーブルのアクセス許可 に従います。

HTTP メソッド

HTTP リクエストでは、さまざまな種類のメソッドを使用できます。 ただし、ポータル Web API は、次のテーブルのメソッドのみをサポートします。

HTTP ヘッダー

WebAPI は JSON のみをサポートします。 各 HTTP ヘッダーには以下を含める必要があります。

•  アプリケーション/json の 承認 ヘッダー値 (応答ボディが期待されていない場合でも)。
• 要求本文に JSON データが含まれる要求の場合は、 application/json を値に持つ コンテンツの種類 ヘッダーを含める必要があります。

現在の OData バージョンの 4.0 ですが、今後のバージョンで新機能が使用できるようになる可能性があります。 次の構文を使用して、将来コードに適用される OData バージョンが明確かどうかを確認します。

構文

Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0

例: CSRF トークンのラッパー AJAX 関数

    (function(webapi, $){
        function safeAjax(ajaxOptions) {
            var deferredAjax = $.Deferred();
    
            shell.getTokenDeferred().done(function (token) {
                // add headers for ajax
                if (!ajaxOptions.headers) {
                    $.extend(ajaxOptions, {
                        headers: {
                            "__RequestVerificationToken": token
                        }
                    }); 
                } else {
                    ajaxOptions.headers["__RequestVerificationToken"] = token;
                }
                $.ajax(ajaxOptions)
                    .done(function(data, textStatus, jqXHR) {
                        validateLoginSession(data, textStatus, jqXHR, deferredAjax.resolve);
                    }).fail(deferredAjax.reject); //ajax
            }).fail(function () {
                deferredAjax.rejectWith(this, arguments); // on token failure, pass the token ajax and args
            });
    
            return deferredAjax.promise();  
        }
        webapi.safeAjax = safeAjax;
})(window.webapi = window.webapi || {}, jQuery)

例: テーブル データを取得する

    webapi.safeAjax({
                type: "GET",
                url: "/_api/contacts?$select=firstname,lastname",
                contentType: "application/json",
                success: function (res) {
                        console.log(res);
                }
    });

例: テーブル データの作成

    webapi.safeAjax({
        type: "POST",
        url: "/_api/accounts",
        contentType: "application/json",
        data: JSON.stringify({
            "name": "Sample Account"
        }),
        success: function (res, status, xhr) {
            console.log("entityID: "+ xhr.getResponseHeader("entityid"))
        }
    });

例: テーブル データの更新

        webapi.safeAjax({
        type: "PATCH",
        url: "/_api/accounts(00000000-0000-0000-0000-000000000001)",
        contentType: "application/json",
        data: JSON.stringify({
            "name": "Sample Account - Updated"
        }),
        success: function (res) {
            console.log(res);
        }
    });

例: テーブル データの削除

        webapi.safeAjax({
        type: "DELETE",
        url: "/_api/accounts(00000000-0000-0000-0000-000000000001)",
        contentType: "application/json",
        success: function (res) {
            console.log(res);
        }
    });

ステータス コードの確認

各 HTTP 要求応答には、ステータス コードが含まれています。 ポータル Web API で返される状態コードには、次が含まれます。

応答からのエラーの解析

まだ内部エラーが含まれている次の HTTP 応答例を検討してください。

{
  "error":{
    "code": "This code is not related to the http status code and is frequently empty",
    "message": "A message describing the error",
    "cdscode": "Dataverse error code",
    "innererror": {
        "code": "800xxxx",
        "message": "A message describing the error. This is frequently the same as the outer message.."
      }
    }
  }

エラー コード

処理されたすべてのシナリオで、エラーコードは 16 進形式で表示されます。 次の表に、各エラーコードとそれぞれの名前およびメッセージを示します。

HTTP ステータス コード 500 の未処理エラーに対する応答は、"リクエストの処理中に予期しないエラーが発生しました" というエラーが返されます。

関連情報

ポータル Web API の概要
ポータルは、Web API を使用して操作を書き込み、更新、および削除します
Web API を使用したポータルの読み込み操作