• 最終編集日時: 25 March 2021

ファクトシートAPI

ファクトシートAPIを使用して、ファクトシートと関連する(行/フィールド)データを作成、更新、またはクエリします。

ファクトシートは、CSOでのソーシングイベントの前、最中、および後に、さまざまなソースからのデータを保存、適用、整理、および処理するために使用されます。

ファクトフィールドは、Excelワークシートのアイテムフィールドや列と同様に保持するデータを定義します。各ファクト行には、データを効率的に使用できるようにするために、各ファクトフィールドに1つの値のみを含める必要があります。ファクトシートは、イベントにデータを入力するために使用されます。たとえば、履歴ボリュームまたは他のアイテム仕様、サプライヤーパフォーマンススコア、工場、物品またはサービス、郵便番号、緯度などの住所とコードのリストなどです。 

ファクトシートAPIを使用して、ファクトシートデータの作成、更新、クエリを実行します。これには、アクションを実行する特定のエンドポイント(作成/更新/削除)と、行、フィールドに関連するデータが含まれます。

APIにアクセスするためのURLは次のとおりです。https :// .cso.coupahost.com/api/events/{<instance> event - id }/ fact - sheets

詳細については、統合のベストプラクティスを参照してください。

アクション

動詞 パス アクション 説明
取得 /api/events /{ event - id }/ファクトシート index すべてのファクトシートを取得するための取得アクションを実行
投稿 /api/events /{ event - id }/ファクトシート 作成 1つまたは複数のファクトシートオブジェクトを作成します。
プット /api/events /{ event - id }/ファクトシート 更新 1つまたは複数のファクトシートを更新します。大量のアップデートを実行できます。
削除 /api/events /{ event - id }/ファクトシート delete もう1つのファクトシートを削除します。一括削除が可能です。
取得 /api/events /{ event - id }/ fact - sheets /{ fact - sheet - id} 表示 1つのファクトシートIDのファクトシートデータを表示します。 
プット /api/events /{ event - id }/ fact - sheets /{ fact - sheet - id} update ファクトシートIDを使用して一度に1つのファクトシートを更新
削除 /api/events /{ event - id }/ fact - sheets /{ fact - sheet - id} delete ファクトシートを1つずつ削除します。

要素

これらはファクトシートAPIで利用可能な要素です。

フィールド名 フィールドの説明 申請済み 一意ですか? 許容値 In アウト* タイプ
iD

ファクトシートのID

  はい     はい 整数
順序 ファクトシートの順序値         はい 整数
タイプ ファクトシートのタイプ。いったん設定すると、変更できません はい  

経常、報告

  はい string
名前 ファクトシートの名称 はい     はい はい string
formula - name ファクトシートの数式名       はい はい string
event - id ファクトシートのイベントID。一度設定すると、変更できません       はい はい 整数
説明 簡単な説明       はい はい string
created - time ファクトシートが作成された時刻。ISO 8601形式         はい 日時
メモ

 応答ペイロードはNULL値を表示しません。

この例では、ファクトシートAPIを照会しました。

https ://.cso.coupahost.com/api/events/{ event<instance> - id }/ファクトシート 

 Event - id = 9219593444837772101のサンプルについて、以下のURLにアクセスしました。 

htpss<instance> ://.cso.coupacloud.com/api/events/9219593444837772101/fact-sheets

ファクトシートは応答を取得します

