1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Simulation Sets

Get one simulation set

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}

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 : simulationSets-item-response
Type: object
Show Source
Nested Schema : Bill of Resources
Type: array
Title: Bill of Resources
The Bill of Resources resource manages the bill of resources within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Items
Type: array
Title: Items
The Items resource manages the items within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Planning Demands
Type: array
Title: Planning Demands
The Planning Demands resource manages the demand orders such as sales orders and forecasts within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Planning Supplies
Type: array
Title: Planning Supplies
The Planning Supplies resource manages the supply orders such as work orders and purchase orders within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Bill of Resources resource manages the bill of resources within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Supplier Capacities
Type: array
Title: Supplier Capacities
The Supplier Capacities resource manages how much of an item can be purchased from a supplier during a specified time period within a simulation set.
Show Source
Nested Schema : Supplier Items
Type: array
Title: Supplier Items
The Supplier Items resource manages which items are purchased from which suppliers within a simulation set.
Show Source
Nested Schema : simulationSets-BillOfResources-item-response
Type: object
Show Source
Nested Schema : Alternate Resources
Type: array
Title: Alternate Resources
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine.
Show Source
Nested Schema : Option Dependent Resource Details
Type: array
Title: Option Dependent Resource Details
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine.
Show Source
Nested Schema : Substitute Components
Type: array
Title: Substitute Components
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine.
Show Source
Nested Schema : simulationSets-BillOfResources-AlternateResources-item-response
Type: object
Show Source
Nested Schema : simulationSets-BillOfResources-OptionDependentDetails-item-response
Type: object
Show Source
Nested Schema : simulationSets-BillOfResources-SubstituteComponents-item-response
Type: object
Show Source
Nested Schema : simulationSets-Items-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 40
    Code assigned to the item for classification purposes. Items are divided into categories called ABC classes, such as A, B, and C, according to a criterion such as revenue generation, turnover, or value.
  • Number of days before which the planning process won't reschedule the sales order. For example, if the due date on the original sales order is June 10, and if the Acceptable Early Days is 3, and if the new due date is less than or equal to June 13 then the planning process won't suggest rescheduling.
  • Value that indicates whether common supplies are used in case the project inventory isn't sufficient during the demand and supply netting process. Valid values are: 1 or 2. If 1, then common supplies are used. If 2, then not.
  • Percent of unit cost that represents the internal cost to stock one unit for one year.
  • Read Only: true
    Maximum Length: 1
    Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
  • Read Only: true
    Value that indicates whether the item is a configured item or not. Valid values are: 1 or 2. If 1, then item is a configured item. If 2, then not.
  • Read Only: true
    Average time, expressed in days, between intervals.
  • Number of days specified by the user to override the average interarrival time, where the average interarrival time is the average time, expressed in days, between intervals.
  • Read Only: true
    Value that indicates whether the item is enabled for back-to-back ordering or not. Valid values are: 1 or 2. If 1, then item is enabled for back-to-back ordering. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the model to use when creating an assemble-to-order configuration.
  • Read Only: true
    Contains one of the following values: 1 or 2. If 1, then work orders can be created. If No, then work orders can't be created.
  • Read Only: true
    Maximum Length: 240
    Name of the buyer associated with the item.
  • Read Only: true
    Contains one of the following values: 1 or 0. If 1, then enable available-to-promise functionality in Oracle Global Order Promising Cloud when planning for this item. If 2, don't enable. This attribute doesn't have a default value.
  • Maximum Length: 1
    Value that indicates whether to include this component item when calculating clear-to-build for an assembly item. Valid values are 1 or 2. If 1, then this component item is included. If 2, then it's not.
  • Read Only: true
    Maximum Length: 64
    User who created the item.
  • Value that indicates whether planning creates planned orders for this item. Valid values are 1 or 2. If 1, then planned orders are created. If 2, then planned orders aren't created.
  • Date after which supplies can be created. This attribute is editable only when the CreateSupply attribute is set to 1.
  • Read Only: true
    Date and time when the user created the item.
  • Value that indicates whether the item is a critical component or not. Valid values are 1 or 2. If 1, then the item is a critical component. If 2, then the item isn't a critical component.
  • Read Only: true
    Number of days required to manufacture the item, including the adjusted, cumulative, and total lead time for the component that requires the longest time to assemble.
  • Read Only: true
    Maximum Length: 30
    Value that indicates the currency associated with the item's price and cost.
  • Number of days of cover for the item. Days of Cover is multiplied by the average demand to calculate the safety stock level.
  • Period of time, specified as a number of days, used to determine the average gross demand when using the Days of Cover method to calculate safety stock.
  • Abbreviation that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Time horizon, expressed in number of days, within which forecast demand is ignored.
  • Maximum Length: 4000
    Value that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Maximum Length: 240
    Description of the item.
  • Read Only: true
    Average discount for the item.
  • Value that indicates whether purchasing lead times are imposed as a hard constraint during constraint-based planning. Valid values are: 1 or 2. If 1, then purchasing lead times are enforced. If 2, then not.
  • Time horizon, expressed in number of days, after which inventory is considered excess.
  • Number of days to use to modify the size and timing of each planned order quantity.
  • Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
  • Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
  • Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates how the forecast is exploded and consumed. This attribute isn't currently used.
  • Maximum Length: 30
    Value that indicates how the quality of a forecast is measured. A list of accepted values is defined in the lookup type MSC_FORECAST_ERROR_TYPES.
  • Maximum Length: 4000
    Meaning associated with the ForecastErrorType Code attribute.
  • Maximum Length: 25
    Value that identifies the type of pegging considered by the planning engine during the supply and demand netting process. A list of accepted values is defined in the lookup type ORA_MSC_HARD_PEGGING_LEVEL.
  • Maximum Length: 4000
    Meaning associated with the HardPeggingLevel attribute.
  • Read Only: true
    Value that indicates whether the demand for the item has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not.
  • Value specified by the user to override the Intermittent Demand, where Intermittent Demand indicates whether the demand has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not.
  • Value that uniquely identifies the item.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure associated with an item's cost.
  • Maximum Length: 300
    Name of the item.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of bill of material. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE.
  • Read Only: true
    Date and time when the user most recently updated the item.
  • Read Only: true
    Maximum Length: 64
    User most recently updated the item.
  • Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
  • Number of months or periods in which the constrained supply plan offsets the lead time, after converting the number of months or periods to days. Month buckets are used if the supply planning calendar is Gregorian. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
  • Number of weeks in which the constrained supply plan offsets the lead time, after converting the number of weeks to days. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
  • Maximum Length: 120
    Name of lifecycle phase of the item.
  • Links
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the LotControlCode attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE.
  • Read Only: true
    Value that identifies whether the item is lot controlled. Valid values are 1 and 2. If 1, then lot control isn't established for the item. If 2, then lot control is used to track inventory balances by the lot number. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE.
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the LotsExpiration attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL.
  • Read Only: true
    Value that identifies how lot expiration dates are calculated. Valid values are 1 and 2. If 1, then lots don't expire. If 2, then lot expiration is based on the number of shelf life days for the item. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL.
  • Read Only: true
    Value of the mean absolute deviation for the item.
  • Value that's the user override of the mean absolute deviation, where mean absolute deviation is a statistical formula used to measure the quantity deviation between actual and forecasted demand.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the item is manufactured or purchased. Valid values are Make or Buy. If Make, then the item is manufactured. If Buy, then the item is purchased. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Read Only: true
    Value of the mean absolute percentage error for the item.
  • Value that's the user override of the mean absolute percentage error, where mean absolute percentage error is a statistical formula used to measure the percentage deviation between actual and forecasted demand.
  • Maximum order quantity of the item.
  • Minimum order quantity of the item.
  • Read Only: true
    Selling price of an item after applying an average discount to the item's list price.
  • The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value.
  • Date when the item is obsolete.
  • Fixed costs that are associated with placing a sales order for the item.
  • Value that indicates whether order modifiers are applied to start quantity or not. Valid values are: 1 or 2. If 1, then order modifiers are applied to start quantity. If 2, then not.
  • Maximum Length: 49
    Abbreviation that identifies the organization associated with the item.
  • Value that uniquely identifies the organization.
  • Read Only: true
    Value that indicates whether the item can be picked from finished goods inventory. Valid values are: 1 or 2. If 1, then the item can be picked from finished goods inventory. If 2, then not.
  • Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Read Only: true
    Maximum Length: 4000
    Description of the planner responsible for the item.
  • Maximum Length: 4000
    Value that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE.
  • Abbreviation that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE.
  • Abbreviation that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Time horizon, in number of days, in which supply orders aren't scheduled to be due.
  • Maximum Length: 4000
    Value that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Number of days required to make an item available in inventory once the supply is complete.
  • Number of days which must be added to purchasing or manufacturing lead time to place an order.
  • Number of days required to procure or manufacture an item.
  • Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Time horizon, in number of days, in which orders are automatically released as work orders or purchase requisitions.
  • Maximum Length: 4000
    Value that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Read Only: true
    Value that indicates whether planned order quantity is rounded to a whole number or not. Valid values are: 1 or 2. If 1, then planned order quantity is rounded. If 2, then not.
  • Value that identifies the method that planning uses to calculate safety stock levels for the item. A list of accepted values is defined in the lookup type ORA_MSC_SS_PLANNING_METHD.
  • Maximum Length: 4000
    Meaning associated with the SafetyStockCode attribute.
  • Read Only: true
    Desired level of safety stock of an item.
  • Numeric value provided by the user to override the standard safety stock quantity of an item.
  • Selling price of the item.
  • Desired level of customer service, expressed as a percentage, in satisfying product demand. This represents the probability that an order can be filled from available inventory.
  • Average amount of material you expect to lose when manufacturing or storing the item.
  • Standard cost of an item.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
  • Read Only: true
    Volume of one item.
  • Read Only: true
    Weight of one item.
  • Read Only: true
    Maximum Length: 4000
    Planning unit of measure of the item.
  • Time to produce one unit of an assembly.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure to use for the item volume.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure to use for the item weight.
