ファクトシートAPI
ファクトシートは、CSOでのソーシングイベントの前、最中、および後に、さまざまなソースからのデータを保存、適用、整理、および処理するために使用されます。
ファクトフィールドは、Excelワークシートのアイテムフィールドや列と同様に保持するデータを定義します。 各ファクト行には、データを効率的に使用できるようにするために、各ファクトフィールドに1つの値のみを含める必要があります。 ファクトシートは、イベントにデータを入力するために使用されます。たとえば、過去の取引数量やその他の品目仕様、サプライヤーのパフォーマンススコア、工場・製品・サービスに関する住所やコードの一覧、郵便番号、緯度などが該当します。
ファクトシートAPIを使用して、ファクトシートデータの作成、更新、照会を行います。 これには、作成・更新・削除などの操作を行うための専用エンドポイントや、行やフィールドに関連するデータも含まれます。
APIアクセス用のURLは次の通りです。https://<instance>.cso.coupahost.com/api/events/{event-id}/fact-sheets
詳細については、統合のベストプラクティスを参照してください。
アクション
動詞 | パス | アクション | Description |
|---|---|---|---|
GET |
| インデックス | GETアクションを実行し、すべてのファクトシートを取得 |
POST |
| 作成 | 1つまたは複数のファクトシートオブジェクトを作成。 |
PUT |
| 更新 | 1つまたは複数のファクトシートを更新。 一括更新も可能です。 |
DELETE |
| delete | 1つまたは複数のファクトシートを削除。 一括削除も可能です。 |
GET |
| 表示 | 1つのファクトシートIDのファクトシートデータを表示。 |
PUT |
| 更新 | ファクトシートIDを使用して1つずつファクトシートを更新 |
DELETE |
| delete | ファクトシートを1つずつ削除。 |
Elements
ファクトシートAPIで使用できる要素は次のとおりです。
フィールド名 | フィールドの説明 | 必須 | 一意？ | 許容値 | 入力 | アウト* | Type |
|---|---|---|---|---|---|---|---|
ID | ファクトシートのID | はい | yes | 整数 | |||
ordinal | ファクトシートの序数値 | yes | 整数 | ||||
type | ファクトシートのタイプ。 一度設定すると、変更できません | yes | 通常、レポート | yes | 文字列 | ||
名前 | ファクトシートの名前 | yes | yes | yes | 文字列 | ||
formula-name | ファクトシートの数式名 | yes | yes | 文字列 | |||
event-id | ファクトシートのイベントID。 一度設定すると、変更できません | yes | yes | 整数 | |||
description | 簡潔な説明 | yes | yes | 文字列 | |||
created-time | ファクトシートが作成された時刻。 ISO8601形式 | yes | datetime |
レスポンスのペイロードにはnull値は含まれません。
例
この例では、ファクトシートAPIに対してクエリを実行しました。
https ://<instance>.cso.coupahost.com/api/events/{event-id}/ファクトシート
Event - id = 9219593444837772101 のサンプルについて、以下のURLにアクセスしました。
htpss ://<instance>.cso.coupacloud.com/api/events/9219593444837772101/fact-sheets
ファクトシートGETレスポンス
{" total ": 4 ," fact - sheets ":[{" id ":" 9219593444824438589 "," ordinal ": 0 ," type ":" Ordinary "," name ":" B_Supernova 2014 - Rd 2 Analysis "," formula - name ":" b_supernova_2014_rd 2_analysis "," event - id ":" 9219593444837772101 "," created - time ":" 2015 -02 -27 T 16:56:09.875 +0000 "},{" id ":" 9219593444824438592 "," ordinal ":" type ":" Ordinary "," name ":" PD_Project details "," formula - name ":" pd_project_details "," event - id ":" 9219593444837772101 "," created - time ":" 2015 -02 -27 T 16:56:09.875 +0000 "}," id ":" 92196017978222763 "," ordinal ":" 1 ," type ":":" name ":" Management Reporting "," formula - name ":" management_reporting "," event - id ":" 921959344372101 "," created "time ":" 2020 -02 -02:09 ":" T ":" name ":" Management Reporting ","作成/更新/削除
以下はCoupa APIを使ってファクトシートに対してアクションを実行する方法の説明です。
Create
/api/events /: id/fact - sheets
以下のペイロードは、イベント(9220538753252871154)に新しいファクトシートを作成します
ペイロード：{" fact - sheets ":[{" id ":" 9220538753431210838 "," name ":" demo - factsheet - new "," event - id ":" 9220538753252871154 "," description ":" testing demo fact sheet using API "}]}応答： 201 {" result ":[{" type ":" api.post.added "," description ":" 1 objects created ." }]," added ": 1 ," fact - sheets ":[{" id ":" 9220538753455571178 "}]}Update
/api/events/{event-id}/ファクトシート
以下のペイロードは、ファクトシートを更新します。
一度に1つ以上のイベントを更新するには：ペイロード：{" fact - sheets ":[{" id ":" 9220538753461853110 "," name ":" demo - factsheet - newest "," formula - name ":" demo_factsheet_newest "," description ":" test demo fact sheet using API with ordinal "}]}応答： 200 OK {" result ":[{" type ":" api.put.updated "," description ":" 1 objects updated ." }]," updated ": 1}ファクトシートのname/formula - name/descriptionフィールドのみを更新できます。削除
/api/events/{event-id}/ファクトシート
上記のAPIを使用して、一度に複数のファクトシートを削除できます。
ペイロード：{" fact - sheets ":[{" id ":" 9220538753461853110 "}]}応答： 200 OK {" result ":[{" type ":" removedFactSheets "," description ":" Removed the following fact - sheets: demo - factsheet - newest "}]," deleted ": 1}更新は寛容に処理されます。つまり、1つのリソースの更新に失敗しても、他のリソースは成功する場合があります。 このペイロードでは、1つのイベントを削除します。 削除や更新を行うには、イベントIDが必須です。
成功した要求は HTTP 200応答を返します。 レスポンスの本文には作成された申請書が含まれます。 リクエストが失敗すると、次が返されます:
HTTP 400不正な要求. レスポンスの本文にはXML形式の検証エラーが含まれます。