Get all backlog simulation plan runs

get

/fscmRestApi/resources/11.13.18.05/bmSimulationPlans

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the backlog simulation plan run according to the plan run identifier.
      Finder Variables
      • BmRunId; integer; Value that uniquely identifies the backlog simulation plan run.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AllocationScenarioId; integer; Unique identifier of an allocation scenario used in a simulation run.
    • BmRunId; integer; Value that uniquely identifies the backlog management simulation plan run.
    • BmRunType; number; Run the backlog simulation plan for selected demands with our without refresh with collected data.
    • CreatedBy; string; Name of the user who initially created the backlog management simulation plan run.
    • CreationDate; string; Date when the user initially created the backlog management simulation plan run.
    • DemandPriorityRuleId; integer; Unique identifier of a demand priority rule used in a simulation plan run.
    • DemandPriorityRuleName; string; Name of a demand priority rule used in a simulation plan run.
    • ExecutionId; integer; Value that uniquely identifies the process of the backlog management simulation plan run.
    • LastUpdateDate; string; Date when the user most recently updated the backlog management simulation plan run.
    • LastUpdatedBy; string; User who most recently updated the backlog management simulation plan run.
    • PlanStartDate; string; Date that signifies the start of the backlog plan's planning horizon. It's typically defaulted to the system date.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : bmSimulationPlans
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : bmSimulationPlans-item-response
Type: object
Show Source
Nested Schema : Allocations
Type: array
Title: Allocations
The Allocations resource gets supply allocation details from the backlog management plan.
Show Source
Nested Schema : Plan Demands
Type: array
Title: Plan Demands
Backlog demands and plan output in the latest backlog management simulation plan run in the context of a specific session.
Show Source
Nested Schema : bmSimulationPlans-AllocationMeasures-item-response
Type: object
Show Source
Nested Schema : bmSimulationPlans-PlanDemands-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the demand can be split for fulfillment.
  • Read Only: true
    Code that indicates whether splits are allowed for the demand. The valid values are 1 and 2 where 1 indicates that a split is allowed and 2 indicates that a split isn't allowed for the demand. This attribute doesn't have a default value.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 1 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 10 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 11 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 12 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 13 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 14 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 15 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 16 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 17 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 18 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 19 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 2 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 20 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 3 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 4 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 5 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 6 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 7 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 8 of type character for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 150
    Value for the descriptive flexfield attribute number 9 of type character for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 1 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 10 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 11 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 12 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 13 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 14 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 15 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 16 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 17 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 18 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 19 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 2 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 20 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 3 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 4 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 5 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 6 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 7 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 8 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 9 of type date for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 1 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 10 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 2 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 3 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 4 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 5 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 6 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 7 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 8 of type number for the demand in a backlog management plan.
  • Read Only: true
    Value for the descriptive flexfield attribute number 9 of type number for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 300
    Name of item used to promise the fulfillment line.
  • Read Only: true
    Quantity that was available to promise the fulfillment line.
  • Read Only: true
    Value that uniquely identifies the baseline demand from which a split demand can be created. If there isn't a split, this value is the same as the demand ID.
  • Read Only: true
    Value that uniquely identifies the backlog management plan run.
  • Read Only: true
    Name of the catalog being collected.
  • Read Only: true
    Unique identifier of the category associated with an item requested on the demand.
  • Read Only: true
    Sales order quantity that has already been completed.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble-to-order demands.
  • Read Only: true
    Maximum Length: 1200
    Unique identifier of the configuration item.
  • Read Only: true
    Value that identifies the item constraint ranking based on the difference between their respective item availability dates and requested dates.
  • Read Only: true
    Date when the user created the demand.
  • Read Only: true
    Value that uniquely identifies the customer on the demand.
  • Read Only: true
    Maximum Length: 4000
    Name of the customer on the demand.
  • Read Only: true
    Maximum Length: 4000
    Name of the customer site on the demand.
  • Read Only: true
    Value that uniquely identifies the customer site of the demand.
  • Read Only: true
    Number of days that the demand is late.
  • Read Only: true
    Difference between the planned and scheduled shipment or arrival dates for a demand line, measured in days.
  • Read Only: true
    Value that identifies the number of days by which the planned date will improve if all items with a constraint rank higher than or equal to this item's constraint rank are removed.
  • Read Only: true
    Maximum Length: 34
    Name of the demand class on the demand.
  • 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 the lookup type is DEMAND_CLASS.
  • Read Only: true
    Value that indicates the delivery lead time entered on the fulfillment line.
  • Read Only: true
    Value that uniquely identifies a demand in a backlog management plan run.
  • Read Only: true
    Date that corresponds to the lead time available to fulfill the demand.
  • Read Only: true
    Priority of a demand in the backlog management plan run.
  • Read Only: true
    Maximum Length: 360
    Name of the source system in which the demand originated.
  • Read Only: true
    Unique identifier of the source system in which the demand originated.
  • Read Only: true
    Type of source system from which data is collected.
  • Read Only: true
    Maximum Length: 4000
    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: 4000
    Indicates where a supply is destined. For example, whether a supply will be shipped directly to a customer or received into inventory. A list of accepted values is defined in the lookup type ORA_INV_TO_DESTINATION_TYPE.
  • Read Only: true
    Indicates whether values are populated for either of the three planning attributes of the display attribute type for an order line. The valid values are 1 and 2. The value 1 indicates that display attributes are populated for the order line and 2 indicates that the display attributes aren't populated.
  • Read Only: true
    Earliest date that's acceptable on the fulfillment line.
  • Read Only: true
    Earliest arrival date that's acceptable on the fulfillment line.
  • Read Only: true
    Earliest ship date that's acceptable on the fulfillment line.
  • Read Only: true
    Earliest date when the item can be available.
  • Read Only: true
    Maximum Length: 4000
    Numeric value that indicates whether supply must be allocated to meet the existing scheduled dates on a demand line. Valid values are 1 and 2. If the value is 2, then the user can disregard the existing scheduled dates. If the values is 1, it indicates that supply must be allocated to meet the existing scheduled dates.
  • Read Only: true
    Contains one of the following values: Yes or No. If Yes, then the existing scheduled information on the demand must be respected when planning the demand. If No, then the existing commitments can be ignored. The default value is Yes.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the reason why the demand wasn't planned.
  • Read Only: true
    Date when the requested item line is expected to arrive at the customer ship-to site from the ship-from organization.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Read Only: true
    Value that uniquely identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Read Only: true
    Date when the requested item line is expected to be shipped from the ship-from organization for a ship type order or arrive at the customer ship-to site from the ship-from organization for an arrival type order.
  • Read Only: true
    Maximum Length: 4000
    Name of the planned drop-ship supplier from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Name of the planned drop-ship supplier site from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the planned transport mode from the source inventory organization to the destination inventory organization that was entered on the fulfillment line.
  • Read Only: true
    Value that uniquely identifies the planned transport mode from the source inventory organization to the destination inventory organization that was entered on the fulfillment line.
  • Read Only: true
    Unique identifier of the planned ship-from organization from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Read Only: true
    Value that uniquely identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Read Only: true
    Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Code of the planned ship-from organization from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Name of the planned ship-from organization from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the planned shipping method from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Read Only: true
    Maximum Length: 30
    Value that uniquely identifies the planned shipping method from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Read Only: true
    Value that identifies the drop-ship supplier from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Value that identifies the drop-ship supplier site from where material is to be shipped to the customer ship-to site.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether a demand has been locked.
  • Read Only: true
    Numeric value that indicates whether the supply for a demand can be changed. Valid values are 1 and 2, where 1 indicates that the supply for a demand can be changed and 2 indicates that it can't be changed. This attribute doesn't have a default value.
  • Read Only: true
    Number that indicates the expected shipping cost associated with the fulfillment line or availability option.
  • Read Only: true
    Maximum Length: 400
    Value that identifies the fulfillment line.
  • Read Only: true
    Number that uniquely identifies the fulfillment line.
  • Read Only: true
    Maximum Length: 80
    Mode of the demand fulfillment. Valid values are drop shipment, back to back, and shipment from internal warehouse. A list of accepted values is defined in the lookup type ORA_MSC_OP_FULFILLMENT_MODE.
  • Read Only: true
    Maximum Length: 100
    Value that identifies planning attribute number 101 of the display attribute type associated with the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 100
    Value that identifies planning attribute number 102 of the display attribute type associated with the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 100
    Value that identifies planning attribute number 103 of the display attribute type associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 3 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 4 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 5 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 6 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 7 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 8 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 9 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 10 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 11 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 12 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 13 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 14 associated with the demand in a backlog management plan.
  • Read Only: true
    Value that identifies planning attribute number 15 associated with the demand in a backlog management plan.
  • Read Only: true
    Indicates whether a demand is for simulation. Demands for simulations aren't true sales orders but order simulations created by the backlog planner to review how the actual sales order might be planned after it's created.
  • Read Only: true
    Maximum Length: 4
    Value that indicates the type of internal order. Valid values include TO, Transfer Order, ISO, Internal Sales Order, TOE, Transfer Order Expense, and ISOE, Internal Sales Order Expense. This attribute doesn't have a default value.
  • Read Only: true
    Value that uniquely identifies the item that's requested on the demand.
  • Read Only: true
    Maximum Length: 300
    Name of the item that's requested on the demand.
  • Read Only: true
    Maximum Length: 240
    Description of the item that's requested on the demand.
  • Read Only: true
    Maximum Length: 4000
    Name of the item subtype. The values include assemble-to-order model and pick-to-order option item, depending on the item and product structure attributes.
  • Read Only: true
    Unique identifier of the item subtype. A list of accepted values is defined in the lookup type ORA_MSC_OP_CTO_ITEM_SUB_TYPE.
  • Read Only: true
    Name of the item type. The values include model, option class, and standard item, depending on the item attributes.
  • Read Only: true
    Maximum Length: 80
    Code that uniquely identifies the item type of the item in the demand.
  • Read Only: true
    Date and time when the user most recently updated the demand record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand record.
  • Read Only: true
    Last arrival date that's acceptable on the fulfillment line.
  • Read Only: true
    Last date that's acceptable on the fulfillment line.
  • Read Only: true
    Last ship date that's acceptable on the fulfillment line.
  • Links
  • Read Only: true
    Maximum Length: 4000
    Identifies if the demand was manually overridden or not for the backlog management simulation plan run.
  • Read Only: true
    Value that indicates whether the planned information on the demand has been manually overridden.
  • Read Only: true
    Maximum Length: 4000
    Name of the category to which the item is assigned.
  • Read Only: true
    Unique identifier of order header for the orders coming from Oracle Fusion Cloud Order Management.
  • Read Only: true
    Uniquely identifies the orchestration line in Oracle Fusion Cloud Order Management for a demand.
  • Read Only: true
    Maximum Length: 100
    Number that uniquely identifies the orchestration line in Oracle Fusion Cloud Order Management for a demand.
  • Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the orchestration in Oracle Fusion Cloud Order Management for a demand.
  • Read Only: true
    Value that indicates whether the request is the arrival date or ship date type. Depending on the request type, the requested date represents the requested ship date and requested arrival date respectively.
  • Read Only: true
    Maximum Length: 25
    Name of the unit of measure that's associated with the order quantity.
  • Read Only: true
    Maximum Length: 280
    Identifier for the order promising demand. Depending on the order type, it indicates the sales order line number or the fulfillment line number orders.
  • Read Only: true
    Maximum Length: 4000
    Status of the sales order line that indicates whether an order is in picked, frozen, shipped, or other status. The order lines that are in the picked, frozen, shipped, or canceled status aren't released. A list of accepted values is defined in the lookup type ORA_MSC_BM_ORDER_LINE_STATUS.
  • Read Only: true
    Identifies the status of the sales order line as it progresses through its life cycle.
  • Read Only: true
    Quantity that shows the difference between the revenue and the cost of promising the fulfillment line based on the current promising result.
  • Read Only: true
    Maximum Length: 400
    Order identifier on a sales order.
  • Read Only: true
    Revenue from the demand.
  • Read Only: true
    Maximum Length: 80
    Indicates the order type such as sales order or forecast.
  • Read Only: true
    Name of the demand order type. Indicates whether the demand is a simulation demand, sales order, or fulfillment line.
  • Read Only: true
    Maximum Length: 4000
    Time zone associated with the organization from where the material is being sourced.
  • Read Only: true
    Quantity associated with the order. This value is extracted from the source application.
  • Read Only: true
    Maximum Length: 4000
    Type of the set to which the demand line originally belonged before it was removed.
  • Read Only: true
    Maximum Length: 50
    Name of a ship set to which a demand line originally belonged before that demand line was removed.
  • Read Only: true
    Maximum Length: 400
    Value that uniquely identifies the fulfillment line for the root parent configure-to-order model. This attribute is applicable only for configured-to-order items.
  • Read Only: true
    Manually overridden priority on the sales order line used for running the simulation plan.
  • 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.
  • Read Only: true
    When the request type of a demand is ship, the planned date is the date on which the demand is planned to be shipped. When the request type of a demand is arrival, the planned date is the date on which the demand is planned to arrive.
  • Read Only: true
    Date when the configure-to-order item order or set order can be fulfilled if all items with a constraint rank higher than or equal to this item's constraint rank are removed.
  • Read Only: true
    Maximum Length: 4000
    Code associated with the planner responsible for the demand.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 11 that represents the attribute project, for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 12 that represents the attribute task, for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 13 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 14 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 15 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 16 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 17 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 18 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 19 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 20 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 21 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 22 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 23 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 24 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 25 for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Value for the planning attribute number 26 that represents the attribute project group, for the demand in a backlog management plan.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether a demand line is involved in the simulation run or not. The valid values are 1 and 2. The value 1 indicates that the order line is involved in the simulation run and 2 indicates that the order line isn't involved in the simulation run.
  • Read Only: true
    Name of a project stamped on the demand. A project is a planned piece of work that has a specific purpose. Demands and supplies can be allocated to specific projects.
  • Read Only: true
    Name of a group that contains projects assigned to the group.
  • Read Only: true
    Date when the demand is planned to arrive at the customer site in the backlog management plan.
  • Read Only: true
    Date when the demand is planned in the backlog management plan.
  • Read Only: true
    Date when the demand is planned to be shipped from the warehouse to the customer site in the backlog management plan.
  • Read Only: true
    Maximum Length: 50
    Name of the promising system that generated the promise.
  • Read Only: true
    Maximum Length: 4000
    Contains one of the following values: Yes or No. If Yes, then the order can be planned earlier than its current scheduled date until its requested date. If No, then the order can't be planned earlier than its existing scheduled date. The default value is Yes.
  • Read Only: true
    Attribute to specify whether the existing scheduled date for a demand line can be improved during planning. Valid values are 1 and 2 where 1 indicates that the demand line can be improved and 2 indicates that it can't. The default value is 1.
  • Read Only: true
    Code that indicates the reason why the demand wasn't planned.
  • Read Only: true
    Unique identifier of the of the customer or destination organization for an internal sales order.
  • Read Only: true
    Value that indicates the release status. Values include Release, Released, Marked for Release, or blank. If Release, then the demand is eligible for release to the order management application. If Marked for Release, then the demand has been confirmed to be released to the order management application. If Released, then the line has already been released to order management.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the order has been released or not.
  • Read Only: true
    Indicates that a demand line has been removed from a ship or arrival set.
  • Read Only: true
    Date when the material is requested to be available. Depending on the order date type code this attribute represents the requested ship date or the requested arrival date.
  • Read Only: true
    Date when the material is requested to arrive at the customer location.
  • Read Only: true
    Maximum Length: 4000
    Name of the requested carrier.
  • Read Only: true
    Unique identifier of the carrier that's requested on the fulfillment line.
  • Read Only: true
    Maximum Length: 4000
    Name of the requested drop-ship supplier.
  • Read Only: true
    Maximum Length: 4000
    Name of the requested drop-ship supplier site.
  • Read Only: true
    Maximum Length: 4000
    Mode of transport that must be used when shipping the requested item to the customer.
  • Read Only: true
    Unique identifier of the mode of transport that must be used when shipping the requested item to the customer.
  • Read Only: true
    Maximum Length: 4000
    Unique code of the requested ship-from organization from where the order promising demand is requested to be shipped to the customer.
  • Read Only: true
    Unique identifier of the requested ship-from organization from where the order promising demand is requested to be shipped to the customer.
  • Read Only: true
    Maximum Length: 4000
    Name of the requested ship-from organization from where the order promising demand is requested to be shipped to the customer.
  • Read Only: true
    Quantity that's requested on the order promising demand. The order promising demand can be either a sales order or a fulfillment line.
  • Read Only: true
    Maximum Length: 4000
    Service level that must be used to ship material to the customer.
  • Read Only: true
    Unique identifier of the service level that must be used to ship material to the customer.
  • Read Only: true
    Maximum Length: 4000
    Shipping method that must be used to ship material to the customer. The ship method is a combination of carrier, mode of transport, and service level.
  • Read Only: true
    Unique identifier of the requested drop-ship supplier.
  • Read Only: true
    Unique identifier of the requested drop-ship supplier site.
  • Read Only: true
    Date when the material is requested to be shipped from the warehouse.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the request is a ship type or arrival type request.
  • Read Only: true
    Maximum Length: 4000
    Status that indicates reservation of the fulfillment line in the fulfillment system. Valid values are Yes and No.
  • Read Only: true
    Value that indicates the extent of reservation of the fulfillment line in the fulfillment system. Valid values are 1 and 2.
  • Read Only: true
    Quantity of the fulfillment line that's been reserved in the fulfillment system
  • Read Only: true
    Maximum Length: 4000
    Unique identifier for the supply document that's been reserved against the order promising demand. There can be multiple supplies reserved against an order promising demand in which case the supply document number values are separated by a comma.
  • Read Only: true
    Maximum Length: 4000
    Order type of the supply document that has been reserved against the order promising demand line. This can be any supply order type, such as transfer order or purchase order. There can be multiple supplies reserved against an order promising demand in which case the supply document type values are separated by a comma.
  • 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: 4000
    Contains one of the following values: 1 or null. If 1, the demand record has been modified or newly created in the simulation plan. If null, the demand record hasn't been modified or newly created in the simulation plan. Default value is null.
  • Read Only: true
    Maximum Length: 400
    Unique identifier for the sales order line.
  • Read Only: true
    Maximum Length: 240
    Order identifier on a sales order.
  • Read Only: true
    Date on which the order has been scheduled to arrive.
  • Read Only: true
    When the request type of a demand is ship, the scheduled date is the date on which the demand is scheduled to be shipped. When the request type of a demand is arrival, the scheduled date is the date on which the demand is scheduled to arrive.
  • Read Only: true
    Maximum Length: 4000
    Carrier used for shipping when the line was scheduled.
  • Read Only: true
    Number of days the fulfillment line was delayed when it was scheduled.
  • Read Only: true
    Maximum Length: 4000
    Name of the drop-ship supplier used for shipping material to the customer when the line was scheduled.
  • Read Only: true
    Maximum Length: 4000
    Name of the drop-ship supplier site used for shipping material to the customer when the line was scheduled.
  • Read Only: true
    Maximum Length: 300
    Item used to schedule the line when the line was originally scheduled.
  • Read Only: true
    Maximum Length: 240
    Description of the item used to schedule the line.
  • Read Only: true
    Maximum Length: 4000
    Name of the shipping mode used for scheduling the order promising demand line.
  • Read Only: true
    Quantity of the fulfillment line that's been scheduled.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure for the scheduled item.
  • Read Only: true
    Maximum Length: 4000
    Service level of the transport that was used to schedule the line
  • Read Only: true
    Unique identifier for the scheduled ship-from organization.
  • Read Only: true
    Maximum Length: 4000
    Unique code for the scheduled ship-from organization.
  • Read Only: true
    Maximum Length: 4000
    Name of the scheduled ship-from organization.
  • Read Only: true
    Value that uniquely identifies the drop-ship supplier on the fulfillment line from where material has been scheduled to be shipped to the customer ship-to site.
  • Read Only: true
    Value that uniquely identifies the drop-ship supplier site on the fulfillment line from where material has been scheduled to be shipped to the customer ship-to site.
  • Read Only: true
    Date for shipping the material from a warehouse for a line that's already been scheduled.
  • Read Only: true
    Maximum Length: 4000
    Status that indicates whether the fulfillment line has been scheduled.
  • Read Only: true
    Status code that indicates whether the fulfillment line has been scheduled. Valid values are 1 and 2 where 1 indicates scheduled and 2 indicates not scheduled.
  • Read Only: true
    Price at which the item on the order line is sold.
  • Read Only: true
    Maximum Length: 280
    Concatenation of the order number and set name attributes for a set order. The attributes are separated by a colon.
  • Read Only: true
    Maximum Length: 50
    Name of the shipment set or arrival set.
  • Read Only: true
    Maximum Length: 4000
    Type of the set. This can have values such as ship set and arrival set. Groups of demand that must be either shipped together or must arrive together.
  • Read Only: true
    Code that indicates whether a set is a shipment set or an arrival set.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the organization code for the receiving organization of an internal sales order.
  • Read Only: true
    Maximum Length: 4000
    Name of the receiving organization of an internal sales order.
  • Read Only: true
    Maximum Length: 4000
    Name of the zone that the customer belongs to.
  • Read Only: true
    Value that shows the planned days of delay or the difference between the planned date and the requested date.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether a demand is of the simulation type. Demands of the simulation type aren't true sales orders but order simulations created by the backlog planner to review how the actual sales order might be planned after it's created. The possible values are Yes or No.
  • Read Only: true
    Maximum Length: 150
    Number that uniquely identifies the sales order line for the demand.
  • Read Only: true
    Maximum Length: 150
    Number that identifies the source document for the internal order fulfillment line request.
  • Read Only: true
    Maximum Length: 240
    Number that identifies the source document for the internal order fulfillment line request.
  • Read Only: true
    Maximum Length: 100
    Order type of the document in the source system against which fulfillment line has been created. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Read Only: true
    Value that uniquely identifies the source organization on the demand.
  • Read Only: true
    Unique identifier of the instance that the shipping organization belongs to.
  • Read Only: true
    Maximum Length: 4000
    Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
  • Read Only: true
    Indicates whether the order line was actually split.
  • Read Only: true
    Maximum Length: 4000
    Source system associated with the requested drop-ship supplier.
  • Read Only: true
    Unique identifier of the source system for the supplier site.
  • Read Only: true
    Date to pick and pack the item that's to be shipped from the warehouse.
  • Read Only: true
    Name of an activity in a project. Demands and supplies can be allocated to a task in a project.
  • Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Read Only: true
    Maximum Length: 100
    Priority of a demand defined on the order line, collected either from Oracle Fusion Cloud Order Management or from an external source and shown in the backlog management plan.
  • Read Only: true
    For a planned order associated with demands, this field refers to the assembly date with this item as a component.
  • Read Only: true
    For component demands, this field refers to the unique identifier of the assembly item that uses this item as a component.
  • Read Only: true
    Number that specifies the open quantity for the demand or the demand quantity that hasn't been shipped..
  • Read Only: true
    Date that corresponds to the lead time available to fulfill the demand.
  • Read Only: true
    Unique value designating a geographic boundary, such as a country or a range of postal codes where the demand quantity is being shipped. For example, a zone may include France, Italy, and England.