Nested Schema : simulationSets-PlanningDemands-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Asset
    Read Only: true
    Maximum Length: 80
    Number that identifies the asset associated with a maintenance work order.
  • 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.
  • Title: Buyer
    Read Only: true
    Name of the buyer associated with the item.
  • Read Only: true
    Shipped quantity of the sales order.
  • Read Only: true
    Quantity of a component issued to a work order.
  • Title: Configuration Item
    Read Only: true
    Maximum Length: 300
    Name of the configuration item.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Customer
    Read Only: true
    Maximum Length: 4000
    Name of the customer associated with the sales order or forecast.
  • Read Only: true
    Maximum Length: 50
    Number that identifies the customer purchase order line corresponding to the sales order.
  • Read Only: true
    Maximum Length: 50
    Customer purchase order number corresponding to the sales order.
  • Read Only: true
    Maximum Length: 50
    Number that identifies the schedule level customer purchase order line location that corresponds to the sales order.
  • Title: Customer Site
    Read Only: true
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Read Only: true
    Value that identifies the delivery cost per unit.
  • Read Only: true
    Value that identifies the delivery lead time from the promising application.
  • 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.
  • 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.
  • Title: Order Priority
    Read Only: true
    Priority of the demand.
  • 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.
  • Read Only: true
    Date when the customer can accept the order to arrive at the earliest.
  • Read Only: true
    Date when the customer can accept the order to be shipped at the earliest.
  • Monetary value associated with the end demand.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Estimated cost to deliver a fulfillment line to a customer. The amount includes item cost and shipping cost.
  • Title: Fulfillment Line
    Read Only: true
    Fulfillment line number associated with a sales order.
  • 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.
  • 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.
  • Maximum Length: 300
    Name of the item associated with the demand.
  • Read Only: true
    Maximum Length: 240
    Description of the item associated with the demand.
  • 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.
  • 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.
  • Read Only: true
    Date when the demand was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand.
  • Read Only: true
    Date when the customer can accept the order to arrive at the latest.
  • Title: Latest Acceptable Date
    Read Only: true
    Date beyond which the demand line must not be promised.
  • Read Only: true
    Date when the customer can accept the order to be shipped at the latest.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Line number associated with the demand.
  • Links
  • Read Only: true
    If splits are allowed, this attribute specifies the minimum percentage required for splitting a fulfillment line.
  • Read Only: true
    If splits are allowed, this attribute specifies the minimum quantity required for splitting a fulfillment line.
  • 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.
  • Title: Old Due Date
    Read Only: true
    Date when the demand quantity was originally due. This attribute value is extracted from the source application.
  • 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.
  • 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.
  • 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.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Order number associated with the sales order.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the demand.
  • Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • 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.
  • Maximum Length: 49
    Name of the organization associated with the order.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone of the organization associated with the demand.
  • Read Only: true
    Maximum Length: 100
    Abbreviation that identifies the base currency of the organization.
  • Title: Original Item
    Read Only: true
    Maximum Length: 4000
    Name of the item for which the order was originally scheduled.
  • Title: Original Order Quantity
    Read Only: true
    Quantity associated with the order. This value is extracted from the source application.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Read Only: true
    Maximum Length: 4000
    Description of the planner responsible for the item.
  • Planning Attributes
    Title: Planning Attributes
    The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
  • Maximum Length: 4000
    Value that identifies the project group.
  • Maximum Length: 4000
    Value that identifies the project.
  • Title: Promised Arrival Date
    Read Only: true
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Read Only: true
    Date when a customer has been promised the shipping of the order.
  • Read Only: true
    Maximum Length: 50
    Name of the promising application that promises supply for the demand.
  • Title: Requested Arrival Date
    Read Only: true
    Date when the material must arrive at the customer site.
  • Title: Requested Ship Date
    Read Only: true
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 400
    For an order having assemble-to-order elements, this attribute indicates the top-most model.
  • Read Only: true
    Maximum Length: 50
    Contact details of the sales representative.
  • Title: Scheduled Arrival Date
    Read Only: true
    Date when the demand has been scheduled to arrive at a customer site.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when the demand has been scheduled to be shipped.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the supply or demand schedule associated with an order.
  • Read Only: true
    Selling price of an item on the order line.
  • Title: Shipment Set Name
    Read Only: true
    Maximum Length: 50
    On the sales order, the ship set name designates lines that should ship together.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 1200
    Value that indicates the shipping preference for the order.
  • Title: Ship To
    Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the specific ship-to location.
  • 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.
  • 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.
  • Title: Source Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization that will source the order.
  • 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.
  • Title: Suggested Dock Date
    Read Only: true
    Date when the demand is recommended to be completed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the source supplier.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier ship-from location.
  • Read Only: true
    For drop ship sales orders, the source application for which the supplier site is defined.
  • Maximum Length: 4000
    Value that identifies task.
  • Value that uniquely identifies the demand. This value is internally generated by the application.
  • Read Only: true
    Maximum Length: 4000
    Name of the unit of measure that's associated with the order quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • 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.
  • Title: Zone
    Read Only: true
    Maximum Length: 4000
    Region or zone where the demand quantity is being shipped.
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 : simulationSets-PlanningDemands-PlanningAttributes-item-response
Type: object
Show Source
Nested Schema : simulationSets-PlanningSupplies-item-response
Type: object
Show Source
  • Title: Actual Start Date
    Read Only: true
    Date when the work was started, which applies to work orders in process.
  • Read Only: true
    Maximum Length: 80
    Name of the alternate bill of material.
  • Read Only: true
    Maximum Length: 30
    Name of a routing used for the make order.
  • Title: Asset
    Read Only: true
    Maximum Length: 80
    Number that identifies the asset associated with a maintenance work order.
  • Title: Batch Quantity
    Read Only: true
    Quantity that moves through operations in a process work order.
  • Title: Batch Quantity UOM
    Read Only: true
    Maximum Length: 30
    Unit of measure for the batch quantity in a process work order.
  • Read Only: true
    Name of the buyer associated to the item.
  • Read Only: true
    Maximum Length: 400
    Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
  • Read Only: true
    Value that indicates whether the supply has been canceled.
  • Title: Completed Quantity
    Read Only: true
    Quantity of the work order that's already completed.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Customer
    Read Only: true
    Maximum Length: 4000
    Name of the customer associated with the drop ship purchase order.
  • Title: Customer Site
    Read Only: true
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Read Only: true
    Supply unit price for purchased supply.
  • 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.
  • Read Only: true
    Maximum Length: 400
    Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.
  • Read Only: true
    Maximum Length: 4000
    Number that uniquely identifies the customer whose demand is being met through the drop ship supply.
  • Read Only: true
    Maximum Length: 4000
    Customer site to which the drop ship supply must be shipped to meet the demand.
  • Title: Expected Scrap Quantity
    Read Only: true
    Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped.
  • Read Only: true
    Maximum Length: 400
    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.
  • Title: Expiration Date
    Read Only: true
    Date when the existing lot associated with the supply expires.
  • Title: Firm Date
    Date when supply 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.
  • Title: Firm Status
    Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Quantity
    Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Title: Firm Start Quantity
    User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Maximum Length: 40
    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.
  • Title: Hold Date
    Date on which the on-hand inventory lot is no longer on hold.
  • Read Only: true
    Maximum Length: 300
    Name of the item associated with the supply.
  • Read Only: true
    Maximum Length: 240
    Description of the item that's associated with the supply.
  • Read Only: true
    Maximum Length: 400
    Name of the item structure planned to be used for the make order.
  • Read Only: true
    Date when the order was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the supply.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Number that identifies the order line.
  • Links
  • Title: Lot
    Read Only: true
    Maximum Length: 80
    Number that identifies the lot of the on-hand supply.
  • Read Only: true
    Maximum Length: 400
    Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Title: Maturity Date
    Date when an inventory lot fully matures. It can then be used to fulfill demand.
  • Title: Need-by Date
    Read Only: true
    Date when the supply quantity is needed.
  • Title: Old Dock Date
    Read Only: true
    Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.
  • Title: Old Due Date
    Read Only: true
    Date when the order was originally due. This attribute value is extracted from the source application.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Number that identifies the order associated with the supply.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the supply.
  • Read Only: true
    Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Order Type
    Read Only: true
    Maximum Length: 4000
    Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Read Only: true
    Maximum Length: 49
    Name of the organization associated with the order.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with an organization.
  • Title: Original Need-by Date
    Read Only: true
    Date when the order was originally needed. This value is extracted from the source application.
  • Title: Original Order Quantity
    Read Only: true
    Original quantity associated with the order. This value is extracted from the source application.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Read Only: true
    Maximum Length: 400
    Description of the planner responsible for the item.
  • Planning Attributes
    Title: Planning Attributes
    The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
  • Read Only: true
    Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Title: Process Name
    Read Only: true
    Maximum Length: 120
    Name of the manufacturing process used for this work order or planned order.
  • Maximum Length: 400
    Value that identifies the project group.
  • Maximum Length: 400
    Value that identifies the project.
  • Title: Promised Arrival Date
    Read Only: true
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Read Only: true
    Date when a customer has been promised the shipping of the order.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the receipt of the transfer order.
  • Read Only: true
    Work order quantity that remains to be completed.
  • Title: Requested Arrival Date
    Read Only: true
    Date when the material must arrive at the customer site.
  • Title: Requested Ship Date
    Read Only: true
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the revision of the inventory item.
  • Read Only: true
    Maximum Length: 120
    Number that identifies the purchase order line location information for collection at the schedule level.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the schedule associated to the supply.
  • Read Only: true
    Value that identifies the priority of the work order.
  • Title: Scrapped Quantity
    Read Only: true
    Work order quantity that has been scrapped.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the shipment header of the transfer order.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the shipment line of the transfer order.
  • Read Only: true
    Maximum Length: 30
    Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • 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.
  • Read Only: true
    Maximum Length: 400
    Name of the organization that will source the order.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the subinventory associated with the source of the supply.
  • 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.
  • Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.
  • Title: Start Quantity
    Read Only: true
    Quantity at the beginning of a manufacturing process.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 10
    Subinventory code associated with the supply.
  • Title: Suggested Completion Date
    Read Only: true
    Date when the process work order or a planned order completed. This attribute is required because the primary product can be produced in an operation that's prior to the last operation of the order.
  • Title: Suggested Dock Date
    Read Only: true
    Date when the order is recommended to arrive at the receiving dock.
  • Title: Suggested Dock Date
    Read Only: true
    Date when a supply is expected to be completed.
  • Title: Suggested Order Date
    Read Only: true
    Date when an order is recommended to be placed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Suggested Start Date
    Read Only: true
    Date when work on the order is recommended to begin.
  • Title: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the source supplier.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier location from where the item is being sourced.
  • Maximum Length: 400
    Value that identifies task.
  • Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • Title: Unit Number
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.
  • Read Only: true
    Maximum Length: 40
    Name of the unit of measure associated with the order quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Read Only: true
    Abbreviation that identifies the status of the work order. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS.
  • Read Only: true
    Type of supply transaction created when issuing items from inventory to work orders. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
  • Read Only: true
    Maximum Length: 400
    Name that uniquely identifies a work definition used for a make order.
  • Title: Work Order Status
    Read Only: true
    Maximum Length: 4000
    Value that indicates the status of the work order. Valid values include Unreleased, Released, Complete, or On hold. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS.
  • Read Only: true
    Work order subtype associated with the make order. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE .
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 : simulationSets-PlanningSupplies-PlanningAttributes-item-response
Type: object
Show Source
Nested Schema : simulationSets-Resources-item-response
Type: object
Show Source
Nested Schema : Resource Capacities
Type: array
Title: Resource Capacities
The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.
Show Source
Nested Schema : simulationSets-Resources-ResourceCapacities-item-response
Type: object
Show Source
Nested Schema : simulationSets-SupplierCapacities-item-response
Type: object
Show Source
Nested Schema : simulationSets-SupplierItems-item-response
Type: object
Show Source
Links
BillOfResources
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Bill of Resources resource manages the bill of resources within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Items
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Items resource manages the items within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
PlanningDemands
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Planning Demands resource manages the demand orders such as sales orders and forecasts within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
PlanningSupplies
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Planning Supplies resource manages the supply orders such as work orders and purchase orders within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Resources
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Resources resource manages the resources within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
SupplierCapacities
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Supplier Capacities resource manages how much of an item can be purchased from a supplier during a specified time period within a simulation set.
SupplierItems
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
The Supplier Items resource manages which items are purchased from which suppliers within a simulation set.
Back to Top

Examples

This example describes how to get one simulation set.

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"

For example, the following command gets one simulation set:

curl -u username:password "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575"

Example Response Body

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

{
	"CreatedBy": "APS_ALL",
	"CreationDate": "2020-07-27T18:48:39.001+00:00",
	"LastUpdateDate": "2020-07-27T18:48:39.091+00:00",
	"LastUpdatedBy": "APS_ALL",
	"SimulationSetId": 300100217615575,
	"SimulationSetName": "Set1",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575",
		"name": "simulationSets",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575",
		"name": "simulationSets",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/BillOfResources",
		"name": "BillOfResources",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/Items",
		"name": "Items",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/PlanningDemands",
		"name": "PlanningDemands",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/PlanningSupplies",
		"name": "PlanningSupplies",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/Resources",
		"name": "Resources",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/SupplierCapacities",
		"name": "SupplierCapacities",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100217615575/child/SupplierItems",
		"name": "SupplierItems",
		"kind": "collection"
	}
	]
}
Back to Top