検索値API (/lookup_values)
検索値APIを使用すると、アカウントの階層を作成できます。
ルックアップ値にアクセスするURLは次のとおりです。 https ://<instance>/api/lookup_values
詳細については、統合のベストプラクティスを参照してください。
アクション
検索値APIでは以下の操作が可能です。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| POST | /api/lookup_values | 作成 | 検索値を作成する |
| GET | /api/lookup_values | インデックス | クエリ検索値 |
| GET | /api/lookup_values /: id | 表示 | 検索値を表示する |
| PUT | /api/lookup_values /: id | 更新 | 検索値を更新する |
Elements
検索値APIでは、次の要素を使用できます。
| 要素 | Description | 必須フィールド？ | 一意？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| アカウントタイプ | account_type | yes | yes | アカウントタイプ | |||
| active | falseの場合アカウントは無効となり、ユーザーは使用できなくなります。 trueの場合アカウントはアクティブとなり、使用可能になります。 | yes | yes | boolean | |||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| created-by | 作成したユーザー | yes | ユーザー | ||||
| depth | depth | yes | 整数 | ||||
| description | 検索値の説明 | yes | yes | 文字列 | |||
| external-ref-code | 階層検索を使用する際、個々の検索値の識別に使用されます。 このフィールドは、ルートLookupValueで始まる外部参照番号フィールドの連結です。 連携によって設定されることはありませんが、更新する既存の検索を識別するために使用されます。 | yes | yes | 文字列 | |||
| external-ref-num | 外部参照番号(会計で使用する場合の実際の勘定科目値) | yes | yes | yes | 文字列 | ||
| ID | Coupaの一意の識別子 | yes | 整数 | ||||
| is-default | is_default | yes | yes | boolean | |||
| lookup | 検索の名前 | yes | yes | yes | 検索 | ||
| lookup-id | lookup_id | yes | yes | 整数 | |||
| 名前 | 検索値の名前 | yes | yes | yes | yes | 文字列 | |
| parent | 親要素の外部参照コード | yes | yes | LookupValue | |||
| parent-id | parent_id | yes | yes | 整数 | |||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| updated-by | 更新したユーザー | yes | ユーザー |
注:
- 検索値の大規模なデータセットを扱う場合は、常にいくつかの条件でGETを制限してください。
- これらの検索値を作成するための検索は、システムにすでに存在している必要があります。