Get all backlog simulation plan runs
get
/fscmRestApi/resources/11.13.18.05/bmSimulationPlans
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey 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.
- PrimaryKey Finds the backlog simulation plan run according to the plan run identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : bmSimulationPlans
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : bmSimulationPlans-item-response
Type:
Show Source
object
-
AllocationMeasures: array
Allocations
Title:
Allocations
The Allocations resource gets supply allocation details from the backlog management plan. -
AllocationScenarioId: integer
(int64)
Read Only:
true
Unique identifier of an allocation scenario used in a simulation run. -
BmRunId: integer
Read Only:
true
Value that uniquely identifies the backlog management simulation plan run. -
BmRunType: number
Read Only:
true
Run the backlog simulation plan for selected demands with our without refresh with collected data. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who initially created the backlog management simulation plan run. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user initially created the backlog management simulation plan run. -
DemandPriorityRuleId: integer
(int64)
Read Only:
true
Unique identifier of a demand priority rule used in a simulation plan run. -
DemandPriorityRuleName: string
Read Only:
true
Name of a demand priority rule used in a simulation plan run. -
EditedAttributeList: string
Read Only:
true
List of demand attributes that were edited in the backlog analysis page and used in the simulation plan run. -
ExecutionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the process of the backlog management simulation plan run. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the backlog management simulation plan run. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the backlog management simulation plan run. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanDemands: array
Plan Demands
Title:
Plan Demands
Backlog demands and plan output in the latest backlog management simulation plan run in the context of a specific session. -
PlanStartDate: string
(date-time)
Read Only:
true
Date that signifies the start of the backlog plan's planning horizon. It's typically defaulted to the system date. -
SearchCriteria: string
Read Only:
true
Search condition used in the backlog analysis page that's used in the backlog simulation plan run.
Nested Schema : Allocations
Type:
array
Title:
Allocations
The Allocations resource gets supply allocation details from the backlog management plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AllocationDate: string
(date)
Date of the week when the supply is allocated.
-
AllocSteal: number
Read Only:
true
Quantity of the allocation that's consumed by demands at other allocation nodes. -
AllocSup: number
Read Only:
true
Quantity of the allocated supply. -
AllocUserDef: integer
Quantity of the allocated supply that's manually specified.
-
AttributeId: integer
Value that uniquely identifies the allocation level.
-
AttributeValueId: integer
Value that uniquely identifies the allocation node.
-
AvailSteal: number
Read Only:
true
Quantity of allocation that's available for consumption by other allocation nodes. -
AvailSup: number
Read Only:
true
Quantity of allocation available at the allocation node. -
BmRunId: integer
Value that uniquely identifies the backlog management plan run.
-
ConsumHistory: number
Read Only:
true
Quantity of supply consumed at an allocation node by shipped orders. -
ConsumSup: number
Read Only:
true
Quantity of allocation that's consumed at the allocation node. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the allocation entry. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the allocation entry. -
CumlAvailSup: number
Read Only:
true
Quantity of cumulative allocation at the allocation node. -
DemandQuantity: number
Total number of demand units at an allocation node with requested dates in the current week.
-
DemandQuantityOntime: number
Number of units of demand that are fulfilled on time.
-
ESSJobId: integer
Value that uniquely identifies the process that updates the allocation data.
-
GrossAlloc: number
Read Only:
true
Quantity of allocation at a node and all other nodes within its hierarchy. -
GrossAllocSteal: number
Read Only:
true
Quantity of allocation that was at a node and all other nodes within its hierarchy. -
GrossAvail: number
Read Only:
true
Quantity of allocation available at a node and all other nodes within its hierarchy. -
GrossConsum: number
Read Only:
true
Quantity of allocation consumed at a node and all other nodes within its hierarchy. -
GrossConsumHistory: number
Read Only:
true
Quantity of allocation consumed by shipped orders at a node and all other nodes within its hierarchy. -
GrossCumlAvail: number
Read Only:
true
Quantity of cumulative allocation available at a node and all other nodes within its hierarchy. -
GrossSup: number
Read Only:
true
Quantity that's the sum of the supply in a week across all allocation nodes and the supply consumed by the shipped sales orders across all allocation nodes. -
InventoryItemId: integer
Value that uniquely identifies the item for which the allocation data is requested.
-
InventoryItemName: string
Maximum Length:
255
Name of the item for which allocation data is requested. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the allocation record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the allocation record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the allocation record. -
Level1AttributeName: string
Maximum Length:
255
Name of the top hierarchical allocation level in the allocation hierarchy. -
Level1AttributeValName: string
Maximum Length:
255
Name of the top hierarchical allocation level value in the allocation hierarchy. -
Level1AttributeValueId: integer
Value that uniquely identifies the top hierarchical allocation level in the allocation hierarchy.
-
Level2AttributeName: string
Maximum Length:
255
Name of the intermediate hierarchical allocation level in the allocation hierarchy. -
Level2AttributeValName: string
Maximum Length:
255
Name of the intermediate hierarchical allocation level value in the allocation hierarchy. -
Level2AttributeValueId: integer
Value that uniquely identifies the intermediate hierarchical allocation level in the allocation hierarchy.
-
Level3AttributeName: string
Maximum Length:
255
Name of the lowest hierarchical allocation level in the allocation hierarchy. -
Level3AttributeValName: string
Maximum Length:
255
Name of the lowest hierarchical allocation level value in the allocation hierarchy. -
Level3AttributeValueId: integer
Value that uniquely identifies the lowest hierarchical allocation level in the allocation hierarchy.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Message that indicates the success or failure of the bulk allocation upload.
-
NetWeekSup: number
Read Only:
true
Quantity of overall supply for an item and organization in a week. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization for which the allocation data is requested. -
OrganizationId: integer
Value that uniquely identifies the organization for which the allocation data is requested.
-
OrganizationName: string
Maximum Length:
255
Name of the organization for which the allocation data is requested. -
PlanFillPercent: number
Percentage of the demand planned by the requested date.
-
PlanOntimePercent: number
Percentage of demand scheduled on time.
-
Revenue: number
Revenue from demands in the current week.
-
RevenuePlanOntime: number
Revenue from demands planned on time.
-
RevenueSchOntime: number
Revenue from demands scheduled on time.
-
ScheduleFillPercent: number
Percentage of the total demand scheduled by the requested date.
-
ScheduleOntimePercent: number
Percentage of demand scheduled on time.
-
UpdateAsync: string
(byte)
Encoded allocation data when updating the allocation data using bulk update.
-
UpdateMode: string
Mode that indicates whether the allocation data is updated using the bulk update process or not.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : bmSimulationPlans-PlanDemands-item-response
Type:
Show Source
object
-
AllowSplits: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the demand can be split for fulfillment. -
AllowSplitsCode: number
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. -
AttributeChar1: string
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. -
AttributeChar10: string
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. -
AttributeChar11: string
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. -
AttributeChar12: string
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. -
AttributeChar13: string
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. -
AttributeChar14: string
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. -
AttributeChar15: string
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. -
AttributeChar16: string
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. -
AttributeChar17: string
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. -
AttributeChar18: string
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. -
AttributeChar19: string
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. -
AttributeChar2: string
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. -
AttributeChar20: string
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. -
AttributeChar3: string
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. -
AttributeChar4: string
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. -
AttributeChar5: string
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. -
AttributeChar6: string
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. -
AttributeChar7: string
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. -
AttributeChar8: string
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. -
AttributeChar9: string
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. -
AttributeDate1: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 1 of type date for the demand in a backlog management plan. -
AttributeDate10: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 10 of type date for the demand in a backlog management plan. -
AttributeDate11: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 11 of type date for the demand in a backlog management plan. -
AttributeDate12: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 12 of type date for the demand in a backlog management plan. -
AttributeDate13: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 13 of type date for the demand in a backlog management plan. -
AttributeDate14: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 14 of type date for the demand in a backlog management plan. -
AttributeDate15: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 15 of type date for the demand in a backlog management plan. -
AttributeDate16: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 16 of type date for the demand in a backlog management plan. -
AttributeDate17: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 17 of type date for the demand in a backlog management plan. -
AttributeDate18: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 18 of type date for the demand in a backlog management plan. -
AttributeDate19: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 19 of type date for the demand in a backlog management plan. -
AttributeDate2: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 2 of type date for the demand in a backlog management plan. -
AttributeDate20: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 20 of type date for the demand in a backlog management plan. -
AttributeDate3: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 3 of type date for the demand in a backlog management plan. -
AttributeDate4: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 4 of type date for the demand in a backlog management plan. -
AttributeDate5: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 5 of type date for the demand in a backlog management plan. -
AttributeDate6: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 6 of type date for the demand in a backlog management plan. -
AttributeDate7: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 7 of type date for the demand in a backlog management plan. -
AttributeDate8: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 8 of type date for the demand in a backlog management plan. -
AttributeDate9: string
(date)
Read Only:
true
Value for the descriptive flexfield attribute number 9 of type date for the demand in a backlog management plan. -
AttributeNumber1: number
Read Only:
true
Value for the descriptive flexfield attribute number 1 of type number for the demand in a backlog management plan. -
AttributeNumber10: number
Read Only:
true
Value for the descriptive flexfield attribute number 10 of type number for the demand in a backlog management plan. -
AttributeNumber2: number
Read Only:
true
Value for the descriptive flexfield attribute number 2 of type number for the demand in a backlog management plan. -
AttributeNumber3: number
Read Only:
true
Value for the descriptive flexfield attribute number 3 of type number for the demand in a backlog management plan. -
AttributeNumber4: number
Read Only:
true
Value for the descriptive flexfield attribute number 4 of type number for the demand in a backlog management plan. -
AttributeNumber5: number
Read Only:
true
Value for the descriptive flexfield attribute number 5 of type number for the demand in a backlog management plan. -
AttributeNumber6: number
Read Only:
true
Value for the descriptive flexfield attribute number 6 of type number for the demand in a backlog management plan. -
AttributeNumber7: number
Read Only:
true
Value for the descriptive flexfield attribute number 7 of type number for the demand in a backlog management plan. -
AttributeNumber8: number
Read Only:
true
Value for the descriptive flexfield attribute number 8 of type number for the demand in a backlog management plan. -
AttributeNumber9: number
Read Only:
true
Value for the descriptive flexfield attribute number 9 of type number for the demand in a backlog management plan. -
AvailableItem: string
Read Only:
true
Maximum Length:300
Name of item used to promise the fulfillment line. -
AvailableQuantity: number
Read Only:
true
Quantity that was available to promise the fulfillment line. -
BaseDemandId: integer
(int64)
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. -
BmRunId: number
Read Only:
true
Value that uniquely identifies the backlog management plan run. -
CatalogName: string
Read Only:
true
Name of the catalog being collected. -
CategoryId: string
Read Only:
true
Unique identifier of the category associated with an item requested on the demand. -
CompletedQuantity: number
Read Only:
true
Sales order quantity that has already been completed. -
ConfigurationItem: string
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. -
ConfigurationItemId: string
Read Only:
true
Maximum Length:1200
Unique identifier of the configuration item. -
ConstraintRank: number
Read Only:
true
Value that identifies the item constraint ranking based on the difference between their respective item availability dates and requested dates. -
CreationDate: string
(date)
Read Only:
true
Date when the user created the demand. -
CustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer on the demand. -
CustomerName: string
Read Only:
true
Maximum Length:4000
Name of the customer on the demand. -
CustomerShipSite: string
Read Only:
true
Maximum Length:4000
Name of the customer site on the demand. -
CustomerSiteId: number
Read Only:
true
Value that uniquely identifies the customer site of the demand. -
DaysLate: integer
(int64)
Read Only:
true
Number of days that the demand is late. -
DaysOfImprovement: integer
Read Only:
true
Difference between the planned and scheduled shipment or arrival dates for a demand line, measured in days. -
DaysPotentiallyImprove: number
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. -
DemandClass: string
Read Only:
true
Maximum Length:34
Name of the demand class on the demand. -
DemandClassCode: string
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. -
DemandFulfillmentLeadTime: number
Read Only:
true
Value that indicates the delivery lead time entered on the fulfillment line. -
DemandId: number
Read Only:
true
Value that uniquely identifies a demand in a backlog management plan run. -
DemandLeadTimeDate: string
(date)
Read Only:
true
Date that corresponds to the lead time available to fulfill the demand. -
DemandPriority: number
Read Only:
true
Priority of a demand in the backlog management plan run. -
DemandSourceInstance: string
Read Only:
true
Maximum Length:360
Name of the source system in which the demand originated. -
DemandSourceSystemId: number
Read Only:
true
Unique identifier of the source system in which the demand originated. -
DemandSourceType: number
Read Only:
true
Type of source system from which data is collected. -
DestinationTimeZone: string
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. -
DestinationType: string
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. -
DisplayAttributeCode: integer
(int64)
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. -
EarliestAcceptableDate: string
(date)
Read Only:
true
Earliest date that's acceptable on the fulfillment line. -
EarliestAcceptArrivalDate: string
(date)
Read Only:
true
Earliest arrival date that's acceptable on the fulfillment line. -
EarliestAcceptShipDate: string
(date)
Read Only:
true
Earliest ship date that's acceptable on the fulfillment line. -
EarliestPromisedDate: string
(date)
Read Only:
true
Earliest date when the item can be available. -
EnforceCurrentCommit: string
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. -
EnforceCurrentCommitCode: number
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. -
ErrorText: string
Read Only:
true
Maximum Length:4000
Value that indicates the reason why the demand wasn't planned. -
ExpectedArrivalDate: string
(date)
Read Only:
true
Date when the requested item line is expected to arrive at the customer ship-to site from the ship-from organization. -
ExpectedCarrier: string
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. -
ExpectedCarrierId: number
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. -
ExpectedDate: string
(date)
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. -
ExpectedDshipSupplier: string
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. -
ExpectedDshipSuppSite: string
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. -
ExpectedModeOfTransport: string
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. -
ExpectedModeOfTransportId: number
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. -
ExpectedOrganizationId: number
Read Only:
true
Unique identifier of the planned ship-from organization from where material is to be shipped to the customer ship-to site. -
ExpectedServiceLevel: string
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. -
ExpectedServiceLevelId: number
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. -
ExpectedShipDate: string
(date)
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. -
ExpectedShipFromWarehouse: string
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. -
ExpectedShipFromWareName: string
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. -
ExpectedShipMethod: string
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. -
ExpectedShipMethodId: string
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. -
ExpectedSupplierId: number
Read Only:
true
Value that identifies the drop-ship supplier from where material is to be shipped to the customer ship-to site. -
ExpectedSupplierSiteId: number
Read Only:
true
Value that identifies the drop-ship supplier site from where material is to be shipped to the customer ship-to site. -
FirmSalesOrder: string
Read Only:
true
Maximum Length:4000
Value that indicates whether a demand has been locked. -
FirmSalesOrderCode: number
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. -
FulfillmentCost: number
Read Only:
true
Number that indicates the expected shipping cost associated with the fulfillment line or availability option. -
FulfillmentLine: string
Read Only:
true
Maximum Length:400
Value that identifies the fulfillment line. -
FulfillmentLineNumber: number
Read Only:
true
Number that uniquely identifies the fulfillment line. -
FulfillmentMode: string
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. -
GlobalAttributeChar21: string
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. -
GlobalAttributeChar22: string
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. -
GlobalAttributeChar23: string
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. -
GlobalAttributeNumber13: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 3 associated with the demand in a backlog management plan. -
GlobalAttributeNumber14: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 4 associated with the demand in a backlog management plan. -
GlobalAttributeNumber15: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 5 associated with the demand in a backlog management plan. -
GlobalAttributeNumber16: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 6 associated with the demand in a backlog management plan. -
GlobalAttributeNumber17: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 7 associated with the demand in a backlog management plan. -
GlobalAttributeNumber18: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 8 associated with the demand in a backlog management plan. -
GlobalAttributeNumber19: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 9 associated with the demand in a backlog management plan. -
GlobalAttributeNumber20: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 10 associated with the demand in a backlog management plan. -
GlobalAttributeNumber21: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 11 associated with the demand in a backlog management plan. -
GlobalAttributeNumber22: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 12 associated with the demand in a backlog management plan. -
GlobalAttributeNumber23: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 13 associated with the demand in a backlog management plan. -
GlobalAttributeNumber24: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 14 associated with the demand in a backlog management plan. -
GlobalAttributeNumber25: integer
(int64)
Read Only:
true
Value that identifies planning attribute number 15 associated with the demand in a backlog management plan. -
InquiryDemand: number
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. -
InternalOrderType: string
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. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item that's requested on the demand. -
Item: string
Read Only:
true
Maximum Length:300
Name of the item that's requested on the demand. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item that's requested on the demand. -
ItemSubType: string
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. -
ItemSubTypeCode: number
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. -
ItemType: number
Read Only:
true
Name of the item type. The values include model, option class, and standard item, depending on the item attributes. -
ItemTypeCode: string
Read Only:
true
Maximum Length:80
Code that uniquely identifies the item type of the item in the demand. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the demand record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the demand record. -
LatestAcceptableArrivalDate: string
(date)
Read Only:
true
Last arrival date that's acceptable on the fulfillment line. -
LatestAcceptableDate: string
(date)
Read Only:
true
Last date that's acceptable on the fulfillment line. -
LatestAcceptableShipDate: string
(date)
Read Only:
true
Last ship date that's acceptable on the fulfillment line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualOverride: string
Read Only:
true
Maximum Length:4000
Identifies if the demand was manually overridden or not for the backlog management simulation plan run. -
ManualOverrideCode: number
Read Only:
true
Value that indicates whether the planned information on the demand has been manually overridden. -
NameOfCategory: string
Read Only:
true
Maximum Length:4000
Name of the category to which the item is assigned. -
OrchOrderHeaderId: integer
(int64)
Read Only:
true
Unique identifier of order header for the orders coming from Oracle Fusion Cloud Order Management. -
OrchOrderLineId: integer
(int64)
Read Only:
true
Uniquely identifies the orchestration line in Oracle Fusion Cloud Order Management for a demand. -
OrchOrderLineNumber: string
Read Only:
true
Maximum Length:100
Number that uniquely identifies the orchestration line in Oracle Fusion Cloud Order Management for a demand. -
OrchOrderNumber: string
Read Only:
true
Maximum Length:50
Number that uniquely identifies the orchestration in Oracle Fusion Cloud Order Management for a demand. -
OrderDateTypeCode: number
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. -
OrderedUOM: string
Read Only:
true
Maximum Length:25
Name of the unit of measure that's associated with the order quantity. -
OrderLineNumber: string
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. -
OrderLineStatus: string
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. -
OrderLineStatusCode: number
Read Only:
true
Identifies the status of the sales order line as it progresses through its life cycle. -
OrderMargin: number
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. -
OrderNumber: string
Read Only:
true
Maximum Length:400
Order identifier on a sales order. -
OrderRevenue: number
Read Only:
true
Revenue from the demand. -
OrderType: string
Read Only:
true
Maximum Length:80
Indicates the order type such as sales order or forecast. -
OrderTypeCode: number
Read Only:
true
Name of the demand order type. Indicates whether the demand is a simulation demand, sales order, or fulfillment line. -
OrgTimeZone: string
Read Only:
true
Maximum Length:4000
Time zone associated with the organization from where the material is being sourced. -
OriginalQuantity: number
Read Only:
true
Quantity associated with the order. This value is extracted from the source application. -
OriginalSetType: string
Read Only:
true
Maximum Length:4000
Type of the set to which the demand line originally belonged before it was removed. -
OriginalShipSetName: string
Read Only:
true
Maximum Length:50
Name of a ship set to which a demand line originally belonged before that demand line was removed. -
OrigParentFulLine: string
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. -
OverridePriority: number
Read Only:
true
Manually overridden priority on the sales order line used for running the simulation plan. -
ParentFulfillmentLine: string
Read Only:
true
Maximum Length:400
For an order with assemble-to-order elements, this attribute indicates the immediate parent of an assemble-to-order component. -
PlannedDate: string
(date)
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. -
PlannedDateWithoutItem: string
(date)
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. -
PlannerCode: string
Read Only:
true
Maximum Length:4000
Code associated with the planner responsible for the demand. -
PlanningAttrVal11: string
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. -
PlanningAttrVal12: string
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. -
PlanningAttrVal13: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 13 for the demand in a backlog management plan. -
PlanningAttrVal14: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 14 for the demand in a backlog management plan. -
PlanningAttrVal15: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 15 for the demand in a backlog management plan. -
PlanningAttrVal16: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 16 for the demand in a backlog management plan. -
PlanningAttrVal17: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 17 for the demand in a backlog management plan. -
PlanningAttrVal18: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 18 for the demand in a backlog management plan. -
PlanningAttrVal19: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 19 for the demand in a backlog management plan. -
PlanningAttrVal20: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 20 for the demand in a backlog management plan. -
PlanningAttrVal21: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 21 for the demand in a backlog management plan. -
PlanningAttrVal22: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 22 for the demand in a backlog management plan. -
PlanningAttrVal23: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 23 for the demand in a backlog management plan. -
PlanningAttrVal24: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 24 for the demand in a backlog management plan. -
PlanningAttrVal25: string
Read Only:
true
Maximum Length:4000
Value for the planning attribute number 25 for the demand in a backlog management plan. -
PlanningAttrVal26: string
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. -
PlanScope: string
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. -
Project: integer
(int64)
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. -
ProjectGroup: integer
(int64)
Read Only:
true
Name of a group that contains projects assigned to the group. -
PromisedArrivalDate: string
(date)
Read Only:
true
Date when the demand is planned to arrive at the customer site in the backlog management plan. -
PromiseDate: string
(date)
Read Only:
true
Date when the demand is planned in the backlog management plan. -
PromisedShipDate: string
(date)
Read Only:
true
Date when the demand is planned to be shipped from the warehouse to the customer site in the backlog management plan. -
PromisingSystem: string
Read Only:
true
Maximum Length:50
Name of the promising system that generated the promise. -
PullIn: string
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. -
PullInCode: number
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. -
ReasonCode: number
Read Only:
true
Code that indicates the reason why the demand wasn't planned. -
ReceivingOrgId: integer
(int64)
Read Only:
true
Unique identifier of the of the customer or destination organization for an internal sales order. -
ReleaseStatus: number
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. -
ReleaseStatusMeaning: string
Read Only:
true
Maximum Length:4000
Indicates whether the order has been released or not. -
RemovedFromSet: number
Read Only:
true
Indicates that a demand line has been removed from a ship or arrival set. -
RequestDate: string
(date)
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. -
RequestedArrivalDate: string
(date)
Read Only:
true
Date when the material is requested to arrive at the customer location. -
RequestedCarrier: string
Read Only:
true
Maximum Length:4000
Name of the requested carrier. -
RequestedCarrierId: integer
(int64)
Read Only:
true
Unique identifier of the carrier that's requested on the fulfillment line. -
RequestedDropShipSupplier: string
Read Only:
true
Maximum Length:4000
Name of the requested drop-ship supplier. -
RequestedDshipSupplierSite: string
Read Only:
true
Maximum Length:4000
Name of the requested drop-ship supplier site. -
RequestedModeOfTransport: string
Read Only:
true
Maximum Length:4000
Mode of transport that must be used when shipping the requested item to the customer. -
RequestedModeOfTransportId: integer
(int64)
Read Only:
true
Unique identifier of the mode of transport that must be used when shipping the requested item to the customer. -
RequestedOrganization: string
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. -
RequestedOrganizationId: number
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. -
RequestedOrganizationName: string
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. -
RequestedQuantity: number
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. -
RequestedServiceLevel: string
Read Only:
true
Maximum Length:4000
Service level that must be used to ship material to the customer. -
RequestedServiceLevelId: integer
(int64)
Read Only:
true
Unique identifier of the service level that must be used to ship material to the customer. -
RequestedShipMethod: string
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. -
RequestedSupplierId: integer
(int64)
Read Only:
true
Unique identifier of the requested drop-ship supplier. -
RequestedSupplierSiteId: integer
(int64)
Read Only:
true
Unique identifier of the requested drop-ship supplier site. -
RequestShipDate: string
(date)
Read Only:
true
Date when the material is requested to be shipped from the warehouse. -
RequestType: string
Read Only:
true
Maximum Length:4000
Indicates whether the request is a ship type or arrival type request. -
ReservationStatus: string
Read Only:
true
Maximum Length:4000
Status that indicates reservation of the fulfillment line in the fulfillment system. Valid values are Yes and No. -
ReservationStatusValue: number
Read Only:
true
Value that indicates the extent of reservation of the fulfillment line in the fulfillment system. Valid values are 1 and 2. -
ReservedQuantity: number
Read Only:
true
Quantity of the fulfillment line that's been reserved in the fulfillment system -
ReservedSupplyDocumentNumber: string
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. -
ReservedSupplyDocumentType: string
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. -
RootFulfillmentLine: string
Read Only:
true
Maximum Length:400
For an order having assemble-to-order elements, this attribute indicates the top-most model. -
RowModified: string
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. -
SalesOrderLineId: string
Read Only:
true
Maximum Length:400
Unique identifier for the sales order line. -
SalesOrderNumber: string
Read Only:
true
Maximum Length:240
Order identifier on a sales order. -
ScheduleArrivalDate: string
(date)
Read Only:
true
Date on which the order has been scheduled to arrive. -
ScheduleDate: string
(date)
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. -
ScheduledCarrier: string
Read Only:
true
Maximum Length:4000
Carrier used for shipping when the line was scheduled. -
ScheduledDaysOfDelays: integer
(int64)
Read Only:
true
Number of days the fulfillment line was delayed when it was scheduled. -
ScheduledDropshipSupplier: string
Read Only:
true
Maximum Length:4000
Name of the drop-ship supplier used for shipping material to the customer when the line was scheduled. -
ScheduledDropshipSupSite: string
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. -
ScheduledItem: string
Read Only:
true
Maximum Length:300
Item used to schedule the line when the line was originally scheduled. -
ScheduledItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item used to schedule the line. -
ScheduledModeOfTransport: string
Read Only:
true
Maximum Length:4000
Name of the shipping mode used for scheduling the order promising demand line. -
ScheduledQuantity: number
Read Only:
true
Quantity of the fulfillment line that's been scheduled. -
ScheduledQuantityUOM: string
Read Only:
true
Maximum Length:4000
Unit of measure for the scheduled item. -
ScheduledServiceLevel: string
Read Only:
true
Maximum Length:4000
Service level of the transport that was used to schedule the line -
ScheduledShipFromOrgId: number
Read Only:
true
Unique identifier for the scheduled ship-from organization. -
ScheduledShipFromWarehouse: string
Read Only:
true
Maximum Length:4000
Unique code for the scheduled ship-from organization. -
ScheduledShipFromWareName: string
Read Only:
true
Maximum Length:4000
Name of the scheduled ship-from organization. -
ScheduledSupplierId: number
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. -
ScheduledSupplierSiteId: number
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. -
ScheduleShipDate: string
(date)
Read Only:
true
Date for shipping the material from a warehouse for a line that's already been scheduled. -
SchedulingStatus: string
Read Only:
true
Maximum Length:4000
Status that indicates whether the fulfillment line has been scheduled. -
SchedulingStatusCode: number
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. -
SellingPrice: number
Read Only:
true
Price at which the item on the order line is sold. -
SetHeaderName: string
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. -
SetName: string
Read Only:
true
Maximum Length:50
Name of the shipment set or arrival set. -
SetType: string
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. -
SetTypeCode: number
Read Only:
true
Code that indicates whether a set is a shipment set or an arrival set. -
ShipToOrganization: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the organization code for the receiving organization of an internal sales order. -
ShipToOrganizationName: string
Read Only:
true
Maximum Length:4000
Name of the receiving organization of an internal sales order. -
ShipToZone: string
Read Only:
true
Maximum Length:4000
Name of the zone that the customer belongs to. -
SimulatedDaysOfDelay: integer
Read Only:
true
Value that shows the planned days of delay or the difference between the planned date and the requested date. -
SimulationDemand: string
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. -
SoLineNumber: string
Read Only:
true
Maximum Length:150
Number that uniquely identifies the sales order line for the demand. -
SourceDocumentLineNumber: string
Read Only:
true
Maximum Length:150
Number that identifies the source document for the internal order fulfillment line request. -
SourceDocumentNumber: string
Read Only:
true
Maximum Length:240
Number that identifies the source document for the internal order fulfillment line request. -
SourceDocumentOrderType: string
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. -
SourceOrganizationId: number
Read Only:
true
Value that uniquely identifies the source organization on the demand. -
SourceOrgInstanceId: integer
(int64)
Read Only:
true
Unique identifier of the instance that the shipping organization belongs to. -
SourceTimeZone: string
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. -
SplitIndicator: number
Read Only:
true
Indicates whether the order line was actually split. -
SupplierSiteSourceSystem: string
Read Only:
true
Maximum Length:4000
Source system associated with the requested drop-ship supplier. -
SupplierSiteSourceSystemId: number
Read Only:
true
Unique identifier of the source system for the supplier site. -
SupplyPickDate: string
(date)
Read Only:
true
Date to pick and pack the item that's to be shipped from the warehouse. -
Task: integer
(int64)
Read Only:
true
Name of an activity in a project. Demands and supplies can be allocated to a task in a project. -
UOMCode: string
Read Only:
true
Maximum Length:4000
Abbreviation that identifies the unit of measure associated with the order quantity. -
UserDefinedPriority: string
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. -
UsingAssemblyDemandDate: string
(date)
Read Only:
true
For a planned order associated with demands, this field refers to the assembly date with this item as a component. -
UsingAssemblyItemId: number
Read Only:
true
For component demands, this field refers to the unique identifier of the assembly item that uses this item as a component. -
UsingRequirementQuantity: number
Read Only:
true
Number that specifies the open quantity for the demand or the demand quantity that hasn't been shipped.. -
UsrDefDmdLeadTimeDate: string
(date)
Read Only:
true
Date that corresponds to the lead time available to fulfill the demand. -
ZoneId: integer
(int64)
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all 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" } ] }