カスタムオブジェクトAPI (/custom_objects/id)
概要
カスタムオブジェクトAPIを使用して、カスタムオブジェクトのデータレコードを作成、更新、または検索します。 新しいカスタムオブジェクトを定義する必要がある場合は、UIを使用します。
カスタムオブジェクトAPIにアクセスするURLは次のとおりです。 https ://<instance>/api/custom_objects/{object_id}
詳細については、統合のベストプラクティスを参照してください。
アクション
| 動詞 | パス | アクション | Description |
|---|---|---|---|
| POST | /api/custom_objects/{object_id}/object_instances/ | 作成 | カスタムオブジェクトの新規データレコードを作成 |
| PUT | /api/custom_objects/{object_id}/object_instances/{instance_id} | 更新 | 既存のデータレコードを変更 |
| GET | /api/custom_objects/{object_id}/object_instances/ | インデックス | カスタムオブジェクトのすべてのデータレコードを一覧表示 |
| GET | /api/custom_objects/{object_id}/object_instances/{instance_id} | 表示 | 個々のデータレコードを一覧表示 |
要素(オブジェクトインスタンス)
| 要素 | Description | 必須 | 一意 | 許容値 | 入力 | 出力 | データタイプ |
|---|---|---|---|---|---|---|---|
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | any | yes | datetime | |||
| created-by | 作成したユーザー | any | yes | ユーザー | |||
| custom-object-code | カスタムオブジェクトコード | any | yes | 文字列 | |||
| custom-object-name | カスタムオブジェクト名 | any | yes | 文字列 | |||
| form-response-id | インスタンスを作成したフォームレスポンスのID | any | yes | 整数 | |||
| ID | Coupaの内部ID | any | yes | 整数 | |||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | any | yes | datetime | |||
| updated-by | 更新したユーザー | any | yes | ユーザー |
注:
要素はGET呼び出しにのみ使用されます。 POSTまたはPUT呼び出しには、カスタムオブジェクト定義で使用されているカスタムフィールドのみが含まれます。 詳しくは、以下のサンプルをご覧ください。
サンプルペイロード
カスタムオブジェクトは完全にカスタムフィールドで構成されているため、カスタムフィールドを カスタムフィールド 名前空間に含める必要があります。 基本的なPOSTまたはPUTは、次の形式にする必要があります。
<object-instance> <custom-fields> <custom-field-1>custom - field -1 - value</custom-field-1> <custom-field-2>custom - field -2 - value</custom-field-2> ... <custom-field-10>custom - field -10 - value</custom-field-10> <custom-fields> </object-instance>