カスタムオブジェクトAPI(/ custom_objects / id)
このページは機械翻訳を使用して翻訳されています。
はじめに
カスタムオブジェクト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} |
更新 | 既存のデータレコードを変更する |
GET | /api/custom_objects/{object_id}/object_instances/ |
インデックス | カスタムオブジェクトのすべてのデータレコードを一覧表示します |
GET | /api/custom_objects/{object_id}/object_instances/{instance_id} |
表示 | 個別のデータレコードを一覧表示します |
要素(オブジェクトインスタンス)
要素 | 説明 | 必須 | 一意 | 許容値 | で | アウト | データタイプ |
---|---|---|---|---|---|---|---|
created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | 任意 | はい | 日時 | |||
created_by | 作成したユーザー | 任意 | はい | ユーザー | |||
カスタムオブジェクトコード | カスタムオブジェクトコード | 任意 | はい | string型 | |||
カスタムオブジェクト名 | カスタムオブジェクト名 | 任意 | はい | string型 | |||
form-response-id | インスタンスを作成したフォーム回答のID | 任意 | はい | 整数 | |||
id | Coupaの内部ID。 | 任意 | はい | 整数 | |||
updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | 任意 | はい | 日時 | |||
updated_by | 更新したユーザー | 任意 | はい | ユーザー |
要素は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>