Create forecast quantities
post
/fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}/child/forecastQuantities
Request
Path Parameters
-
CollaborationOrderForecastId(required): integer(int64)
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=
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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
- application/json
Root Schema : schema
Type:
Show Source
object
-
BucketAggregationCode: string
Maximum Length:
32
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. -
BucketEndDate: string
(date)
Date when the time bucket ends.
-
BucketStartDate: string
(date)
Date when the time bucket starts.
-
CollaborationOrderForecastDetailsId: integer
(int64)
Value that uniquely identifies the collaboration order forecast details record.
-
CollaborationOrderForecastId: integer
(int64)
Value that uniquely identifies the collaboration order forecast.
-
CorrelationCode: string
Maximum Length:
64
Abbreviation that uniquely identifies the orchestration process instance. -
PublishedByUserName: string
Maximum Length:
64
User who most recently published the forecast quantity. -
PublishedDate: string
(date-time)
Date when the forecast quantity was published.
-
PublishSourceCode: string
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: number
Quantity of the supply forecast.
-
Version: integer
(int32)
Version of the forecast time bucket for the collaboration order forecast.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : collaborationOrderForecasts-forecastQuantities-item-response
Type:
Show Source
object
-
BucketAggregationCode: string
Maximum Length:
32
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. -
BucketEndDate: string
(date)
Date when the time bucket ends.
-
BucketId: integer
(int64)
Read Only:
true
Value that uniquely identifies the time bucket. -
BucketStartDate: string
(date)
Date when the time bucket starts.
-
CollaborationOrderForecastDetailsId: integer
(int64)
Value that uniquely identifies the collaboration order forecast details record.
-
CollaborationOrderForecastId: integer
(int64)
Value that uniquely identifies the collaboration order forecast.
-
CorrelationCode: string
Maximum Length:
64
Abbreviation that uniquely identifies the orchestration process instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PublishedByPersonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who most recently published the forecast quantity. -
PublishedByUserName: string
Maximum Length:
64
User who most recently published the forecast quantity. -
PublishedDate: string
(date-time)
Date when the forecast quantity was published.
-
PublishSourceCode: string
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: number
Quantity of the supply forecast.
-
Version: integer
(int32)
Version of the forecast time bucket for the collaboration order forecast.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create forecast quantities.
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/collaborationOrderForecasts/CollaborationOrderForecastId/child/forecastQuantities"
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.
{ "CollaborationOrderForecastId":93, "BucketStartDate":"2019-01-04", "BucketEndDate":"2019-01-04", "Quantity":111 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "CollaborationOrderForecastId": 93, "CorrelationCode": null, "CollaborationOrderForecastDetailsId": 300100159862865, "BucketId": null, "BucketStartDate": null, "BucketEndDate": null, "BucketAggregationCode": null, "Quantity": 111, "Version": null, "PublishedByPersonId": null, "PublishedByUserName": null, "PublishedDate": null, "PublishSourceCode": null, "links": [ { ... }, { ... }, { ... } ] }