Get all demands
get
/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/PlanningDemands
Request
Path Parameters
-
SimulationSetId(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=
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
finder: string
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 planning demands according to the primary key criteria.
Finder Variables- TransactionId; integer; Value that uniquely identifies the demand transaction.
- TransactionIdFinder Find planning demands according to the primary key criteria.
Finder Variables- TransactionId; integer; Value that uniquely identifies the demand transaction.
- PrimaryKey Find planning demands according to the primary key criteria.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- AllowSplits; integer; Value that indicates whether Oracle Global Order Promising Cloud can automatically split a fulfillment line into two or more lines to optimize promising results. Valid values are 1 or 2. If 1, then Global Order Promising can automatically split a fulfillment line. If 2, then Global Order Promising can't automatically split a fulfillment line.
- AllowSubstitution; integer; Value that indicates whether Oracle Global Order Promising Cloud can consider end item substitution to optimize promising results. Valid values are 1 or 2. If 1, then Global Order Promising considers end item substitution. If 2, then Global Order Promising doesn't consider end item substitution.
- ArrivalSetName; string; A named set designating the order lines that should arrive together. On the sales order, the arrival set name designates lines that should arrive together at the customer site.
- AssetNumber; string; Number that identifies the asset associated with a maintenance work order.
- BucketType; string; Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG.
- Buyer; string; Name of the buyer associated with the item.
- CompletedQuantity; number; Shipped quantity of the sales order.
- ComponentQuantityIssued; number; Quantity of a component issued to a work order.
- ConfigurationItem; string; Name of the configuration item.
- CreatedBy; string; User who created the order.
- CreationDate; string; Date when the user created the order.
- Customer; string; Name of the customer associated with the sales order or forecast.
- CustomerPOLineNumber; string; Number that identifies the customer purchase order line corresponding to the sales order.
- CustomerPONumber; string; Customer purchase order number corresponding to the sales order.
- CustomerPOScheduleNumber; string; Number that identifies the schedule level customer purchase order line location that corresponds to the sales order.
- CustomerSite; string; Code associated with a specific customer ship-to location.
- DeliveryCost; number; Value that identifies the delivery cost per unit.
- DeliveryLeadTime; number; Value that identifies the delivery lead time from the promising application.
- DemandClass; string; Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task.
- DemandClassCode; string; Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.
- DemandPriority; integer; Priority of the demand.
- DestinationTimeZone; string; Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
- EarliestAcceptableArrivalDate; string; Date when the customer can accept the order to arrive at the earliest.
- EarliestAcceptableShipDate; string; Date when the customer can accept the order to be shipped at the earliest.
- EndDemandValue; number; Monetary value associated with the end demand.
- ExpenseDestinationTransfer; string; Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
- FirmDate; string; Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
- FirmPlannedType; integer; Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
- FirmQuantity; number; Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.
- FirmStatus; string; Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
- FulfillmentCost; number; Estimated cost to deliver a fulfillment line to a customer. The amount includes item cost and shipping cost.
- FulfillmentLine; integer; Fulfillment line number associated with a sales order.
- GOPReferenceId; string; Value that uniquely identifies the cross reference of the recommended split fulfillment line created by Oracle Global Order Promising Cloud.
- IncludedItemsIndicator; integer; Value that indicates whether the sales order line is communicated to Oracle Global Order Promising Cloud for pick-to-order items. Valid values are 1 or 2. If 1, then pick-to-order items are communicated to Global Order Promising. If 2, then pick-to-order items aren't communicated to Global Order Promising.
- Item; string; Name of the item associated with the demand.
- ItemDescription; string; Description of the item associated with the demand.
- ItemSubTypeCode; string; Abbreviation that identifies the subclassification of the item on the order. A list of accepted values is defined in the lookup type ORA_MSC_OP_CTO_ITEM_SUB_TYPE.
- ItemTypeCode; string; Abbreviation that identifies the type of the item on the order. Valid values are 1, 2 or 3. If 1, then Model Item. If 2, then Option Class. If 3, then Standard Item.
- LastUpdateDate; string; Date when the demand was most recently updated.
- LastUpdatedBy; string; User who most recently updated the demand.
- LatestAcceptableArrivalDate; string; Date when the customer can accept the order to arrive at the latest.
- LatestAcceptableDate; string; Date beyond which the demand line must not be promised.
- LatestAcceptableShipDate; string; Date when the customer can accept the order to be shipped at the latest.
- LineNumber; string; Line number associated with the demand.
- MinimumPercentageForSplit; number; If splits are allowed, this attribute specifies the minimum percentage required for splitting a fulfillment line.
- MinimumQuantityForSplit; number; If splits are allowed, this attribute specifies the minimum quantity required for splitting a fulfillment line.
- MinimumRemainingShelfLife; number; Minimum duration of shelf life remaining when perishable products such as pharmaceuticals or groceries arrive at the customer site, so that there will be enough time for the end consumer to buy and use the products.
- OldDueDate; string; Date when the demand quantity was originally due. This attribute value is extracted from the source application.
- OrderDateType; string; Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
- OrderDateTypeCode; integer; Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
- OrderMargin; number; Value that indicates the difference between the revenue from the fulfillment line and the cost of promising the fulfillment line based on the current promising result.
- OrderNumber; string; Order number associated with the sales order.
- OrderQuantity; number; Quantity associated with the demand.
- OrderType; integer; Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
- OrderTypeText; string; Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
- OrgCurrencyCode; string; Abbreviation that identifies the base currency of the organization.
- Organization; string; Name of the organization associated with the order.
- OrganizationTimeZone; string; Time zone of the organization associated with the demand.
- OriginalItem; string; Name of the item for which the order was originally scheduled.
- OriginalOrderQuantity; number; Quantity associated with the order. This value is extracted from the source application.
- ParentFulfillmentLine; string; For an order with assemble-to-order elements, this attribute indicates the immediate parent of an assemble-to-order component.
- ParentModel; string; Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option.
- PlannedArrivalDate; string; Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar.
- Planner; string; Abbreviation that identifies the planner responsible for the item.
- PlannerDescription; string; Description of the planner responsible for the item.
- ProjectGroupValue; string; Value that identifies the project group.
- ProjectValue; string; Value that identifies the project.
- PromisedArrivalDate; string; Date when a customer has been promised the delivery of the order.
- PromisedShipDate; string; Date when a customer has been promised the shipping of the order.
- PromisingSystem; string; Name of the promising application that promises supply for the demand.
- RequestedArrivalDate; string; Date when the material must arrive at the customer site.
- RequestedShipDate; string; Date when the material must be shipped out to the customer.
- RootFulfillmentLine; string; For an order having assemble-to-order elements, this attribute indicates the top-most model.
- SalesRepresentativeContact; string; Contact details of the sales representative.
- ScheduleName; string; Name of the supply or demand schedule associated with an order.
- ScheduledArrivalDate; string; Date when the demand has been scheduled to arrive at a customer site.
- ScheduledShipDate; string; Date when the demand has been scheduled to be shipped.
- SellingPrice; number; Selling price of an item on the order line.
- ShipMethod; string; Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
- ShipTo; string; Abbreviation that identifies the specific ship-to location.
- ShipmentSetName; string; On the sales order, the ship set name designates lines that should ship together.
- ShippingMethod; string; Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
- ShippingPreference; string; Value that indicates the shipping preference for the order.
- SourceOrder; string; Value that identifies the order number in the source application against which fulfillment line has been created.
- SourceOrderLine; string; Value that identifies the order line number in the source application against which fulfillment line has been created.
- SourceOrganization; string; Name of the organization that will source the order.
- SourceTimeZone; string; Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
- SuggestedDueDate; string; Date when the demand is recommended to be completed.
- SuggestedShipDate; string; Date when the order is recommended to be shipped.
- Supplier; string; Name of the source supplier.
- SupplierSite; string; Abbreviation that indicates the specific supplier ship-from location.
- SupplierSiteSourceSystem; integer; For drop ship sales orders, the source application for which the supplier site is defined.
- TaskValue; string; Value that identifies task.
- TransactionId; integer; Value that uniquely identifies the demand. This value is internally generated by the application.
- UOM; string; Name of the unit of measure that's associated with the order quantity.
- UOMCode; string; Abbreviation that identifies the unit of measure associated with the order quantity.
- UsingAssembly; string; For component demands, this field refers to the assembly item that uses this item as a component.
- Zone; string; Region or zone where the demand quantity is being shipped.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : simulationSets-PlanningDemands
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : simulationSets-PlanningDemands-item-response
Type:
Show Source
object
-
AllowSplits: integer
Read Only:
true
Value that indicates whether Oracle Global Order Promising Cloud can automatically split a fulfillment line into two or more lines to optimize promising results. Valid values are 1 or 2. If 1, then Global Order Promising can automatically split a fulfillment line. If 2, then Global Order Promising can't automatically split a fulfillment line. -
AllowSubstitution: integer
Read Only:
true
Value that indicates whether Oracle Global Order Promising Cloud can consider end item substitution to optimize promising results. Valid values are 1 or 2. If 1, then Global Order Promising considers end item substitution. If 2, then Global Order Promising doesn't consider end item substitution. -
ArrivalSetName: string
Title:
Arrival Set Name
Read Only:true
Maximum Length:30
A named set designating the order lines that should arrive together. On the sales order, the arrival set name designates lines that should arrive together at the customer site. -
AssetNumber: string
Title:
Asset
Read Only:true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BucketType: string
Title:
Bucket Type
Read Only:true
Maximum Length:7
Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG. -
Buyer: string
Title:
Buyer
Read Only:true
Name of the buyer associated with the item. -
CompletedQuantity: number
Read Only:
true
Shipped quantity of the sales order. -
ComponentQuantityIssued: number
Read Only:
true
Quantity of a component issued to a work order. -
ConfigurationItem: string
Title:
Configuration Item
Read Only:true
Maximum Length:300
Name of the configuration item. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the order. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the order. -
Customer: string
Title:
Customer
Read Only:true
Maximum Length:4000
Name of the customer associated with the sales order or forecast. -
CustomerPOLineNumber: string
Read Only:
true
Maximum Length:50
Number that identifies the customer purchase order line corresponding to the sales order. -
CustomerPONumber: string
Read Only:
true
Maximum Length:50
Customer purchase order number corresponding to the sales order. -
CustomerPOScheduleNumber: string
Read Only:
true
Maximum Length:50
Number that identifies the schedule level customer purchase order line location that corresponds to the sales order. -
CustomerSite: string
Title:
Customer Site
Read Only:true
Maximum Length:4000
Code associated with a specific customer ship-to location. -
DeliveryCost: number
Read Only:
true
Value that identifies the delivery cost per unit. -
DeliveryLeadTime: number
Read Only:
true
Value that identifies the delivery lead time from the promising application. -
DemandClass: string
Read Only:
true
Maximum Length:34
Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task. -
DemandClassCode: string
Title:
Demand Class
Read Only:true
Maximum Length:4000
Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS. -
DemandPriority: integer
Title:
Order Priority
Read Only:true
Priority of the demand. -
DestinationTimeZone: string
Title:
Destination Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization. -
EarliestAcceptableArrivalDate: string
(date)
Read Only:
true
Date when the customer can accept the order to arrive at the earliest. -
EarliestAcceptableShipDate: string
(date)
Read Only:
true
Date when the customer can accept the order to be shipped at the earliest. -
EndDemandValue: number
Monetary value associated with the end demand.
-
ExpenseDestinationTransfer: string
Read Only:
true
Maximum Length:50
Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination. -
FirmDate: string
(date)
Title:
Firm Date
Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmPlannedType: integer
(int32)
Title:
Firm Status
Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FirmQuantity: number
Title:
Firm Quantity
Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStatus: string
Read Only:
true
Maximum Length:4000
Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FulfillmentCost: number
Read Only:
true
Estimated cost to deliver a fulfillment line to a customer. The amount includes item cost and shipping cost. -
FulfillmentLine: integer
Title:
Fulfillment Line
Read Only:true
Fulfillment line number associated with a sales order. -
GOPReferenceId: string
Read Only:
true
Maximum Length:300
Value that uniquely identifies the cross reference of the recommended split fulfillment line created by Oracle Global Order Promising Cloud. -
IncludedItemsIndicator: integer
Read Only:
true
Value that indicates whether the sales order line is communicated to Oracle Global Order Promising Cloud for pick-to-order items. Valid values are 1 or 2. If 1, then pick-to-order items are communicated to Global Order Promising. If 2, then pick-to-order items aren't communicated to Global Order Promising. -
Item: string
Maximum Length:
300
Name of the item associated with the demand. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item associated with the demand. -
ItemSubTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the subclassification of the item on the order. A list of accepted values is defined in the lookup type ORA_MSC_OP_CTO_ITEM_SUB_TYPE. -
ItemTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of the item on the order. Valid values are 1, 2 or 3. If 1, then Model Item. If 2, then Option Class. If 3, then Standard Item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the demand was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the demand. -
LatestAcceptableArrivalDate: string
(date)
Read Only:
true
Date when the customer can accept the order to arrive at the latest. -
LatestAcceptableDate: string
(date)
Title:
Latest Acceptable Date
Read Only:true
Date beyond which the demand line must not be promised. -
LatestAcceptableShipDate: string
(date)
Read Only:
true
Date when the customer can accept the order to be shipped at the latest. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:100
Line number associated with the demand. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPercentageForSplit: number
Read Only:
true
If splits are allowed, this attribute specifies the minimum percentage required for splitting a fulfillment line. -
MinimumQuantityForSplit: number
Read Only:
true
If splits are allowed, this attribute specifies the minimum quantity required for splitting a fulfillment line. -
MinimumRemainingShelfLife: number
Read Only:
true
Minimum duration of shelf life remaining when perishable products such as pharmaceuticals or groceries arrive at the customer site, so that there will be enough time for the end consumer to buy and use the products. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Date when the demand quantity was originally due. This attribute value is extracted from the source application. -
OrderDateType: string
Title:
Order Date Type
Read Only:true
Maximum Length:4000
Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE. -
OrderDateTypeCode: integer
Read Only:
true
Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE. -
OrderMargin: number
Read Only:
true
Value that indicates the difference between the revenue from the fulfillment line and the cost of promising the fulfillment line based on the current promising result. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Order number associated with the sales order. -
OrderQuantity: number
Title:
Order Quantity
Read Only:true
Quantity associated with the demand. -
OrderType: integer
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
-
OrderTypeText: string
Title:
Order Type
Maximum Length:4000
Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Maximum Length:
49
Name of the organization associated with the order. -
OrganizationTimeZone: string
Title:
Organization Time Zone
Read Only:true
Maximum Length:100
Time zone of the organization associated with the demand. -
OrgCurrencyCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the base currency of the organization. -
OriginalItem: string
Title:
Original Item
Read Only:true
Maximum Length:4000
Name of the item for which the order was originally scheduled. -
OriginalOrderQuantity: number
Title:
Original Order Quantity
Read Only:true
Quantity associated with the order. This value is extracted from the source application. -
ParentFulfillmentLine: string
Read Only:
true
Maximum Length:400
For an order with assemble-to-order elements, this attribute indicates the immediate parent of an assemble-to-order component. -
ParentModel: string
Title:
Parent Model
Read Only:true
Maximum Length:4000
Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option. -
PlannedArrivalDate: string
(date)
Title:
Planned Arrival Date
Read Only:true
Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar. -
Planner: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Read Only:
true
Maximum Length:4000
Description of the planner responsible for the item. -
PlanningAttributes: array
Planning Attributes
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply. -
ProjectGroupValue: string
Maximum Length:
4000
Value that identifies the project group. -
ProjectValue: string
Maximum Length:
4000
Value that identifies the project. -
PromisedArrivalDate: string
(date)
Title:
Promised Arrival Date
Read Only:true
Date when a customer has been promised the delivery of the order. -
PromisedShipDate: string
(date)
Title:
Promised Ship Date
Read Only:true
Date when a customer has been promised the shipping of the order. -
PromisingSystem: string
Read Only:
true
Maximum Length:50
Name of the promising application that promises supply for the demand. -
RequestedArrivalDate: string
(date)
Title:
Requested Arrival Date
Read Only:true
Date when the material must arrive at the customer site. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Read Only:true
Date when the material must be shipped out to the customer. -
RootFulfillmentLine: string
Read Only:
true
Maximum Length:400
For an order having assemble-to-order elements, this attribute indicates the top-most model. -
SalesRepresentativeContact: string
Read Only:
true
Maximum Length:50
Contact details of the sales representative. -
ScheduledArrivalDate: string
(date)
Title:
Scheduled Arrival Date
Read Only:true
Date when the demand has been scheduled to arrive at a customer site. -
ScheduledShipDate: string
(date)
Title:
Scheduled Ship Date
Read Only:true
Date when the demand has been scheduled to be shipped. -
ScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:4000
Name of the supply or demand schedule associated with an order. -
SellingPrice: number
Read Only:
true
Selling price of an item on the order line. -
ShipmentSetName: string
Title:
Shipment Set Name
Read Only:true
Maximum Length:50
On the sales order, the ship set name designates lines that should ship together. -
ShipMethod: string
Read Only:
true
Maximum Length:30
Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShippingMethod: string
Title:
Shipping Method
Read Only:true
Maximum Length:4000
Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShippingPreference: string
Read Only:
true
Maximum Length:1200
Value that indicates the shipping preference for the order. -
ShipTo: string
Title:
Ship To
Read Only:true
Maximum Length:4000
Abbreviation that identifies the specific ship-to location. -
SourceOrder: string
Title:
Source Order
Read Only:true
Maximum Length:50
Value that identifies the order number in the source application against which fulfillment line has been created. -
SourceOrderLine: string
Title:
Source Order Line
Read Only:true
Maximum Length:50
Value that identifies the order line number in the source application against which fulfillment line has been created. -
SourceOrganization: string
Title:
Source Organization
Read Only:true
Maximum Length:4000
Name of the organization that will source the order. -
SourceTimeZone: string
Title:
Source Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization. -
SuggestedDueDate: string
(date)
Title:
Suggested Dock Date
Read Only:true
Date when the demand is recommended to be completed. -
SuggestedShipDate: string
(date)
Title:
Suggested Ship Date
Read Only:true
Date when the order is recommended to be shipped. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the source supplier. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Abbreviation that indicates the specific supplier ship-from location. -
SupplierSiteSourceSystem: integer
Read Only:
true
For drop ship sales orders, the source application for which the supplier site is defined. -
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
TransactionId: integer
(int64)
Value that uniquely identifies the demand. This value is internally generated by the application.
-
UOM: string
Read Only:
true
Maximum Length:4000
Name of the unit of measure that's associated with the order quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure associated with the order quantity. -
UsingAssembly: string
Title:
Using Assembly
Read Only:true
Maximum Length:4000
For component demands, this field refers to the assembly item that uses this item as a component. -
Zone: string
Title:
Zone
Read Only:true
Maximum Length:4000
Region or zone where the demand quantity is being shipped.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Attributes
Type:
array
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
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.
Nested Schema : simulationSets-PlanningDemands-PlanningAttributes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Title:
Order Number
Maximum Length:4000
Number that identifies the order associated with the demand or supply. -
PlanningAttributeNumber10: string
Maximum Length:
4000
Value for the planning attribute number 10 in attribute-based planning. -
PlanningAttributeNumber11: string
Maximum Length:
4000
Value for the planning attribute number 11 in attribute-based planning. -
PlanningAttributeNumber12: string
Maximum Length:
4000
Value for the planning attribute number 12 in attribute-based planning. -
PlanningAttributeNumber13: string
Maximum Length:
4000
Value for the planning attribute number 13 in attribute-based planning. -
PlanningAttributeNumber14: string
Maximum Length:
4000
Value for the planning attribute number 14 in attribute-based planning. -
PlanningAttributeNumber15: string
Maximum Length:
4000
Value for the planning attribute number 15 in attribute-based planning. -
PlanningAttributeNumber3: string
Maximum Length:
4000
Value for the planning attribute number 3 in attribute-based planning. -
PlanningAttributeNumber4: string
Maximum Length:
4000
Value for the planning attribute number 4 in attribute-based planning. -
PlanningAttributeNumber5: string
Maximum Length:
4000
Value for the planning attribute number 5 in attribute-based planning. -
PlanningAttributeNumber6: string
Maximum Length:
4000
Value for the planning attribute number 6 in attribute-based planning. -
PlanningAttributeNumber7: string
Maximum Length:
4000
Value for the planning attribute number 7 in attribute-based planning. -
PlanningAttributeNumber8: string
Maximum Length:
4000
Value for the planning attribute number 8 in attribute-based planning. -
PlanningAttributeNumber9: string
Maximum Length:
4000
Value for the planning attribute number 9 in attribute-based planning. -
TransactionId: integer
(int64)
Value that uniquely identifies the demand or supply. This value is internally generated by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all demands.
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/simulationSets/SimulationSetId/child/PlanningDemands"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/simulationSets/300100241534619/child/PlanningDemands"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "CreatedBy": "REPL_USER", "CreationDate": "2020-08-13T10:56:10.161+00:00", "FirmDate": "2020-08-20", "FirmQuantity": 10, "LastUpdateDate": "2020-08-13T10:56:16.042+00:00", "LastUpdatedBy": "REPL_USER", "TransactionId": 3894040, "ArrivalSetName": null, "BucketType": null, "Buyer": "Smith, Jonathan", "CustomerSite": "369823", "DemandClass": null, "DemandPriority": null, "ItemDescription": "YM-CRT-480P-14", "ScheduleName": null, "Item": "YM-CRT-480P-14", "Organization": "M1", "OrderTypeText": "Manual demand", "FirmPlannedType": 1, "FirmStatus": "Firm", "SuggestedDueDate": "2020-08-20", "OrderNumber": "3894040", "Planner": "RP_PLNR4", "Customer": "L & M BOTRUC RENTAL INC", "SuggestedShipDate": null, "LatestAcceptableDate": null, "OldDueDate": null, "OrderDateTypeCode": null, "OrderDateType": "Ship date", "OrderType": 1008, "OriginalItem": null, "OriginalOrderQuantity": 10, "PlannedArrivalDate": null, "PromisedArrivalDate": null, "PromisedShipDate": null, "OrderQuantity": -10, "RequestedArrivalDate": null, "RequestedShipDate": null, "ScheduledArrivalDate": null, "ScheduledShipDate": "2020-08-20", "SellingPrice": 50, "ShipMethod": null, "ShippingMethod": null, "ShipmentSetName": null, "ShipTo": null, "SourceOrganization": null, "Supplier": null, "SupplierSite": null, "UOMCode": "Ea", "UOM": "Each", "UsingAssembly": "YM-CRT-480P-14", "Zone": null, "SourceOrderLine": null, "SourceOrder": null, "LineNumber": null, "FulfillmentLine": null, "DemandClassCode": null, "OrgCurrencyCode": "USD", "CustomerPONumber": null, "ExpenseDestinationTransfer": "No", "ParentModel": null, "OrganizationTimeZone": "Coordinated Universal Time", "PlannerDescription": "RP_PLNR4", "SourceTimeZone": null, "DestinationTimeZone": null, "ProjectValue": null, "TaskValue": null, "ProjectGroupValue": null, "ComponentQuantityIssued": null, "ConfigurationItem": null, "AssetNumber": null, "AllowSplits": null, "AllowSubstitution": null, "CompletedQuantity": null, "CustomerPOLineNumber": null, "CustomerPOScheduleNumber": null, "DeliveryCost": null, "DeliveryLeadTime": null, "EarliestAcceptableArrivalDate": null, "EarliestAcceptableShipDate": null, "FulfillmentCost": null, "GOPReferenceId": null, "IncludedItemsIndicator": null, "ItemSubTypeCode": null, "ItemTypeCode": null, "LatestAcceptableArrivalDate": null, "LatestAcceptableShipDate": null, "MinimumPercentageForSplit": null, "MinimumQuantityForSplit": null, "MinimumRemainingShelfLife": null, "OrderMargin": null, "ParentFulfillmentLine": null, "PromisingSystem": null, "RootFulfillmentLine": null, "SalesRepresentativeContact": null, "ShippingPreference": null, "SupplierSiteSourceSystem": null, "EndDemandValue": 500.0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100241534619/child/PlanningDemands/3894040", "name": "PlanningDemands", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100241534619/child/PlanningDemands/3894040", "name": "PlanningDemands", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100241534619", "name": "simulationSets", "kind": "item" } ] }, { "CreatedBy": "REPL_USER", "CreationDate": "2020-08-13T08:16:14.001+00:00", "FirmDate": null, "FirmQuantity": null, "LastUpdateDate": "2020-08-13T08:16:14.003+00:00", "LastUpdatedBy": "REPL_USER", "TransactionId": 1750971, "ArrivalSetName": null, "BucketType": null, "Buyer": "Smith, Jonathan", ... } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100241534619/child/PlanningDemands", "name": "PlanningDemands", "kind": "collection" } ] }