フィールドAPI
フィールドAPIを使用して、フィールドと関連付けられた(行)データを作成、更新、またはクエリします。
ファクトフィールドは、ファクトシートの列であり、イベントの他のフィールドと同様に、保持される値を指定する名前、数式名、およびデータ型を持っています。
ファクトフィールドは、Excelワークシートのアイテムフィールドや列と同様に保持するデータを定義します。各ファクト行には、データを効率的に使用できるようにするために、各ファクトフィールドに1つの値のみを含める必要があります。
フィールドAPIを使用して、フィールドデータを作成、更新、またはクエリします。これには、アクション（作成/更新/削除）を実行するための特定のエンドポイントと、行に関連するデータが含まれます。
APIにアクセスするためのURLは次のとおりです: https :// .cso.coupahost.com/api/events/{<instance> event - id }/ fact - sheets /{ fact - sheet - id }/ fields
詳細については、統合のベストプラクティスを参照してください。
アクション
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 取得 |
|
index | 取得アクションを実行して、ファクトシートに属するすべてのフィールドを取得します。 |
| 投稿 |
|
作成 | ファクトシートの1つ以上のフィールドを作成します。 |
| プット |
|
更新 | ファクトシート上の1つ以上のフィールドを更新します。大量のアップデートを実行できます。 |
| 削除 |
|
削除 | ファクトシート上のもう1つのフィールドを削除します。一括削除が可能です。 |
| 取得 |
|
表示 | ファクトシートIDの個々のフィールドデータを表示します。 |
| プット |
|
update | フィールドIDを使用して、1つのファクトシートIDの個々のフィールドを更新します。 |
| 削除 |
|
削除 | フィールドIDを使用して、1つのファクトシートIDの個々のフィールドを削除します。 |
要素
これらは、フィールドAPIで使用できる要素です。
| フィールド名 | フィールドの説明 | 申請済み | 一意ですか？ | 許容値 | In | アウト* | タイプ |
|---|---|---|---|---|---|---|---|
| iD |
フィールドのID |
はい | はい | 整数 | |||
| 順序 | フィールドの序数値。 | はい | 整数 | ||||
| type | パッケージのタイプ。 | はい | はい | string | |||
| 名前 | フィールドの名前。 | はい | はい | はい | string | ||
| formula - name | フィールドの数式名。 | はい | はい | string | |||
| 説明 | パッケージの簡単な説明。 | はい | はい | string | |||
| 必須 | パッケージの必須フラグ。 | はい | はい | string | |||
| 小数点以下 | 数値フィールドの小数桁数 | はい | はい | string | |||
| bidder - input | これは、このフィールドが入札者によって記入されるかどうかを示します。 | はい | はい | string | |||
| options | 複数選択フィールドの場合のフィールドのオプション。 | はい | はい | string | |||
| 識別する | このフィールドを区別行に含める必要があるかどうか。 | はい | はい | string | |||
| 式 | 数式タイプフィールドの数式 | はい | はい | string | |||
| min - value | 数値フィールドの最小値 | はい | はい | 番号 | |||
| max - value | 数値フィールドの最大値と、許可されているテキストフィールドの長さ。 | はい | はい | number | |||
| exclude - limits | 最大と最小の制限が含まれているかどうか、除外されているかどうか。 | はい | はい | string |
応答ペイロードはNULL値を表示しません。
例
この例では、Fields APIを照会しました。
https ://.cso.coupacloud.com/api/events/{ event -<instance> id }/ fact - sheets /{ fact - sheet - id }/ fields
https :// .cso.coupacloud.com/api/events/{ event<instance> - id }/ fact - sheets? name [contains ]= factsheetname
イベントID = 9219593444837772101、ファクトシートID = 9220538753431210838のサンプルについて、以下のURLにアクセスしました。
<instance>https://cso.coupacloud.com/api/events/9220538753252871154/fact-sheets/9220538753431210838/fields
フィールドは応答を取得します
{
"合計":6,
"fields ": [
{
"ID ":"9220538753431213703 ",
"ordinal ":1,
"type ":"テキスト",
"name ":" name - fld ",
"formula - name ":" name_fld ",
"description ":" APIの名前フィールド",
"distinguishing ": true
},
{
"ID ":"9220538753431215951 ",
"ordinal ":2,
"type ":"数値",
"name ":" num - fld ",
"formula - name ":" num_fld ",
"description ":"数値フィールド",
"decimals ":2,
"distinguishing ": false,
"exclude - limits ": false
},
{
"ID ":"9220538753431226586 ",
"ordinal ":3,
"type ":"バイナリ",
"name ":" checkbox - demo ",
"formula - name ":" checkbox_demo ",
"description ":"チェックボックスデモフィールド",
"distinguishing ": true
},
{
"ID ":"9220538753431234950 ",
"ordinal ":4,
"type ":"オプション",
"name ":" demo - multi - fld ",
"formula - name ":" demo_multi_fld ",
"description ":"マルチフィールドのデモ",
"options ": {
"default ":0,
"values ": [
{
"name ":" first ",
"value ":1.0
},
{
"NAME ":" SECOND ",
"value ":2.0
},
{
"NAME ":"その他",
"value ":0.0
}
]
},
"distinguishing ": true
},
{
"ID ":"9220538753431237952 ",
"ordinal ":5,
"type ":"フォーミュラ",
"NAME ":"デモ式",
"formula - name ":" DEMO_FORMULA ",
"description ":"デモ式",
"required ": false,
"distinguishing ": false,
"formula ":" demo_factsheet.num_fld "
},
{
"ID ":"9220538753431240094 ",
"ordinal ":6,
"type ":"StringFormula ",
"NAME ":"デモ- txt -数式",
"formula - name ":" demo_txt_formula ",
"description ":"デモテキスト式フィールド",
"distinguishing ": false,
"formula ":" demo_factsheet.name_fld "
}
]
}作成/更新/削除
以下では、Coupa APIを使用してフィールドにアクションを実行する方法を説明します。
作成
/api/events /{ event - id }/ fact - sheets /{ fact - sheet - id }/ fields
以下のペイロードは、イベントに関する新しいフィールドを作成します（ 9219593444837772101およびファクトシートID = 9220538753431210838 ：
ペイロード
{
"fields ": [
{
"type ":"テキスト",
"name ":" name - fld - api ",
"formula - name ":" name_fld - api ",
"description ":" APIの名前フィールド",
"distinguishing ": true
}
{
"type ":"StringFormula ",
"name ":" demo - txt - formula - api ",
"formula - name ":" demo_txt_formula_api ",
"description ":"デモテキスト式フィールド",
"distinguishing ": false,
"formula ":" demo_factsheet.name_fld_api "
}
]
}
回答：201
{
"result ": [
{
"type ":" api.post.added ",
"description ":「2件のオブジェクトが作成されました。」
}
],
"ADDED ":2,
"fields ": [
{
"ID ":"9220538753532394472"
}
{
"ID ":"9220538753530117686"
}
]
}
メモ:数式フィールドは"_"のみを受け取ります。 更新
/api/events /{ event - id }/ fact - sheets /{ fact - sheet - id }/ fields
以下のペイロードはフィールドを更新します。
一度に1つまたは複数のフィールドを更新するには：
ペイロード：
{
"fields ": [
{
"ID ":"9220538753530117686 ",
"type ":"テキスト",
"name ":" name - fld - api - upd ",
"formula - name ":" name_fld_api - upd ",
"description ":" APIの名前フィールド",
"distinguishing ": false
},
{
"ID ":"9220538753532394472 ",
"type ":"StringFormula ",
"name ":" demo - txt - formula - api - upd ",
"formula - name ":" demo_txt_formula_api_upd ",
"DEMO TEXT FORMULA FIELD UPDATE ",
"distinguishing ": true,
"formula ":" demo_factsheet.name_fld_api_upd "
}
]
}
回答：200 OK
{
"result ": [
{
"type ":" api.put.updated ",
"description ":"2件のオブジェクトが更新されました。"
}
],
"updated ":2
}
削除
/api/events /{ event - id }/ fact - sheets /{ fact - sheet - id }/ fields
上記のAPIを使用して、一度に複数のフィールドを削除することができます。
ペイロード：
{
"fields ": [
{
"ID ":"9220538753530117686"
},
{
"ID ":"9220538753532394472"
}
]
}
回答:200 OK
{
"result ": [
{
"type ":" fieldDeletionCompleted ",
"DESCRIPTION ":"以下のフィールドが削除されました: demo - txt - formula - api - upd, name - fld - api - upd.
合計では、0つの値がこれらのフィールドのために削除されました。"
}
],
"DELETED ":2
}更新は寛大な方法で行われます。つまり、1つのリソースの更新に失敗した場合、他のリソースの更新は成功する可能性があります。ペイロードが2つのフィールドを削除しました。削除または更新するには、イベントIDが必要です。
要求が成功すると、HTTP 200応答が返されます。レスポンスの本文には、作成された申請書が含まれます。要求が失敗すると、HTTP 400 Bad Requestが返されます。応答の本文には、XML形式の検証エラーが含まれます。