API返却形式

注:

Coupaは、特定の出力を定義できる、より高度なAPIフィルターの提供を開始しました。 将来のリリースで廃止となる浅い形式ではなく、これらのフィルターの使用をお勧めします。

CoupaのAPIは、デフォルトで多くのデータを返します(例えば、関連するオブジェクトの完全なオブジェクト)。 APIリターンペイロードのサイズは非常に大きくなることがあり、その場合所要時間も長くなります。 これは、無関係なデータを必要としない顧客にとって問題になる可能性があります。

より簡単にするために、Coupaには、オブジェクトのスキーマ全体とすべての関連付けの代わりに、制限されたJSONまたはXML応答を返す戻りフォーマット RETURN_OBJECT = SHALLOW があります。 Return_objectが指定されていない場合は、完全な戻り値が返されます。

仕組み

オプションのクエリパラメーター return_object は、次の3つの値をサポートします。

  • none :何も返されません。 これは、PUTとPOSTでのみサポートされます(意味をなさないため、GETのような検索ではサポートされません)。

  • LIMITED ： IDのみが返されます。 これはすべてのコマンドでサポートされています。

  • SHALLOW ：このパラメータは、呼び出されているオブジェクトのすべての属性/フィールドと、ワンディープアソシエーションのIDとナチュラルキーのみを返します。

パラメータ return_object = shallow は、次の場合にサポートされます。

  • POSTコマンド

  • PUTコマンド

  • GETコマンド

フィールド クエリ演算子を使用すると、応答本文に必要なフィールドを渡すことができます。 フィールド の値の形式はJSONです。 以下の例を参照してください。

? fields = [" id ", "invoice_number ", {" invoice_lines ": [" id "," line_num "]}]

戻り値のオブジェクト

return_object パラメーターを使用して、基本的な作成、更新、またはクエリ呼び出しの応答本文の形式を制御できます。

作成時と更新時のreturn_object値は、none、limited、shallowをサポートしています。

検索呼び出しでは、サポートされている値はlimitedとshallowです。

例: 検索に対するlimitedレスポンス

クエリ： https://example.coupahost.com/api/expense_reports?return_object=limited応答コード： 200応答本文：{" id ": 1}

例: 作成時にレスポンスなし

POST: https://example.coupahost.com/api/ex... rn_object = none Request Body: {" id ": 2 ," currency ":{" code ":" USD "}," expense - lines ": [{" description ":" Airfare to Reno "," merchant ":" American Airlines "," reason ":""," amount ":" 255.0 "," expense - date ":" 2010 -02 -05 T 00:00:00 - 08:00 "," start - date ":" 2010 -02 -05 T 00:00:00:00 - 08:00 "," expense - category ":{" name ":" Airfare ",}},} Response Code: 200 Response Body:

例: 作成時の浅いレスポンス

クエリ： https://example.coupahost.com/api/ex... object = shallow Response Code: 200 Response Body: {" id ": 158 ," created - at ":" 2010 -09 -22 T 20:42:57 - 07:00 "," updated - at ":" 2014 -04 -24 T 14:56:49 - 07:00 "," title ":""," status ":" pending_approval "," submitted - at ":" 2014 -04 -24 T 14:56:49 - 07:00 "," auditor - note ": null ," reject - reason ": null ," paid ": false ," total ":" 567.07 "," audit - score ": 26 ," exported ": false ," last - exported - at ": null ," external - src - ref ": null ," external - src - name ": null ," currency ":{" id ": 1 ," code ":" USD "}," expensed - by ":{" id ": 20 ," login "user_login "," email ":" user_login@coupa.com "}," created -by ":" id ":" 20, login" user_login "," email ":" user_log@coupa.com "}," updated ":" id "20" login "," user "login ":" user_coupa.com ":" 546 "," external - ref ":{" id "," null ":" 548 - rf ":","外部- ref ":" 548 ":"