検索値APIのコール例

検索値のさまざまなクエリオプション

以下は、検索値を使用して希望する結果セットを取得するための使用例です。

このクエリはアクティブな検索値を取得します

https ://<instance>.coupahost.com/api/lookup_values?active=true

このクエリは特定の日付以降に作成された検索値を取得します

https ://<instance>.coupahost.com/api/lookup_values?created_at [gt] = 2014 -04 -22

このクエリは特定の日付以降に作成されたすべての検索のすべての検索値を取得します

https ://<instance>.coupahost.com/api/lookup_values?[ lookup ][ created - at ][ gt ]= 2014 -04 -22

検索値APIの取得例

この例ではIDが1の単一の検索値を検索します。

以下のURLに対してGETリクエストを実行しました。

https ://<instance url>/api/lookup_values/1

または

https ://<instance url>/api/lookup_values? 1

以下は、検索条件に一致したレスポンスの例です。

<?xml version="1.0" encoding="UTF-8"?> <lookup-value> <id type="integer">1</id> <created-at type="datetime">2014-04-23T11:24:10-07:00</created-at> <updated-at type="datetime">2014-04-24T09:08:41-07:00</updated-at> <active type="boolean">true</active> <name>TestAccount1</name> <description>DescAccountNo1</description> <external-ref-num>ExtRefAccnt1</external-ref-num> <external-ref-code>ExtRefAccnt1</external-ref-code> <parent-id nil="true" /> <lookup-id type="integer">1</lookup-id> <depth type="integer">0</depth> <account-type nil="true" /> <lookup> <id type="integer">1</id> <created-at type="datetime">2014-04-23T11:22:10-07:00</created-at> <updated-at type="datetime">2014-04-23T11:22:10-07:00</updated-at> <active type="boolean">true</active> <name>Account</name> <description>Account</description> <fixed-depth type="integer">0</fixed-depth> <level-1-name /> <level-2-name /> <level-3-name /> <level-4-name /> <level-5-name /> <level-6-name /> <level-7-name /> <level-8-name /> <level-9-name /> <level-10-name /> </lookup> <created-by> <id type="integer">1</id> <login>coupasupport</login> <email>upgrade@coupa.com</email> <employee-number nil="true" /> <firstname>Coupa</firstname> <lastname>Support</lastname> <salesforce-id nil="true" /> <mycustom-userfield /> </created-by> <updated-by> <id type="integer">1</id> <login>coupasupport</login> <email>upgrade@coupa.com</email> <employee-number nil="true" /> <firstname>Coupa</firstname> <lastname>Support</lastname> <salesforce-id nil="true" /> <mycustom-userfield /> </updated-by> </lookup-value>

検索値の作成

この例では、COUPAの既存の検索の1つに検索値を挿入しています。参照オブジェクトにはCoupaのシステムIDは使用していません。

以下のURLに対してPOSTリクエストを送信しました。

https ://<instance url>/api/lookup_values。

<?xml version="1.0" encoding="UTF-8"?> <lookup-value> <name>TestAccount</name> <description>DescAccountNo 2</description> <external-ref-num>ExtRefAccnt 2</external-ref-num> <external-ref-code>ExtRefAccnt 2</external-ref-code> <active>yes</active> <lookup> <name>Account</name> </lookup> </lookup-value>

検索値API PUTの取得例

PUTの例:

ルックアップ値を有効または無効にするには

URL: https ://<instance>/api/lookup_values/<id>

ルックアップ値を無効にするためのサンプルコード

<?xml version="1.0" encoding="UTF-8"?> <lookup-value> <active>false</active> </lookup-value>

検索値の説明を更新するには