Get Historical Collaboration Order Forecasts

You can use a REST API to retrieve historical collaboration order forecasts.

Let's discuss these scenarios:

• Get historical collaboration order forecast quantities for a given collaboration order forecast.

Here's a typical application processing flow for the scenarios:

1. You can get historical collaboration order forecast data for the previous collaboration order forecast cycles for a specific current cycle collaboration order forecast.
2. You create a solution that allows your customer to use a client to connect to your partner application.

Get Historical Collaboration Order Forecast Quantities for a Given Collaboration Order Forecast

To get historical collaboration order forecast quantities for a collaboration plan:

1. Query the historical aggregated collaboration order forecast and commit quantities for a given collaboration order forecast where the planning cycle start date is greater than or equal to 2018-01-10.

   Note:

   In order to query attribute values for a child resource, you must add the header, REST-Framework-Version: 2.
2. The response payload includes details that describe the results of the request.
3. You can extract the values for these attributes from the response payload, and display them in the client.

   Attribute	Description
   CollaborationOrderForecastId	Value that uniquely identifies the collaboration order forecast across collaboration cycles. This identifier is available on collaboration order forecasts for the current and historical cycles.
   PlanningCycleStartDate	Date when the collaboration planning cycle begins.
   PlanningCycleEndDate	Date when the collaboration planning cycle ends.
   ShipFromSupplierSiteName	Name of the supplier site that ships the item.
   ShipToOrganizationCode	Abbreviation that identifies the organization that receives the item.
   ItemNumber	Number of the item.
   aggregatedQuantities.BucketAggregationCode	Abbreviation that identifies the bucket aggregation type for the aggregated quantity. Values include ORA_VCS_BCKT_AGGR_WEEKLY or ORA_VCS_BCKT_AGGR_MONTHLY.
   aggregatedQuantities.BucketStartDate	Date when the time bucket starts.
   aggregatedQuantities.BucketEndDate	Date when the time bucket ends.
   aggregatedQuantities.ForecastQuantity	Most recent forecast quantity of the aggregation type.
   aggregatedQuantities.CommitQuantity	Most recent commit quantity of the aggregation type.

Example URL

Use this resource URL format.

GET

curl --user username:password "https://servername /fscmRestApi/resources/version/collaborationOrderForecastHistory?q=CollaborationOrderForecastId=5008;PlanningCycleStartDate>='2018-01-10'&fields=SupplyPlanName,ShipFromSupplierSiteName,ShipToOrganizationCode,ItemNumber,PlanningCycleStartDate,PlanningCycleEndDate;aggregatedQuantities:BucketAggregationCode,ForecastQuantity,CommitQuantity,BucketStartDate,BucketEndDate&onlyData=true"

Example Response

Here's an example of the response body in JSON format.

{
	"items": [
	{
		"CollaborationOrderForecastId": 5008,
		"PlanningCycleStartDate": "2018-01-10",
		"PlanningCycleEndDate": "2018-01-16",
		"ShipFromSupplierSiteName": "CV_SuppD05Site3",
		"ShipToOrganizationCode": "D1",
		"ItemNumber": "SCC-MEMDL370-01",
		"aggregatedQuantities": [
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-01-23",
			"BucketEndDate": "2018-01-23",
			"ForecastQuantity": 21,
			"CommitQuantity": 1
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-01-30",
			"ForecastQuantity": 20,
			"CommitQuantity": 20
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-06",
			"ForecastQuantity": 30,
			"CommitQuantity": 30
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-13",
			"ForecastQuantity": 30,
			"CommitQuantity": 30
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-20",
			"ForecastQuantity": 30,
			"CommitQuantity": 30
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-27",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-03-06",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-03-13",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-03-20",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Monthly",
			"BucketStartDate": "2018-01-01",
			"ForecastQuantity": 41,
			"CommitQuantity": 21
		},
		{
			"BucketAggregationCode": "Monthly",
			"BucketStartDate": "2018-02-1",
			"ForecastQuantity": 190,
			"CommitQuantity": 190
		},
		{
			"BucketAggregationCode": "Monthly",
			"BucketStartDate": "2018-03-1",
			"ForecastQuantity": 300,
			"CommitQuantity": 300
		}
		]
	},
	{
		"CollaborationOrderForecastId": 5008,
		"PlanningCycleStartDate": "2018-01-17",
		"PlanningCycleEndDate": "2018-01-23",
		"ShipFromSupplierSiteName": "CV_SuppD05Site3",
		"ShipToOrganizationCode": "D1",
		"ItemNumber": "SCC-MEMDL370-01",
		"aggregatedQuantities": [
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-01-23",
			"ForecastQuantity": 21,
			"CommitQuantity": 1
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-01-30",
			"ForecastQuantity": 20,
			"CommitQuantity": 20
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-06",
			"ForecastQuantity": 30,
			"CommitQuantity": 30
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-13",
			"ForecastQuantity": 30,
			"CommitQuantity": 30
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-20",
			"ForecastQuantity": 30,
			"CommitQuantity": 30
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-02-27",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-03-06",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-03-13",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Weekly",
			"BucketStartDate": "2018-03-20",
			"ForecastQuantity": 100,
			"CommitQuantity": 100
		},
		{
			"BucketAggregationCode": "Monthly",
			"BucketStartDate": "2018-01-01",
			"ForecastQuantity": 41,
			"CommitQuantity": 21
		},
		{
			"BucketAggregationCode": "Monthly",
			"BucketStartDate": "2018-02-1",
			"ForecastQuantity": 190,
			"CommitQuantity": 190
		},
		{
			"BucketAggregationCode": "Monthly",
			"BucketStartDate": "2018-03-1",
			"ForecastQuantity": 300,
			"CommitQuantity": 300
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/collaborationOrderForecastHistory",
		"name": "collaborationOrderForecastHistory",
		"kind": "collection"
	}
	]
}