1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Collaboration Order Forecast Requests

Get all forecasts

get

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastRequests

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 requests for collaboration order forecasts according to the primary key.
      Finder Variables
      • CollaborationOrderForecastRequestId; integer; Value that uniquely identifies the request.
    • RowFinder Find requests for collaboration order forecasts according to the row finder.
      Finder Variables
      • CollaborationOrderForecastRequestId; integer; Value that uniquely identifies the request.
  • 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:
    • CollaborationOrderForecastRequestId; integer; Value that uniquely identifies the request for the collaboration order forecast.
    • CreatedBy; string; User who created the collaboration order forecast.
    • CreationDate; string; Date and time when the user created the collaboration order forecast.
    • ItemNumber; string; Number that identifies the item.
    • NoteToPlanner; string; Note provided by the supplier to the collaboration planner.
    • NoteToSupplier; string; Note provided by the collaboration planner to the supplier.
    • ProcessId; integer; Value that uniquely identifies the scheduled process that was used to decompose the request.
    • ProcurementBUName; string; Name of the business unit. The application assigns the supplier to this business unit.
    • ShipFromSupplierName; string; Name of the supplier that ships the item.
    • ShipFromSupplierSiteName; string; Name of the supplier site that ships the item.
    • ShipToCustomerName; string; Name of the customer that receives the item.
    • ShipToCustomerSiteName; string; Name of the customer site that received the item.
    • ShipToCustomerSiteNumber; string; Number that identifies the customer site that received the item.
    • ShipToOrganizationCode; string; Name of the organization 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.
    • StatusCode; string; Abbreviation that identifies the current state of the collaboration order forecast. Values included ERROR, SUBMITTED, PROCESSING, PUBLISHED, and PUBLISHED_B2B_ONLY.
    • 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.
    • 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 : collaborationOrderForecastRequests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationOrderForecastRequests-item-response
Type: object
Show Source
Nested Schema : Details
Type: array
Title: Details
The Details resource manages details about collaboration order forecasts that you request.
Show Source
Nested Schema : Statuses
Type: array
Title: Statuses
The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.
Show Source
Nested Schema : collaborationOrderForecastRequests-details-item-response
Type: object
Show Source
  • Date when the time bucket starts.
  • Maximum Length: 18
    Value that uniquely identifies the request for the collaboration order forecast.
  • Links
  • Maximum Length: 32
    Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. 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 publisher order type.
  • Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
  • Maximum Length: 64
    Reference header number for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
  • Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
  • Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
  • Maximum Length: 64
    Number that identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
  • Maximum Length: 64
    Number that identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
Nested Schema : collaborationOrderForecastRequests-requestStatusDetails-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the request for the collaboration order forecast.
  • Links
  • Read Only: true
    Value that uniquely identifies the request detail for the collaboration order forecast.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the request status for the collaboration order forecast. The application uses this attribute to provide error or status detail regarding the collaboration order forecast when the Supply Planning Collaboration Decomposition scheduled process runs.
  • Read Only: true
    Maximum Length: 30
    Value that identifies the type of status detail. Values include Error or Information.
Back to Top

Examples

This example describes how to get all 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/collaborationOrderForecastRequests"

Example Response Body

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

{
    "items": [
        {
            "CollaborationOrderForecastRequestId": 764619468516950,
            "StatusCode": "PUBLISHED",
            "SupplyPlanName": "US_Production",
            "SupplyPlanDescription": "US Production Plan",
            "ProcurementBUName": null,
            "ShipFromSupplierName": null,
            "ShipFromSupplierSiteName": null,
            "ShipToCustomerSiteNumber": null,
            "ShipToOrganizationCode": null,
            "ShipToCustomerName": null,
            "ShipToCustomerSiteName": null,
            "ShipToCustomerSiteNumber": null,
            "ItemNumber": null,
            "CreatedBy": "COLLABPLANNER",
            "CreationDate": "2018-06-28T07:04:09.622+00:00",
            "links": [
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                }
            ]
        },
        {
            "CollaborationOrderForecastRequestId": 944615168584975,
            "StatusCode": "PUBLISHED",
            "SupplyPlanName": "SOUTH_AMERICA_Production",
            "SupplyPlanDescription": "South America Production Plan",
            "ProcurementBUName": null,
            "ShipFromSupplierName": null,
            "ShipFromSupplierSiteName": null,
            "ShipToOrganizationCode": null,
            "ShipToCustomerName": null,
            "ShipToCustomerSiteName": null,
            "ShipToCustomerSiteNumber": null,
            "ItemNumber": null,
            "CreatedBy": "COLLABPLANNER",
            "CreationDate": "2018-06-28T07:04:09.622+00:00",
            "links": [
                {
                    ...
                }
                },
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                }
            ]
        },
}
Back to Top