1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Collaboration Order Forecast History

Get one forecast

get

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastHistory/{CollaborationOrderForecastEntryId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : collaborationOrderForecastHistory-item-response
Type: object
Show Source
Nested Schema : Aggregated Quantities
Type: array
Title: Aggregated Quantities
The Aggregated Quantities resource gets the aggregated forecast quantities and commit quantities associated with the historical planning cycles of collaboration order forecasts in weekly, monthly, or quarterly increments.
Show Source
Nested Schema : Commit Quantities
Type: array
Title: Commit Quantities
The Commit Quantities resource gets the commit measure details associated with the historical planning cycles of collaboration order forecasts.
Show Source
Nested Schema : Forecast Quantities
Type: array
Title: Forecast Quantities
The Forecast Quantities resource gets the forecast measure details associated with the historical planning cycles of 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 : collaborationOrderForecastHistory-aggregatedQuantities-item-response
Type: object
Show Source
Nested Schema : collaborationOrderForecastHistory-commitQuantities-item-response
Type: object
Show Source
  • Title: Lookup Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the bucket aggregation type for the commit quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
  • Read Only: true
    Date when the time bucket ends.
  • Value that uniquely identifies the time bucket.
  • Read Only: true
    Date when the time bucket starts.
  • Value that uniquely identifies the collaboration order forecast details record.
  • Most recent date when the user committed the commit quantity.
  • Maximum Length: 30
    Abbreviation that identifies the type of user who performed the commit action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
  • Value that uniquely identifies the user who committed the commit quantity.
  • Read Only: true
    Maximum Length: 255
    User who committed the commit quantity.
  • Read Only: true
    Maximum Length: 64
    Abbreviation that uniquely identifies the orchestration process instance.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the commit quantity is associated with the most recent published cycle of the collaboration order forecast. If false, then the commit quantity isn't associated with the most recent published cycle of the collaboration order forecast. This attribute doesn't have a default value.
  • Links
  • Quantity of the supplier commit.
  • Version of the commit time bucket for the collaboration order forecast.
Nested Schema : collaborationOrderForecastHistory-forecastQuantities-item-response
Type: object
Show Source
  • Title: Lookup Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the bucket aggregation type for the forecast quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
  • Read Only: true
    Date when the time bucket ends.
  • Value that uniquely identifies the time bucket.
  • Read Only: true
    Date when the time bucket starts.
  • Value that uniquely identifies the collaboration order forecast details record.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the forecast quantity is associated with the most recent published cycle of the collaboration order forecast. If false, then the forecast quantity isn't associated with the most recent published cycle of the collaboration order forecast. This attribute doesn't have a default value.
  • Links
  • Read Only: true
    Value that uniquely identifies the user who most recently published the forecast quantity.
  • Title: User Name
    Read Only: true
    Maximum Length: 100
    User who most recently published the forecast quantity.
  • Publish date of the forecast quantity.
  • Maximum Length: 32
    Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
  • Quantity of the supply forecast.
  • Version of the forecast time bucket for the collaboration order forecast.
Nested Schema : collaborationOrderForecastHistory-referenceQuantities-item-response
Type: object
Show Source
Links
aggregatedQuantities
Parameters:
  • CollaborationOrderForecastEntryId: $request.path.CollaborationOrderForecastEntryId
The Aggregated Quantities resource gets the aggregated forecast quantities and commit quantities associated with the historical planning cycles of collaboration order forecasts in weekly, monthly, or quarterly increments.
commitQuantities
Parameters:
  • CollaborationOrderForecastEntryId: $request.path.CollaborationOrderForecastEntryId
The Commit Quantities resource gets the commit measure details associated with the historical planning cycles of collaboration order forecasts.
forecastQuantities
Parameters:
  • CollaborationOrderForecastEntryId: $request.path.CollaborationOrderForecastEntryId
The Forecast Quantities resource gets the forecast measure details associated with the historical planning cycles of collaboration order forecasts.
referenceQuantities
Parameters:
  • CollaborationOrderForecastEntryId: $request.path.CollaborationOrderForecastEntryId
The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.
Back to Top

Examples

This example describes how to get one forecast.

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/collaborationOrderForecastHistory/CollaborationOrderForecastEntryId"

For example, the following command gets one forecast where the collaboration order forecast entry identifier is 4088:

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

Example Response Body

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

{
    "CollaborationOrderForecastEntryId": 4088,
    "CollaborationOrderForecastId": 162,
    "CorrelationCode": "300100122481862",
    "SupplyPlanName": null,
    "CollaborationSourceId": 3008,
    "CollaborationPlanId": 300100120934769,
    "PlanningCycleStartDate": "2017-08-21",
    "PlanningCycleEndDate": "2017-08-27",
    "ShipFromSupplierId": 230,
    "ShipFromSupplierName": "CV_SuppA00",
    "ShipFromSupplierNumber": "5001",
    "ShipFromSupplierDUNS": "987654321",
    "ShipFromSupplierAlternateName": null,
    "ShipFromSupplierSiteId": 5232,
    "ShipFromSupplierSiteName": "CVSuppA00Site01",
    "ProcurementBUId": 204,
    "ProcurementBUName": "Vision Corporation",
    "ShipToOrganizationId": 207,
    "ShipToOrganizationCode": "M1",
    "ShipToOrganizationName": "Manufacturing 1",
    "ShipToSupplierSiteId": null,
    "ShipToSupplierSiteName": null,
    "ShipToCustomerId": null,
    "ShipToCustomerName": null,
    "ShipToCustomerSiteId": null,
    "ShipToCustomerSiteName": null,
    "InventoryItemId": 300100081232688,
    "ItemNumber": "Bolt 1",
    "ItemDescription": "Bolt 1",
    "UnitOfMeasure": "Each",
    "UOMCode": "Ea",
    "ForecastTotalForecastHorizonQuantity": 0,
    "ForecastTotalCommitHorizonQuantity": 0,
    "CommitTotalQuantity": null,
    "PublishedDate": "2017-08-23T04:07:50+00:00",
    "PublishedByPersonId": 300100036658848,
    "PublishedByUserName": "SCMOPERATIONS",
    "CommitDate": null,
    "CommitDueDate": "2017-08-26T04:07:51+00:00",
    "CollaborationCycleVersion": 2,
    "CreatedByPersonId": 300100036658848,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2017-08-28T00:00:07+00:00",
    "LastUpdatedBy": "anonymous",
    "LastUpdateDate": "2018-05-22T22:29:59+00:00",
    "links": [
        {
           ...
         }
        },
        {
           ...
        },
        {
           ... 
        },
        {
           ...
        },
        {
           ...
        }
    ]
}
Back to Top