Back to Top

Examples

This example describes how to get all backlog simulation plan runs.

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/bmSimulationPlans"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "BmRunId": 14009,
            "ExecutionId": 61446,
            "BmRunType": 2,
            "PlanStartDate": "2021-01-04T00:00:00+00:00",
            "DemandPriorityRuleId": 300100178581708,
            "DemandPriorityRuleName": null,
            "SearchCriteria": null,
            "EditedAttributeList": null,
            "CreatedBy": "bm_advanced_user",
            "CreationDate": "2025-02-09T07:11:17.407+00:00",
            "LastUpdatedBy": "bm_advanced_user",
            "LastUpdateDate": "2025-02-09T07:11:17.407+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans/14009",
                    "name": "bmSimulationPlans",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans/14009",
                    "name": "bmSimulationPlans",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans/14009/child/PlanDemands",
                    "name": "PlanDemands",
                    "kind": "collection"
                }
            ]
        },
        {
            "BmRunId": 15010,
            "ExecutionId": 68229,
            "BmRunType": 2,
            "PlanStartDate": "2021-01-04T00:00:00+00:00",
            "DemandPriorityRuleId": 300100178581705,
            "DemandPriorityRuleName": null,
            "SearchCriteria": null,
            "EditedAttributeList": null,
            "CreatedBy": "bm_advanced_user",
            "CreationDate": "2025-02-09T14:27:57.645+00:00",
            "LastUpdatedBy": "bm_advanced_user",
            "LastUpdateDate": "2025-02-09T14:27:57.645+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans/15010",
                    "name": "bmSimulationPlans",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans/15010",
                    "name": "bmSimulationPlans",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans/15010/child/PlanDemands",
                    "name": "PlanDemands",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlans",
            "name": "bmSimulationPlans",
            "kind": "collection"
        }
    ]
}
Back to Top