Create forecasts

post

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastRequests

Request

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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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 : schema
Type: object
Show Source
  • Date when the time bucket starts.
  • Maximum Length: 18
    Value that uniquely identifies the request for the collaboration order forecast.
  • 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-post-request
Type: object
Show Source
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-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 create forecasts.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/collaborationOrderForecastRequests"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "SupplyPlanName": "US_Production",
    "SupplyPlanDescription":"US Production Plan",
    "ShipFromSupplierName" : "CV_SuppD01",
    "ShipToOrganizationCode": "M1",
    "ShipFromSupplierSiteName": "CV_SuppD01Site1", 
    "ItemNumber": "SCC-CNTRDL-03",
    "details": [
            {
            "Quantity": 99,
            "PublisherOrderTypeCode": "SUPPLY_FORECAST",
            "BucketStartDate": "2019-11-28"
            }
     ]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "CollaborationOrderForecastRequestId": 300100152655935,
    "StatusCode": "SUBMITTED",
    "SupplyPlanName": "US_Production",
    "SupplyPlanDescription": "US Production Plan",
    "ProcurementBUName": null,
    "ShipFromSupplierName": "CV_SuppD01",
    "ShipFromSupplierSiteName": "CV_SuppD01Site1",
    "ShipToOrganizationCode": "M1",
    "ShipToCustomerName": null,
    "ShipToCustomerSiteName": null,
    "ShipToCustomerSiteNumber": null,
    "ItemNumber": "SCC-CNTRDL-03",
    "CreatedBy": "COLLABPLANNER",
    "CreationDate": "2018-07-25T18:03:29+00:00",
    "details": {
        "items": [
            {
                "CollaborationOrderForecastRequestId": "300100152655935",
                "PublisherOrderTypeCode": "SUPPLY_FORECAST",
                "BucketStartDate": "2019-11-28",
                "Quantity": 99,
                "ReferenceHeaderId": null,
                "ReferenceLineId": null,
                "ReferenceLineLocationId": null,
                "ReferenceHeaderNumber": null,
                "ReferenceLineNumber": null,
                "ReferenceLineLocationNumber": null,
                "links": [
                    {
                        ...
                    },
                    {
                        ...
                    },
                    {
                        ...
                    }
                ]
            }
        ],
        "count": 1,
        "hasMore": false,
        "limit": 25,
        "offset": 0,
        "links": [
            {
    ...
   }
        ]
    },
    "links": [
        {
            ...
        },
        {
            ...
        },
        {
            ...
        },
        {
            ...
        }
    ]
}
Back to Top