HTTP メソッド/パス

Web サービスの呼び出しに Enterprise Server が使用するメカニズムは、要求されたオペレーションを確認する手段として Enterprise Server は要求 URI を使用するという点で、他のサービス タイプのメカニズムによる JSON (RESTful) Web サービスとは異なります。SOAP 要求など、他の要求タイプの場合は、要求の本文からオペレーション名を抽出します。

JSON (RESTful) サービス インターフェイス オペレーションごとに、要求 URI の相対パス部分が、そのオペレーションに定義されたメソッドと一緒に、 は、[Operation Properties] - [HTTP] タブで定義されます。

通常、同じ論理リソースに対するオペレーションは同じパスで定義されますが、HTTP メソッドは異なります。したがって、オペレーションはパスとメソッドの組み合わせによって一意に識別されます。

Enterprise Server が、指示されたオペレーションを持たない JSON 要求 (たとえば、ベース URI のみで構成される GET 要求) を受信した場合、サービスに定義されたすべてのオペレーションの相対 URI パスを含む JSON リンク記述オブジェクトの単一配列からなる特別な応答メッセージが返されます。これにより、クライアントは、オペレーション名を指定しなくても、ベース URI のオペレーションにアクセスする方法を「発見」できます。

メソッド

各オペレーションには次のいずれかのメソッドが割り当てられ、それぞれが標準の HTTP メソッドに対応しています。

[GET]
通常、指定した URI で識別されるリソースを取得するために使用されます。
[POST]
通常、指定した URI を使用して新しいリソースを作成するために使用されます。これがデフォルト値です。
[PUT]
通常、指定した URI で識別されるリソースを更新するために使用されます。
[DELETE]
通常、指定した URI で識別されるリソースを削除するために使用されます。

パス

相対 URI パスは、JSON (RESTful) サービスのベース URI に追加されると、オペレーションを呼び出すために使用されます。

JSON (RESTful) サービスのコンテキストでは、相対パスは COBOL コードから派生した API リソースの表現であり、Enterprise Server がオペレーションを識別する名前として機能します。

オペレーションのデフォルトの相対パスは次のとおりです。/operationName .

パスの変数部分は、中括弧 ({}) で囲まれたパラメーター名で表されます。次に例を示します。

/cars/{make}/parts

パラメーター {make} は、フィールドの任意のオカレンスの値を表します。

重要: JSON Web サービスにパスとメソッドがあいまいなオペレーションが複数ある場合、Enterprise Server は定義されたとおりにサービスに最初に現れるオペレーションを呼び出します。たとえば、次のパスはあいまいです。
/cars/{make}/parts
/cars/{model}/parts
URI /cars/ford/parts は両方のパスで有効なため、これらも同様です。
/cars/{make}/parts
/cars/ford/parts

したがって、オペレーション パスを定義する際はあいまいさを避けるよう注意してください。