カスタムオブジェクトAPI (/ custom_objects/id)
カスタムオブジェクトAPIを使用して、カスタムオブジェクトの新しいデータレコードを作成します。
はじめに
カスタムオブジェクトAPIを使用して、カスタムオブジェクトのデータレコードを作成、更新、またはクエリします。新しいカスタムオブジェクトを定義する必要がある場合は、UIを使用します。
カスタムオブジェクトAPIにアクセスするURL: https :///api<instance>/custom_objects /{ object_id}
詳細については、統合のベストプラクティスを参照してください。
アクション
動詞 | パス | アクション | 説明 |
---|---|---|---|
投稿 | /api/custom_objects /{ object_id }/ object_instances/ |
作成 | カスタムオブジェクトの新しいデータレコードを作成する |
プット | /api/custom_objects /{ object_id }/ object_instances /{ instance_id} |
更新 | 既存のデータレコードを変更する |
取得 | /api/custom_objects /{ object_id }/ object_instances/ |
index | カスタムオブジェクトのすべてのデータレコードを一覧表示します |
取得 | /api/custom_objects /{ object_id }/ object_instances /{ instance_id} |
表示 | 個々のデータレコードを一覧表示する |
要素(オブジェクトインスタンス)
要素 | 説明 | 申請済み | 一意 | 許容値 | In | アウト | データタイプ |
---|---|---|---|---|---|---|---|
created - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | 任意の | はい | 日時 | |||
created - by | 作成したユーザー | 任意の | はい | ユーザー | |||
custom - object - code | カスタムオブジェクトコード | 任意の | はい | string | |||
custom - object - name | カスタムオブジェクト名 | 任意の | はい | string | |||
form - response - id | インスタンスを作成したフォーム回答のID | any | はい | 整数 | |||
iD | Coupaの内部ID | any | はい | 整数 | |||
updated - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | 任意の | はい | 日時 | |||
更新者: | 更新したユーザー | any | はい | ユーザー |
メモ
要素はGET呼び出しにのみ使用されます。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>