APIの戻り形式

仕組み

オプションのクエリパラメーター return_object では、次の3つの値がサポートされるようになりました。

• none ：何も返されません。これはPUTとPOSTに対してのみサポートされます（GETのようなクエリでは意味がありません）。
• limited : IDのみが返されます。これは、すべてのコマンドでサポートされています。
• shallow ：このパラメーターは、呼び出されているオブジェクトのすべての属性/フィールドと、1つの深い関連付けのIDとナチュラルキーのみを返します。

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

• POSTコマンド
• PUTコマンド
• GETコマンド

［ fields クエリ演算子を使用すると、レスポンスボディに必要なフィールドを渡すことができます。の形式 fields 値はJSONです。以下の例を参照してください。

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

オブジェクトを返す

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

作成時および更新時にサポートされるreturn_object値は、none、limited、およびshallowです。

クエリ呼び出し時にサポートされる値は、limitedとshallowです。

例：クエリの制限応答

Query:  https://example.coupahost.com/api/expense_reports?return_object=limited
Response Code:  200
Response Body:
{“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-05T00:00:00-08:00",
     "start-date":"2010-02-05T00:00:00-08:00",
     "expense-category":{
       "name":"Airfare",
     }
   },
 ],
}
Response Code:  200
Response Body:

例：作成時の浅い応答

Query:  https://example.coupahost.com/api/ex...object=shallow
Response Code:  200
Response Body:
{
 "id":158,
 "created-at":"2010-09-22T20:42:57-07:00",
 "updated-at":"2014-04-24T14:56:49-07:00",
 "title":"",
 "status":"pending_approval",
 "submitted-at":"2014-04-24T14: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_login@coupa.com"
 },
 "updated-by":{
   "id":20,
   "login":"user_login",
   "email":"user_login@coupa.com"
 },
 "expense-lines":[
   {
     "id":546,
     "external-src-ref":null
   },
   {
     "id":547,
     "external-src-ref":null
   },
   {
     "id":548,
     "external-src-ref":null
   },
   {
     "id":549,
     "external-src-ref":null
   }
 ],
 "comments":[ ]
}