カスタムオブジェクトAPI (/custom_objects/id)
カスタムオブジェクトAPIを使用して、カスタムオブジェクトの新しいデータレコードを作成します。
はじめに
カスタムオブジェクトAPIを使用して、カスタムオブジェクトのデータレコードを作成、更新、またはクエリします。新しいカスタムオブジェクトを定義する 必要がある場合、UIを使用します。
カスタムオブジェクトAPIにアクセスするためのURLは次のとおりです。 https://<instance>/api/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/ |
インデックス | カスタムオブジェクトのすべてのデータレコードを一覧表示します |
取得 | /api/custom_objects/{object_id}/object_instances/{instance_id} |
表示 | 個別のデータレコードを一覧表示します |
要素(オブジェクトインスタンス)
要素 | 説明 | 必須 | 一意 | 許容値 | で | 出力 | データタイプ |
---|---|---|---|---|---|---|---|
created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | 任意 | はい | 日時 | |||
作成者 | 作成したユーザー | 任意 | はい | ユーザー | |||
カスタムオブジェクトコード | カスタムオブジェクトコード | 任意 | はい | string型 | |||
カスタムオブジェクト名 | カスタムオブジェクト名 | 任意 | はい | string型 | |||
フォームの回答ID | インスタンスを作成したフォームの回答のID | 任意 | はい | 整数 | |||
id | Coupa内部ID | 任意 | はい | 整数 | |||
updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | 任意 | はい | 日時 | |||
更新者 | 更新したユーザー | 任意 | はい | ユーザー |
要素はGET呼び出しにのみ使用されます。POSTまたはPUTコールには、カスタムオブジェクト定義で使用されるカスタムフィールドのみが含まれます。詳細については、以下のサンプルを参照してください。
サンプルのペイロード
カスタムオブジェクトは完全にカスタムフィールドで構成されているため、カスタムフィールドを名前空間に含める必要があ custom-field
ります。基本的な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>
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。