{

		"TOTAL ":4,

		"FACT - SHEETS ": [

				{

						"ID ":"9219593444824438589 ",

						"ordinal ":0,

						"type ":"通常",

						"name ":"B_Supernova 2014 - Rd 2分析",

						"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 ":1,

						"type ":"通常",

						"NAME ":"PD_Projectの詳細",

						"formula - name ":" pd_project_details ",

						"event - id ":"9219593444837772101 ",

						"created - time ":"2015 -02 -27 T 16:56:09.875 +0000"

				},

				{

						"ID ":"9219601795978222763 ",

						"ordinal ":1,

						"type ":"レポート",

						"name ":"管理レポート",

						"formula - name ":" management_reporting ",

						"event - id ":"9219593444837772101 ",

						"created - time ":"2020 -02 -10 T 03:17:03.96 +0000"

				},

				{

						"ID ":"9219601942217814052 ",

						"ordinal ":1,

						"type ":"レポート",

						"name ":"すべてのイベントステータスをテスト",

						"formula - name ":" test_all_event_status ",

						"event - id ":"9219593444837772101 ",

						"DESCRIPTION ":"すべてのイベントステータスをテスト",

						"created - time ":"2020 -09 -09 T 10:30:07.376 +0000"

				} 

	 ]

}

作成/更新/削除

以下では、Coupa APIを使用してファクトシートでアクションを実行する方法について説明します。

作成

/api/events /: id/fact - sheets

以下のペイロードは、イベント 9220538753252871154 )の新しいファクトシートを作成します

ペイロード: 

{

		"FACT - SHEETS ": [

				{

						"ID ":"9220538753431210838 ",

						"NAME ":" DEMO - FACTSHEET - NEW ",

						"event - id ":"9220538753252871154 ",

						"description ":" APIを使用したデモファクトシートのテスト"

				}

		]

}



回答:201

{

		"result ": [

				{

						"type ":" api.post.added ",

						"description ":"1件のオブジェクトが作成されました。"

				}

		],

		"ADDED ":1,

		"FACT - SHEETS ": [

				{

						"ID ":"9220538753455571178"

				}

		]

}		

更新

/api/events /{ event - id }/ファクトシート

以下のペイロードは、ファクトシートを更新します。  

一度に1つまたは複数のイベントを更新するには: 

ペイロード:

{

		"FACT - SHEETS ": [

				{

						"ID ":"9220538753461853110 ",

						"NAME ":"デモ-ファクトシート-最新",

						"formula - name ":" DEMO_FACTSHEET_NEWEST ",

						"description ":"順序付きAPIを使用したデモファクトシートのテスト"

				}

		]

}



回答:200 OK

{

		"result ": [

				{

						"type ":" api.put.updated ",

						"description ":"1件のオブジェクトが更新されました。"

				}

		],

		"更新済み":1

}



ファクトシート上のname/formula - name/descriptionフィールドのみを更新できます。

削除

/api/events /{ event - id }/ファクトシート

上記のAPIを使用して、一度に複数のファクトシートを削除することができます。 

ペイロード:

{

		"FACT - SHEETS ": [

				{

						"ID ":"9220538753461853110"

				}

		]

}



回答:200 OK

{

		"result ": [

				{

						"type ":" removedFactSheets ",

						"description ":"以下のファクトシートを削除しました: demo - factsheet - newest"

				}

		],

		"DELETED ":1

}
メモ

 更新は寛大な方法で行われます。つまり、1つのリソースの更新に失敗した場合、他のリソースの更新は成功する可能性があります。ペイロードが1つのイベントを削除しました。削除または更新するには、イベントIDが必要です。

要求が成功すると、HTTP 200応答が返されます。レスポンスの本文には、作成された申請書が含まれます。要求が失敗すると、HTTP 400 Bad Requestが返されます。応答の本文には、XML形式の検証エラーが含まれます。

関連アイテム


フィールドAPI

25 March 2021

フィールドAPIを使用して、フィールドと関連付けられた(行)データを作成、更新、またはクエリします。

マーケットAPI

25 March 2021

マーケットAPIを使用して、マーケットの作成、更新、クエリを実行します。

ユーザーAPI

25 March 2021

ユーザーAPIを使用して、ユーザーデータの作成、更新、クエリを実行します。

会社のAPI

25 March 2021

会社のAPIを使用して、会社のデータを作成、更新、またはクエリします。