Get all order forecasts

get

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Find collaboration order forecast records according to the primary key.
      Finder Variables
      • CollaborationOrderForecastId; integer; Value that uniquely identifies the order forecast.
    • vcsFindByCollabOrderForecastId Finds collaboration order forecast records according to the primary key.
      Finder Variables
      • CollaborationOrderForecastId; integer; Value that uniquely identifies the order forecast.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • B2BOnlyFlag; boolean; Contains one of the following values: true or false. If true, then the collaboration order forecast was published to the supplier using only B2B messaging. If false, then B2B messaging wasn't the only method to publish the collaboration order forecast. This attribute doesn't have a default value.
    • CollaborationCycleVersion; integer; Version of the collaboration planning cycle.
    • CollaborationOrderForecastId; integer; Value that uniquely identifies the collaboration order forecast.
    • CollaborationPlanId; integer; Value that uniquely identifies the collaboration plan scenario.
    • CollaborationPlanName; string; Name of the collaboration plan.
    • CollaborationSourceId; integer; Value that uniquely identifies the collaboration plan.
    • CommitDate; string; Date when the supply was committed against the collaboration order forecast.
    • CommitDueDate; string; Date when the supply commits are due for the collaboration order forecast.
    • CommitTotalQuantity; number; Sum of the commit quantities over the commit horizon for a collaboration order forecast.
    • CorrelationCode; string; Abbreviation that identifies the orchestration process instance.
    • CreatedBy; string; User who created the collaboration order forecast.
    • CreatedByPersonId; integer; Value that uniquely identifies the person that created the collaboration order forecast.
    • CreationDate; string; Date and time when the user created the collaboration order forecast.
    • DropShipFlag; boolean; Contains one of the following values: true or false. If true, then the collaboration order forecast data is for a drop ship relationship. If false, then the collaboration order forecast data isn't for a drop ship relationship. This attribute doesn't have a default value.
    • ForecastTotalCommitHorizonQuantity; number; Sum of the forecast quantities over the commit horizon for a collaboration order forecast.
    • ForecastTotalForecastHorizonQuantity; number; Sum of the forecast quantities over the forecast horizon for a collaboration order forecast.
    • InventoryItemId; string; Value that uniquely identifies the inventory item in the relationship candidate.
    • ItemCategory; string; Category that the application assigns to the item from the default planning catalog.
    • ItemDescription; string; Description of the item.
    • ItemNumber; string; Number that identifies the item.
    • LastUpdateDate; string; Date and time when the user most recently updated the collaboration order forecast.
    • LastUpdatedBy; string; Login of the user who most recently updated the collaboration order forecast.
    • ManufacturerName; string; Name of the manufacturer.
    • ManufacturerPartNumber; string; Number that identifies the item at the manufacturer.
    • NoteToPlanner; string; Note provided by the supplier to the collaboration planner.
    • NoteToSupplier; string; Note provided by the collaboration planner to the supplier.
    • OnHandPublishedByUserName; string; User who most recently published the on-hand quantity.
    • OnHandPublishedDate; string; Date when the on-hand quantity was published.
    • OnHandQuantity; number; Quantity of the on-hand inventory for the collaboration order forecast item.
    • PlanningCycleEndDate; string; Date when the collaboration planning cycle ends.
    • PlanningCycleStartDate; string; Date when the collaboration planning cycle begins.
    • ProcurementBUId; integer; Value that uniquely identifies the business unit.
    • ProcurementBUName; string; Name of the business unit. The application assigns the supplier to this business unit.
    • PublishedByPersonId; integer; Value that uniquely identifies the most recent user to publish the collaboration order forecast.
    • PublishedByUserName; string; User who most recently published the collaboration order forecast.
    • PublishedDate; string; Date when the collaboration order forecast was published.
    • ShipFromSupplierAlternateName; string; Alternate name of the supplier that ships the item.
    • ShipFromSupplierDUNS; string; Data universal numbering system of the supplier who ships the item.
    • ShipFromSupplierId; integer; Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
    • ShipFromSupplierName; string; Name of the supplier that ships the item.
    • ShipFromSupplierNumber; string; Number that identifies the supplier that ships the item.
    • ShipFromSupplierSiteId; integer; Value that uniquely identifies the supplier site in the relationship. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
    • ShipFromSupplierSiteName; string; Name of the supplier site that ships the item.
    • ShipToCustomerId; integer; Value that uniquely identifies the customer who will receive the item. It's a primary key that the application creates when it creates the customer.
    • ShipToCustomerName; string; Name of the customer that receives the item.
    • ShipToCustomerSiteId; integer; Value that uniquely identifies the customer site who will receive the item. It's a primary key that the application creates when it creates the customer site.
    • ShipToCustomerSiteName; string; Name of the customer site that received the item.
    • ShipToOrganizationCode; string; Abbreviation that identifies the organization that receives the item.
    • ShipToOrganizationId; string; Value that uniquely identifies the organization in the collaboration order forecast. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
    • ShipToOrganizationName; string; Name of the organization that receives the item.
    • ShipToSupplierId; integer; Value that uniquely identifies the supplier who receives the item. It's a primary key that the application generates when it creates the supplier.
    • ShipToSupplierName; string; Name of the supplier that receives the item.
    • ShipToSupplierSiteId; integer; Value that uniquely identifies the supplier site in the collaboration order forecast. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
    • ShipToSupplierSiteName; string; Name of the supplier site in the collaboration order forecast that receives the item.
    • SourceSystem; string; Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
    • SourceSystemCode; string; Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
    • Status; string; Value that indicates the current state of the collaboration order forecast. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
    • StatusCode; string; Abbreviation that identifies the current state of the collaboration order forecast. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
    • SupplierItemNumber; string; Number that identifies the item referred to by the supplier.
    • SupplierOnHandPublishedByUserName; string; User who most recently published the supplier on-hand quantity.
    • SupplierOnHandPublishedDate; string; Date when the supplier on-hand quantity was published.
    • SupplierOnHandQuantity; number; Quantity of the supplier's on-hand inventory for the collaboration order forecast item.
    • SupplyPlanDescription; string; Description of the supply plan that was used to generate the collaboration order forecast.
    • SupplyPlanName; string; Name of the supply plan that was used to generate the collaboration order forecast.
    • SupplyPlanVersion; integer; Version of the supply plan that was used to generate the collaboration order forecast.
    • UOMCode; string; Abbreviation that identifies the unit of measure for the item.
    • UnitOfMeasure; string; Unit of measure for the item.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : collaborationOrderForecasts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationOrderForecasts-item-response
