ファクトシートAPI

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

ファクトフィールドは、エクセルのワークシートのアイテムフィールドや列と同様に、保持するデータを定義します。データを効率的に使用するには、各事実行に各ファクトフィールドの値を1つだけ含める必要があります。ファクトシートは、イベントにデータを入力するために使用されます。たとえば、過去の量やその他のアイテム仕様、サプライヤーの業績スコア、工場の住所やコードのリスト、物品やサービス、郵便番号、緯度などです。 

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

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

詳細については、 「インテグレーションのベストプラクティス 」を参照してください。

アクション

要素

ファクトシートAPIで使用できる要素は次のとおりです

例

この例では、ファクトシートAPIについてクエリを実行しました。

https://<instance>.cso.coupahost.com/api/events/{event-id}/fact-sheets 

サンプルのイベントID = ：のために以下のURLにGETを実行しま9219593444837772101した 

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

ファクトシートの回答の取得

{
		"total": 4,
		"fact-sheets": [
				{
						"id": "9219593444824438589",
						"ordinal": 0,
						"type": "Ordinary",
						"name": "B_Supernova 2014 - Rd2 Analysis",
						"formula-name": "b_supernova_2014_rd2_analysis",
						"event-id": "9219593444837772101",
						"created-time": "2015-02-27T16:56:09.875+0000"
				},
				{
						"id": "9219593444824438592",
						"ordinal": 1,
						"type": "Ordinary",
						"name": "PD_Project details",
						"formula-name": "pd_project_details",
						"event-id": "9219593444837772101",
						"created-time": "2015-02-27T16:56:09.875+0000"
				},
				{
						"id": "9219601795978222763",
						"ordinal": 1,
						"type": "Reporting",
						"name": "Management Reporting",
						"formula-name": "management_reporting",
						"event-id": "9219593444837772101",
						"created-time": "2020-02-10T03:17:03.96+0000"
				},
				{
						"id": "9219601942217814052",
						"ordinal": 1,
						"type": "Reporting",
						"name": "Test All Event Status",
						"formula-name": "test_all_event_status",
						"event-id": "9219593444837772101",
						"description": "Test All Event Status",
						"created-time": "2020-09-09T10:30:07.376+0000"
				} 
	 ]
}

作成/更新/削除

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

作成

/api/events/:id/fact-sheets

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

Payload: 
{
		"fact-sheets": [
				{
						"id": "9220538753431210838",
						"name": "demo-factsheet-new",
						"event-id": "9220538753252871154",
						"description": "testing demo fact sheet using API"
				}
		]
}

Response: 201
{
		"result": [
				{
						"type": "api.post.added",
						"description": "1 objects created."
				}
		],
		"added": 1,
		"fact-sheets": [
				{
						"id": "9220538753455571178"
				}
		]
}		

更新

/api/events/{event-id}/fact-sheets

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

To update one or more Event at a time: 
Payload:
{
		"fact-sheets": [
				{
						"id": "9220538753461853110",
						"name": "demo-factsheet-newest",
						"formula-name": "demo_factsheet_newest",
						"description": "testing demo fact sheet using API with ordinal"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "api.put.updated",
						"description": "1 objects updated."
				}
		],
		"updated": 1
}

You can update only name/formula-name/description fields on a fact sheet.

削除

/api/events/{event-id}/fact-sheets

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

Payload:
{
		"fact-sheets": [
				{
						"id": "9220538753461853110"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "removedFactSheets",
						"description": "Removed the following fact sheets: demo-factsheet-newest"
				}
		],
		"deleted": 1
}

成功したリクエストは返り HTTP 200 Responseます。回答の本文には、作成された申請書が含まれます。失敗したリクエストは返 HTTP 400 Bad Requestされる。応答の本文には、XMLとしてフォーマットされた検証エラーが含まれます。