検索値APIコールの例

検索値の異なるクエリオプション

検索値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の検索値を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に投稿しました： https://<instance url>/api/lookup_values.

<?xml version="1.0" encoding="UTF-8"?>
<lookup-value>
	 <name>TestAccount2</name>
	 <description>DescAccountNo2</description>
	 <external-ref-num>ExtRefAccnt2</external-ref-num>
	 <external-ref-code>ExtRefAccnt2</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>

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

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

検索値の検索を更新するためのサンプルコード

<?xml version="1.0" encoding="UTF-8"?>
<lookup-value>
	 <lookup-id>2</lookup-id>
</lookup-value>