Type: object
Show Source
Nested Schema : Commit Quantities
Type: array
Title: Commit Quantities
The Commit Quantities resource gets the current commit measure details associated with the collaboration order forecast. This resource can also be used to respond to collaboration order forecasts by providing supply commits.
Show Source
Nested Schema : Exception Quantities
Type: array
Title: Exception Quantities
The Exception Quantities resource gets the forecast and commit exceptions associated with the collaboration order forecast, such as, forecast changes and commit mismatches.
Show Source
Nested Schema : Forecast Quantities
Type: array
Title: Forecast Quantities
The Forecast Quantities resource gets the current forecast measure details associated with the collaboration order forecast. This resource can also be used to update or create new forecast quantities for collaboration order forecasts.
Show Source
Nested Schema : Reference Quantities
Type: array
Title: Reference Quantities
The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.
Show Source
Nested Schema : collaborationOrderForecasts-commitQuantities-item-response
Type: object
Show Source
Nested Schema : collaborationOrderForecasts-exceptionQuantities-item-response
Type: object
Show Source
Nested Schema : collaborationOrderForecasts-forecastQuantities-item-response
Type: object
Show Source
Nested Schema : collaborationOrderForecasts-referenceQuantities-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all collaboration order forecasts.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationOrderForecasts"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		
		"CollaborationOrderForecastId": 6017,
		"CorrelationCode": "300100150703462",
		"SupplyPlanName": "US_Production",
		"SupplyPlanDescription": "US Production Plan",
		"SupplyPlanVersion": null,
		"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
		"SourceSystem": "Oracle",
		"CollaborationSourceId": 3005,
		"CollaborationPlanId": 300100120934736,
		"CollaborationPlanName": "BAT_SCC_Plan01",
		"PlanningCycleStartDate": "2019-06-24",
		"PlanningCycleEndDate": "2020-06-07",
		"ShipFromSupplierId": 415,
		"ShipFromSupplierName": "CV_SuppA03",
		"ShipFromSupplierNumber": "5017",
		"ShipFromSupplierDUNS": "9876543210234",
		"ShipFromSupplierAlternateName": null,
		"ShipFromSupplierSiteId": 1395,
		"ShipFromSupplierSiteName": "CVSuppA03Site01",
		"ProcurementBUId": 204,
		"ProcurementBUName": "Vision Operations",
		"ShipToOrganizationId": "207",
		"ShipToOrganizationCode": "M1",
		"ShipToOrganizationName": "Manufacturing 1",
		"ShipToSupplierId": 415,
		"ShipToSupplierName": "CV_SuppA03",
		"ShipToSupplierSiteId": null,
		"ShipToSupplierSiteName": null,
		"ShipToCustomerId": null,
		"ShipToCustomerName": null,
		"ShipToCustomerSiteId": null,
		"ShipToCustomerSiteName": null,
		"InventoryItemId": "300100082371759",
		"ItemNumber": "SCC-100GB",
		"ItemDescription": "SCC 100 GB HD",
		"ItemCategory": "Uncategorized",
		"UOMCode": "Ea",
		"UnitOfMeasure": "Each",
		"SupplierItemNumber": null,
		"ForecastTotalForecastHorizonQuantity": 882,
		"ForecastTotalCommitHorizonQuantity": 882,
		"CommitTotalQuantity": null,
		"OnHandQuantity": null,
		"SupplierOnHandQuantity": null,
		"SupplierOnHandPublishedDate": null,
		"SupplierOnHandPublishedByUserName": null,
		"PublishedDate": "2019-08-29T18:45:03+00:00",
		"PublishedByPersonId": 300100073936640,
		"PublishedByUserName": "COLLABPLANNER",
		"OnHandPublishedDate": "2019-08-29T18:45:03+00:00",
		"OnHandPublishedByUserName": "COLLABPLANNER",
		"CommitDate": null,
		"CommitDueDate": null,
		"Status": "Completed",
		"StatusCode": "ORA_VCS_COMPLETED",
		"CollaborationCycleVersion": 3,
		"CreatedByPersonId": 300100073936640,
		"CreatedBy": "COLLABPLANNER",
		"CreationDate": "2019-08-29T18:45:03+00:00",
		"LastUpdatedBy": "COLLABPLANNER",
		"LastUpdateDate": "2019-09-09T14:37:21.374+00:00",
		"B2BOnlyFlag": "false",
		"DropShipFlag": "false",
		"links":[
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		}
		]
	},
	{
		"CollaborationOrderForecastId": 156,
		"CorrelationCode": "300100118798417",
		"SupplyPlanName": "US_Production",
		"SupplyPlanDescription": "US Production Plan",
		"SupplyPlanVersion": null,
		"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
		"SourceSystem": "Oracle",
		"CollaborationSourceId": 1004,
		"CollaborationPlanId": 300100150244741,
		"CollaborationPlanName": "US_Production",
		"PlanningCycleStartDate": "2019-06-24",
		"PlanningCycleEndDate": "2020-06-07",
		"ShipFromSupplierId": 641,
		"ShipFromSupplierName": "CV_SuppA04",
		"ShipFromSupplierNumber": "5043",
		"ShipFromSupplierDUNS": "9785543210778",
		"ShipFromSupplierAlternateName": null,
		"ShipFromSupplierSiteId": 1437,
		"ShipFromSupplierSiteName": "CVSuppA04Site01",
		"ProcurementBUId": 204,
		"ProcurementBUName": "Vision Operations",
		"ShipToOrganizationId": "207",
		"ShipToOrganizationCode": "M1",
		"ShipToOrganizationName": "Manufacturing 1",
		"ShipToSupplierId": 415,
		"ShipToSupplierName": "CV_SuppA03",
		"ShipToSupplierSiteId": null,
		"ShipToSupplierSiteName": null,
		"ShipToCustomerId": null,
		"ShipToCustomerName": null,
		"ShipToCustomerSiteId": null,
		"ShipToCustomerSiteName": null,
		"InventoryItemId": "300100081232726",
		"ItemNumber": "SCC-1TB",
		"ItemDescription": "SCC 1 TB HD",
		"ItemCategory": "Uncategorized",
		"UOMCode": "Ea",
		"UnitOfMeasure": "Each",
		"SupplierItemNumber": null,
		"ForecastTotalForecastHorizonQuantity": 2130,
		"ForecastTotalCommitHorizonQuantity": 2130,
		"CommitTotalQuantity": null,
		"OnHandQuantity": null,
		"SupplierOnHandQuantity": null,
		"SupplierOnHandPublishedDate": null,
		"SupplierOnHandPublishedByUserName": null,
		"PublishedDate": "2019-08-29T18:45:03+00:00",
		"PublishedByPersonId": 300100073936640,
		"PublishedByUserName": "COLLABPLANNER",
		"OnHandPublishedDate": "2019-08-29T18:45:03+00:00",
		"OnHandPublishedByUserName": "COLLABPLANNER",
		"CommitDate": null,
		"CommitDueDate": null,
		"Status": "Completed",
		"StatusCode": "ORA_VCS_COMPLETED",
		"CollaborationCycleVersion": `,
		"CreatedByPersonId": 300100073936640,
		"CreatedBy": "COLLABPLANNER",
		"CreationDate": "2019-08-29T18:45:03+00:00",
		"LastUpdatedBy": "COLLABPLANNER",
		"LastUpdateDate": "2019-09-09T14:37:21.374+00:00",
		"B2BOnlyFlag": "false",
		"DropShipFlag": "false",
		"links": [
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		}
		]
	}
	],
	"count": 2,
	"hasMore": true,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		...
	}
	]
}
Back to Top