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

Get all plan definitions

get

/fscmRestApi/resources/11.13.18.05/planOptions

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 plans according to the plan identifier.
      Finder Variables
      • PlanId; integer; Value that uniquely identifies the plan.
  • 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:
    • ATPIndicator; number; Specifies whether a plan can be used as the basis for available to promise checking.
    • AggrNonKeyCustomer; integer; Determines whether a plan will use aggregated data for nonkey customers. When data is aggregated in a plan, predefined level members are used for the values for the aggregated data. The names of the predefined level members include the words All and Other.
    • AllowAttributeTransfer; integer; Value that indicates whether the supply planning process can move supplies between projects and tasks. This is valid only when the attribute-based netting rule uses project and task attributes.
    • AllowLeadTimeCompression; integer; Specifies whether lead times can be violated to generate exceptions.
    • AltItemWorkDefIndicator; integer; Determines whether the planning process can use alternate item structures and work definitions to create planned orders.
    • AltResourcesIndicator; integer; Determines whether the planning process can use alternate resources to create planned orders.
    • AltSupSourceOrgIndicator; integer; Determines whether the planning process can use alternate suppliers and source organizations to create planned orders.
    • Applied; number; Value used by copy plan.
    • ApplyCutoffToOrderType; integer; Number of days after the plan end date during which the existing supplies are considered for replenishment planning.
    • ApplySegmentSsParam; integer; Indicates whether to calculate safety stock for an item and organization combination using policy level overrides.
    • ApprovedIndicator; integer; Indicates approved or not approved.
    • ArchTimeHierarchy; integer; Time hierarchies, one of which can be used for archiving the plan.
    • ArchTimeLevel; integer; Time hierarchy levels, one of which can be used for archiving the plan.
    • ArchiveIndicator; number; Indicates whether the measures of the plan can be archived.
    • ArchiveMeasureCatalog; integer; Measure catalogs, one of which can be used for archiving the plan.
    • ArchiveVersionDays; integer; Determines the archives to keep that were created in the most recent number of days.
    • AssignmentSetId; integer; ID of the assignment set that holds the sourcing rules and bills of distribution for material flow within the supply chain.
    • AttrBasedNettingRule; integer; Name of the netting rule to be used by the planning process to perform attribute-level demand and supply netting.
    • AutoReleaseCOMPTolerance; number; Indicates the number of compression days allowed for the automatic release of planned orders.
    • AutoReleaseRp; number; Specifies whether planned orders will be released automatically within their release time fence when a plan run completes.
    • AverageBatchSize; integer; Name of plan measure used to model average batch size for intermittent demand.
    • AverageInterarrivalTime; integer; Name of plan measure used to model average interarrival times for intermittent demand.
    • BackwardConsumptionBucket; integer; Number of days that a forecast can be consumed by a sales order before its due date.
    • BackwardDays; number; Number of days. Enables a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of days earlier than the sales order demand.
    • BasePlanId; integer; Name of the plan from which a plan copy was made.
    • CalSsQuantEndItems; integer; Specifies whether to generate new safety stock levels for end items when running a plan.
    • CapConstraintsIndicator; integer; Value that determines whether the planning process applies capacity constraints to all resources or to only bottleneck resources.
    • CompileDesignator; string; Name of the plan that models demand, supply, or both.
    • ConSupplierCapPurOrders; integer; Specifies whether purchase orders consume supplier capacity.
    • ConsumeByForecast; number; Specifies whether the forecast consumption process stays inside the consumption bucket for forecasts and sales orders when selected.
    • ConsumeForecastWithISO; number; Instructs the planning engine to consume forecasts using internal sales orders.
    • ConsumeForecastWithNoDc; number; Time frame for consuming forecasts with no demand class.
    • ConsumeForecastWithinDtf; number; Specifies whether forecast consumption occurs before enforcing demand time fence control. The forecast entries within the demand time fence are used for consumption but not as demand.
    • ConsumptionBucketType; integer; Level of time, such as day, week, or month, to use when consuming the forecast.
    • ConsumptionCalendar; string; Calendar to use when consuming the forecast.
    • ConsumptionDtlsCutoffDays; integer; Number of days forward from the plan start date that consumption details will be written. Consumption details for sales orders or transfer order demands with a due date that's less than the plan start date plus this number of days will have consumption detail records written.
    • CreateTimeFence; number; Specifies whether the supply planning engine creates a natural time fence for an item at the due date (completion) of the supply of the latest firm discrete job, purchase order, flow schedule, or shipment.
    • CreatedBy; string; User name of the user who created the plan definition.
    • CreationDate; string; Date when the plan definition occurrence was created.
    • CriticalResourceSupplierConstr; integer; Indicates a critical resource or supplier when the plan options Enforce Supplier Capacity Constraints and Enforce Resource Capacity Constraints are enabled. When they're enabled, capacity constraints are enforced. Applicable to a constrained supply plan or demand and supply plan.
    • CurrencyConvType; string; Indicates the type of currency conversion type.
    • CurrencyForRevenue; integer; Currency type used for revenue calculation.
    • CutoffDate; string; End date of the plan horizon.
    • DailyCutoffBucket; number; Numeric value of the daily cutoff bucket.
    • DataCompletionDate; string; Snapshot completion date of the plan.
    • DataStartDate; string; Snapshot start date of the plan.
    • DefaultCalendar; string; Name of the default calendar.
    • DefaultCalendarInstId; integer; Source instance identifier of the default calendar used in planning.
    • DefaultForecastPriority; number; Default priority value for forecasts used by the planning engine to determine when to schedule the forecast.
    • DefaultSalesOrderPriority; number; Contains the default priority value for sales orders and is used by the planning engine to determine when to schedule a sales order.
    • DefaultTaskAttrValueIndicator; integer; Specifies whether there's a default value for the task attribute to use to group data by values of the task attribute for planned orders during release. Valid values are 1 for yes, 2 for null - no.
    • DelRecentOrOldest; integer; Specifies to delete the most recent or the oldest value. 1-keep the most recent or 2-delete the oldest.
    • DeleteArchive; integer; Indicates whether to delete the archived plan data.
    • DemPrioritizationMethod; integer; Method used by supply planning processes to prioritize demands.
    • DemPriorityRuleId; integer; Demand priority rule used by the supply planning processes to prioritize demands.
    • DemandHistoryDays; integer; Sets the historical time range used for loading demand measures in terms of prior days from the plan refresh date.
    • DemandPlanCompletionDate; string; Date and time the demand plan was completed.
    • DemandPlanPriority; integer; Priority of the scheduled process when running a demand plan.
    • DemandPlanStartDate; string; Date and time the demand plan was started.
    • DemandTimeFenceIndicator; number; Specifies whether to enable a demand time fence inside which the planning engine ignores forecast demand and considers only sales order demand when calculating gross requirements.
    • DemandWindowToCalPegging; integer; Time window to calculate the supply and demand pegging. The planning process calculates pegging for all end demands with bucketed due dates that fall on or before the defined time window.
    • Description; string; Description of the plan.
    • DimensionCatalogBicc; integer; Name of the dimension catalog to be extracted.
    • DmCalPlanPercentForecast; number; Specifies whether to generate a statistical forecast for planning percentages from sales history.
    • DmCtoHistoryPeriods; number; Number of history periods to use when calculating planning percentages based on the history of the options.
    • DmIncludeDependentDemand; number; Specifies whether item structure information is considered in demand planning. This must be specified for the configure-to-order functionality.
    • DmPublishCtoByTopLevel; number; Specifies whether to publish aggregate forecasts for all lower level components by their top-level model for use in supply planning. This is relevant where a CTO model, option class, or option level component is shared between multiple top-level models.
    • DmUsePlanPercentType; number; Determines the planning percentage to use when calculating dependent demand.
    • DpLogLevel; integer; Level of detail to be logged when the demand forecasting engine is analyzing data.
    • DqLogLevel; integer; Level of detail to be logged when the demand forecasting engine is loading data from the database.
    • EccConstraintsCutoffDays; integer; Specifies the number of days a resource or supplier capacity is considered as a constraint starting from the planning horizon. Beyond the specified number of days, the capacity is considered unconstrained.
    • EccEnforceResourceCap; integer; Value for enforcing resource capacity constraints.
    • EccEnforceSupCap; integer; Value for enforcing supplier capacity constraints.
    • EisRule; integer; Determines whether the planning process can use end item substitutes to create planned orders.
    • EnableArchive; integer; Indicates whether the measures of the plan can be enabled for archiving.
    • EnableExtractPlanData; integer; Value used for extracting plan data.
    • EnableItemSubstitution; integer; Specifies whether the supply planning process uses end item substitution.
    • EnableMultiThreading; integer; Specifies whether to use multithreading when running a supply plan.
    • EnableWelcomePage; integer; Indicates whether the plan is enabled. Valid values are 1 Enabled and 2 Disabled.
    • EndItemSubstIndicator; integer; Indicates whether the substitute items for the end items should be considered by the planning process.
    • EnforceLtIntransit; integer; Value that determines whether to enforce lead times for in-transit supplies. When enabled, the plan enforces lead time constraints for in-transit supplies. When disabled, the plan compresses lead time constraints for in-transit supplies.
    • EnforceOrderModifiers; integer; Indicates whether the order modifiers should be enforced by the planning process.
    • EnforceSourcingSplits; integer; Specifies whether percentages for rank 1 sources in the sourcing rule are honored during sourcing, subject to all constraints being considered.
    • ExceptionSetId; integer; Specifies a set of exceptions to consider when formulating a plan.
    • ExcessLtMultiplier; integer; Value of the lead time multiplier.
    • ExplodeDepndtDmdMethod; number; Determines whether the item structure will vary by organization or if a global one will be used.
    • ExplodeForecast; number; Indicates whether to explode for cast for models.
    • ExplodeModelForecasts; integer; Specifies whether a top model forecast from demand planning is exploded in supply planning.
    • ExposeToAnalytic; integer; Indicates that the plan is enabled for Oracle Business Intelligence sourced reporting.
    • ExtractMeasureCatalog; integer; Indicates whether to extract the measure catalog in the planning process..
    • ExtractTimeHierarchy; integer; Name of the time hierarchy used to extract plan data.
    • ExtractTimeLevel; integer; Name of the time hierarchy level used to extract plan data.
    • FaLogLevel; integer; Level of detail to be logged when the demand forecasting engine is allocating forecast data.
    • FirmIrTf; number; Specifies whether the supply planning engine creates a natural time fence for an item at the suggested due date (completion) of the latest firm internal requisition.
    • FirmPlannedOrderTf; number; Specifies whether the supply planning engine creates a natural time fence for an item at the suggested due date (completion) of the latest firm planned order.
    • FirstBuckets; number; Number of the first planning buckets of the specified type used in the supply planning process.
    • ForecastCutoffDays; integer; Number of days from the plan start date beyond which the forecasts aren't considered in the planning process.
    • ForecastErrorMeasure; integer; Forecast accuracy measure in the plan used in safety stock calculations.
    • ForecastIndicator; integer; Value that indicates whether to generate the forecast.
    • ForecastMeasure; integer; Forecast measure in the plan used in safety stock calculations.
    • ForecastSpreading; number; Instructs the planning engine to spread a forecast based on the selected calendar type. For example, if Spread Forecast Evenly is selected then demand planned at higher time levels such as weekly or monthly will be spread evenly to daily buckets.
    • ForecastSpreadingCalendar; number; Calendar for spreading an aggregate demand plan forecast across multiple time buckets.
    • ForecastTimeLevel; number; Time level used by the demand forecasting engine profiles.
    • ForecastingCalendar; string; Calendar used by demand forecasting engine profiles.
    • ForwardConsumptionBucket; integer; Number of days that a forecast can be consumed by a sales order after its due date.
    • ForwardDays; number; Number of days. Enables a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of days later than the sales order demand.
    • GlobalFcstCalendar; string; Specifies the calendar used for spreading the global forecast. This is enabled when the plan option Forecast Spreading is set to Spread forecast evenly.
    • GlobalFcstDistrSetId; integer; Specifies the assignment set used to distribute the global forecast to the respective ship-from organizations.
    • GlobalFcstValidOrg; integer; Organization to be referenced for item attributes and bill of materials for forecasts that don't have an organization association.
    • GroupPlannedOrderBy; number; Value of group planned order by.
    • HasRun; number; Indicates whether the plan has already run. Values are Yes (1) or No (2).
    • HorizonForAverageDailyDmd; number; Number of days. Used to calculate the average daily demand measure.
    • HorizonPastDueSupDays; integer; Number of days for which to consider past due supply. For example, a purchase order that's 10 days late won't be considered if the horizon for past due supplies is 7 days.
    • InclDropShipDmdSup; integer; Specifies whether to include drop-ship demands and supplies in the plan.
    • InclPostProcessingLt; number; Specifies whether the supply planning engine includes postprocessing lead time when planning for make orders
    • InclSchldReceiptsCalculate; number; Specifies whether the supply planning engine includes scheduled receipts while calculating an item's use-up date.
    • IncludeInternalSalesOrder; number; Specifies whether internal sales orders are considered to net from forecasts.
    • IncludeItemsWithSstock; integer; Indicates whether the supply planning process plans for safety stock, even if there's no actual demand to ensure that there's stock on hand to support any unexpected demand.
    • IncludeItemsWithSupply; integer; Enables or disables planning items that have only existing supplies but no demand. When enabled, the plan additionally includes items that don't have any type of demands planned in a supply plan but have existing supplies.
    • IncludeLeadTimeAlerts; integer; Lead time insight alerts for a specific plan. Values are Yes(1) for Enable or No(2) for Disable.
    • IncludeProdMonitoringAlrts; integer; Value to enable production monitoring alerts for a specific plan. This is only applicable to Supply plans or to Demand and Supply plans.
    • IncludePtwOrders; integer; Specifies whether to include internal transfer orders when loading sales order history.
    • IncludeSalesOrders; integer; Value that enables fulfillment lines to be considered as demand in order promising.
    • IncludeTransferOrders; integer; Specifies whether to include internal transfer orders when loading sales order history.
    • IncludeWorkOrders; integer; Specifies whether work orders are considered as supplies.
    • IntrlTimesDmdMeasure; integer; Plan measure that indicates whether the demand has an irregular frequency or not.
    • ItemInSubsChain; integer; Specifies whether the demanded item or the highest level item is the item in the substitution chain for which supplies are created during the planning process.
    • ItemListPrice; integer; Item list price used in revenue calculations.
    • LastApprovedBy; string; Name of the user who last approved the plan.
    • LastApprovedDate; string; Date and time of the last approval of the plan.
    • LastPlanRunStartDate; string; Date and time the plan was run last.
    • LastUpdateDate; string; Date and time when a measure update occurred.
    • LastUpdateLogin; string; Header for a column that displays the sign in that the user used most recently to update the corresponding attribute.
    • LastUpdatedBy; string; Header for a column that displays the name of the user who most recently updated the corresponding attribute.
    • LatenessThreshold; number; Value that determines the number of days after the demand due date when the demand is considered satisfied on time for selecting supplies to satisfy the demand.
    • LoadRequisitionGroupBy; number; Indicates the group by option used when loading requisitions using the Planner Workbench form. Values are All, Item, Buyer, Planner, Category, or Location.
    • LoadTransferGroupBy; number; Indicates the group by option used when loading transfers using the Planner Workbench form. Choices include All and a combination of Source ORG Destination ORG, and Scheduled Ship Date.
    • LoadedIndicator; number; Indicates whether the plan loaded. Values are Yes(1) for loaded or No(2) for not loaded.
    • LogGroupBy; string; Indicates the group by method used when logging data for the demand forecasting engine.
    • MatchTopModelFrcstCosmp; integer; Specifies whether the forecast consumption process consumes only the independent forecast. When not specified, both independent forecast and the exploded forecast coming from the parent model are consumed.
    • MaximumPERVarInSsVal; number; Maximum required percentage that triggers smoothing to have a different safety stock quantity from one interval to the next.
    • MaximumPlannedOrders; integer; Maximum number of planned orders that can be generated by the plan.
    • MeasureCatalogBicc; integer; Name of the measure catalog to be extracted.
    • MeasureContextId; integer; Value that uniquely identifies the logical grouping of measures with standard predefined dimensions and planning attribute dimensions used in project-driven supply chain and attribute-based planning.
    • MeasureGroupId; integer; Specifies the group of measures to approve in a plan when the Approve Plan action is selected.
    • MinimumPERVarInSsVal; number; Minimum required percentage that triggers smoothing to have a different safety stock quantity from one interval to the next.
    • MultiechelonIndicator; integer; Value that indicates multiechelon planning is enabled for the replenishment plan.
    • NetMultipleLocalOrg; integer; Value that indicates whether the supply planning process recasts the supplies and demands from the organizations modeled as child organizations to the parent organization modeled via the Manage Planning Source Systems task. This recasting results in netting the supplies and demands across child and parent organizations.
    • NewPlanId; integer; Value used by the copy plan.
    • NewPlanList; string; Indicates list of plans copied from the base plan.
    • ObjectVersionNumber; integer; System change number used in the selective data snapshot to ensure read consistency for all plan data.
    • OverwriteOption; number; Specifies what to overwrite according to the safety stock levels entered or generated previously. Values include All, All except for user-defined, or None.
    • ParameterOverrides; string; Provides a mechanism to change the default planning behavior. It's used, generally only when instructed by Oracle support, to resolve select issues raised as part of a service request or to enable or disable a specific feature.
    • ParentPlanId; integer; Value used internally in code. Parent plan ID of the current plan.
    • PartialBucket; integer; Determines whether the planning process is enabled for creating a partial bucket during the planning process.
    • PastDueDemandBucket; integer; Indicates the source to use to determine whether past due demands are included in the plan. Source options are plan option values or supply network model.
    • PastDueDemandBucketType; integer; Level of time, such as day, week, or month, to use to determine whether to include a past due demand in a plan.
    • PastDueDemandCalendar; string; Calendar to use to determine which past due demands to include in the plan.
    • PastDueForecastBucket; integer; Number of time buckets, such as three weeks or two months. Determines how much earlier than the plan start date to use as a threshold for copying past due forecasts into a plan.
    • PastDueOpenSoBucket; integer; Number of time buckets, such as three weeks or two months. Determines how much earlier than the plan start date to use as a threshold for copying past due open sales orders into a plan.
    • PastDueShippedSoBucket; integer; Number of time buckets, such as three weeks or two months. Determines how much earlier than the plan start date to use as a threshold for copying past due shipped sales orders into a plan.
    • PivotCurrencyCode; string; Central currency that's used for cross-currency rate conversions.
    • PlanApprovalStatus; number; State of a plan in the approval process.
    • PlanCompletionDate; string; Date and start time of the last plan run.
    • PlanDemand; number; Specifies whether to forecast demand when running a plan.
    • PlanDimensionCatalog; integer; Dimension catalog used by the plan.
    • PlanExManufacturerSupplies; integer; Specifies whether to enable organizations for planning external manufacturer supplies.
    • PlanFirstBucket; integer; First bucket type of the plan, for example, Day or Week.
    • PlanHorizonDays; number; Sets the plan time range in terms of days from the plan start date.
    • PlanHorizonStartDate; string; Start date of the planning horizon.
    • PlanId; integer; Name of the plan.
    • PlanMeasureCatalog; integer; Measure catalog used by the plan.
    • PlanMemorySize; integer; Size of the memory used by the plan.
    • PlanOwner; string; User that owns the plan.
    • PlanPercentCalInterval; integer; Value that uniquely identifies the planning percentage history calculation measure.
    • PlanSecondBucket; integer; Second bucket type of the plan, for example, period.
    • PlanSecondBucketName; string; Name of the second planning bucket, which could have day, week, month, or period, used in the supply planning process.
    • PlanStartDate; string; Start date of the plan.
    • PlanSupply; number; Specifies whether to plan supplies when running a plan.
    • PlanTimeLevel; number; Specifies the time level used for aggregate planning.
    • PlanType; number; Type of plan that's being modeled.
    • PlanVersion; integer; Version number of the plan.
    • PlannedItemType; number; Determines which subset of the items that pass the condition imposed by the Planned Items parameter are supply planned.
    • PlannedItems; number; Plan option that specifies what items are planned, for example, demand planned items and all sales orders.
    • PlanningBucketType; number; Indicates the planning bucket type such as Day, Week, or Period.
    • PlanningMode; number; Indicates whether a supply plan is unconstrained or constrained.
    • PlanningTimeFenceIndicator; number; Specifies whether to enable a planning time fence inside which the planning engine may not create planned orders. Use planning time fence control for stability during the initial periods of a plan.
    • PlnPctHistCalMeasure; integer; Specifies the measure to be used when the planning percentage history is calculated.
    • PlnPercentCalLevel; integer; Indicates the planning percentage calculation level.
    • PolicyAssignmentSetId; integer; Indicates the policy assignment set that should be used by the plan. A policy assignment set is a group of policy parameters that are defined for each segment of a segment group.
    • PolicyParametersIndicator; integer; Parameters that are defined for each segment of a segment group. Policies are calculated for item-location combinations on the basis of these policy parameters.
    • PreConForecastBuck; number; Specifies whether to spread forecasts evenly and then consume the forecast if a sales order falls in the same time bucket as the forecast using Backward Days first followed by Forward Days.
    • PrivatePlan; number; Private plan that can be used only by the specified owner.
    • ProductionIndicator; number; Indicates whether the plan is a production plan. Valid values are Yes (1) or No (2).
    • RecalculateDmPriorities; integer; Indicates whether to recalculate demand priorities after spreading. Valid values are Yes (1) or No (2).
    • RecalculateSafetyStock; number; Indicates whether to recalculate safety stock when the plan is run again.
    • ReferencePlanForExecution; integer; Indicates whether a plan can be used as a reference by supply chain fulfillment systems when implementing planning recommendations.
    • RelaxCapacityLtIndicator; number; Indicates whether to relax capacity and lead time constraints. Values are Yes (1) or No (2).
    • ReleaseByUserOnly; number; Specifies whether to restrict implementation of planned orders and recommendations to the current user.
    • ReleaseIndicator; number; Indicates whether to release supply orders. Valid values are Yes (1) or No (2).
    • ReleaseReschedules; number; Specifies whether rescheduled and canceled planned order supplies are released automatically when a plan run completes.
    • ReleaseWIPInClearToBuild; number; Specifies whether the supply planning engine determines if released discrete work orders have all components pegged to on-hand quantity.
    • ReplAggrPlannedOrders; integer; List for specifying whether planned orders created after replenishment planning calculations must be aggregated.
    • ReplIncrPlanningIndicator; integer; Value that indicates whether to enable a plan for incremental planning. Valid values are 1 or 2. If 1, then enable incremental planning. If 2, then disable incremental planning. The default value is 2.
    • ReplInvRebIncldSs; integer; Value that indicates whether to include safety stock in shortages computation. Valid values are 1 or 2. If 1, then include the safety stock. If 2, then don't include the safety stock. The default value is 2.
    • ReplInvRebMoveExcess; integer; Value that indicates whether to move excess inventory to the sweep location. Valid values are 1 or 2. If 1, then move the excess inventory. If 2, then don't move the excess inventory. The default value is 1.
    • ReplInvRebPartials; integer; Value that indicates whether to create partial orders from the source location that doesn't have enough inventory to meet the entire destination location shortages. Valid values are 1 or 2. If 1, then don't create partial orders. If 2, then create partial orders. The default value is 1.
    • ReplInvRebalanceIndicator; integer; Value that indicates whether to perform inventory rebalancing. Valid values are 1 or 2. If 1, then perform inventory rebalancing. If 2, then don't perform inventory rebalancing. The default value is 2.
    • ReplLeadTimeMultiplier; integer; Value that the item lead time is multiplied by to calculate the lead time window within which all demands are considered.
    • ReplPolicyCOMPIndicator; integer; Value that indicates whether to enable a plan for policy comparison. Valid values are 1 or 2. If 1, then enable the plan for policy comparison. If 2, then disable the plan for policy comparison. The default value is 2.
    • ReplRetainPolicyOverrides; integer; Value that indicates whether to retain existing policy overrides.
    • ReplSupplyCutoffDays; integer; Number of days after the plan end date during which the existing supplies are considered. The default value is 0.
    • ReplThresholdComparison; integer; Percent value of the threshold used in policy comparison.
    • ReplTimeHorizon; integer; Value that indicates the horizon within which the demand is considered. Valid values are 1: item lead time, or 2: none. The default value is 2.
    • ReplenishmentsIndicator; integer; Contains one of the following values: true or false. If true, then calculate replenishments. If false, then don't calculate replenishments. The default value is true.
    • RespResourceAssignIndicator; integer; Value that the constrained plan considers to assign resource units specified in the work definition. This option is enabled only for constrained supply plans.
    • SOPDemandMeasureLoaded; integer; Indicates whether to load a forecast measure from a demand plan or a demand and supply plan to the target measure in a sales and operations plan.
    • SOPDemandPlanLoaded; integer; Name of the demand plan or the demand and supply plan that will be the source of the forecast measure to load measure data into a sales and operations plan.
    • SafetyStockForecastError; number; Forecast accuracy measure in the plan used in safety stock calculations.
    • SafetyStockOverwriteIndicator; number; Used to specify what to overwrite regarding the safety stock levels entered or generated previously. Choices include All, All except for user-defined, or None.
    • SafetyStockPlanningMethod; number; Planning method to use for safety stock levels.
    • SafetyStockServiceLevel; number; Used to set the desired level of customer service in satisfying product demand. This represents the probability that an order can be filled from available inventory.
    • SaveToCollData; integer; Specifies whether collected data is updated with the calculated safety stock quantities.
    • SaveToDb; number; Indicates whether the plan is saved to database. Valid values are Yes(1) or No (2).
    • SavedIndicator; number; Indicates whether the plan is saved. Valid values are Yes (1) or No (2).
    • ScheduleBy; integer; Option to provide different scheduling options to the user. This plan option has two values, Schedule Ship Date (1) and Request Ship Date (2). The default value is 1.
    • SecondBuckets; number; Number of the second planning buckets of the specified type used in the supply planning process.
    • SegmentGroupId; integer; Uniquely identifies the segment group.
    • SelectiveSnapshotSequence; number; Value that indicates whether to report resource requirements by assembly. Valid values are 1 (Yes) and 2 (No).
    • SelfInputSchedule; number; Indicates whether same plan can be included as the demand schedule. Applies to sales and operations plans.
    • ShortPlanId; integer; Value used for creating plan partitions.
    • ShowAnomalies; integer; Enables or disables anomalies.
    • SimulationSetId; integer; Name of the simulation set used by the plan.
    • SmMethodToCalSsInterval; number; Raw safety stock quantities that are smoothed in every interval using the selected method starting from the plan horizon.
    • SopAddPastDueSo; integer; Considers past due sales orders after the first time bucket is netted.
    • SopAllowResourceCapOverload; integer; Indicates whether the resource capacity can be overloaded.
    • SopAllowSupCapOverload; integer; Indicates whether the supplier capacity can be overloaded.
    • SopBottleneckResourceIndicator; number; Uniquely identifies the bottleneck resource.
    • SopCalculateBorIndicator; number; Indicates whether the bill of resources should be calculated.
    • SopCustomerHierarchy; integer; Identifies the customer level hierarchy. The levels are Customer or Customer-Site.
    • SopCustomerLevel; integer; Customer dimension level used for aggregate planning.
    • SopDeclRACMultiplier; number; Multiplier by which the penalty cost for building inventory earlier than required is calculated. If the multiplier is set to a high value, the penalty cost for early inventory builds is high.
    • SopDecliningStorageCost; integer; Determines whether to use storage costs that decline over the plan horizon. Contains one of the following values: 1 or 2. If 1, then use storage costs that decline over the plan horizon. If 2, then use the same storage cost over the plan horizon. The default value is 1.
    • SopDemPCMultiplier; number; Holds the sales and operations planning demand backordering penalty cost multiplier to tune the penalty cost of demand backordering.
    • SopDemandTargetMeasure; integer; Specifies which target measure should be used for copying from the demand plan.
    • SopIgnoreLeadTimeIndicator; number; Identifies whether the lead time should be ignored. The valid values are Yes or No.
    • SopIntransitExtractionLoc; integer; Value used to configure sales and operations planning to report the in-transit measure value in the destination organization instead of the source organization.
    • SopLoadFromDemandPlan; integer; Indicates whether to load a forecast measure from a demand plan or a demand and supply plan to the shipments forecast measure in a sales and operations plan.
    • SopManufactureOffset; integer; Indicates whether item processing lead time is used to offset the production start time of an assembly item in a sales and operations plan.
    • SopMaximumSourcingRuleRank; integer; Identifies the highest sourcing rule rank to be considered in a sales and operations plan. The range of values is 1 through 99. 1 means null.
    • SopPlanAnchorDate; string; Plan start date that's before the current date and within the first time bucket.
    • SopPlanResourceLevel; integer; Indicates the resource capacity level. Values 0 is Resource and 1 is Work Center.
    • SopProductHierarchy; integer; Product dimension hierarchy used for aggregate planning.
    • SopProductLevel; integer; Product dimension level used for aggregate planning.
    • SopReportResourceRequirement; integer; Value that indicates whether to report resource requirements by assembly. Valid values are 1 (Yes) and 2 (No).
    • SopSrcAllocPctMultiplier; number; Supplier capacity overloading penalty cost multiplier to tune the penalty cost of the sourcing split.
    • SopSupCatCapPCMultiplier; number; Resource capacity overloading penalty cost multiplier to tune the penalty cost of the resource capacity.
    • SopWcCapPCMultiplier; number; Supplier capacity overloading penalty cost multiplier to tune the penalty cost of the supplier category capacity.
    • SourceSystem; string; Identifies the source system for the search function.
    • SourceSystemId; integer; Uniquely identifies the source system.
    • SourcingAllocationWindow; integer; Numeric value of the sourcing allocation window in days. The rolling window at the end of which any violation in sourcing split percentages is reported as an exception.
    • SourcingSplitPercent; number; Indicates the allowable deviation from specified split percentages for rank 1 sources.
    • SpPolicyAssignmentSetId; integer; Indicates which set of segment level parameters should be used. For example, the safety stock service level at the segment level.
    • SsBuckStartOffsetDays; number; Offsets the start date of the safety stock bucket from the current date to ignore the impacts of high near-term demand that's possible due to backlog demand.
    • SsChngeIntervalDays; number; Number of working days in the interval for smoothing safety stock.
    • SsChngeToMRPPlanned; integer; Specifies whether the safety stock quantities are smoothed for all items, including items that have safety stock method set to not MRP planned, or only items that have safety stock method set to Days of Cover.
    • SsForecastPlan; integer; Identifies the forecast that should be used for calculating safety stock.
    • SsqOverride; integer; Indicates whether the safety stock can be overridden. The valid values are Yes or No.
    • StatisticalLogLevel; integer; Level of detail to be logged when the demand forecasting engine generates a statistical forecast.
    • Status; number; Status of the entity.
    • SubinventoryPlanningIndicator; integer; Indicates whether to enable planning at the subinventory level.
    • SubstCOMPIndicator; integer; Specifies the order of precedence when using existing supplies of a primary or substitute component.
    • SubstitutionDesignator; string; Indicates whether plan can use substitution items.
    • SubstitutionSetId; integer; Unique name of a set of substitution relationships defined to be effective for a plan. This enables you to run simulations of substitutions and evaluate possible, future substitutions.
    • SupCapConstraintsIndicator; integer; Determines whether the planning process applies supplier capacity as a constraint when creating planned orders to buy items from a supplier.
    • SupplierCapConstraints; integer; Specifies whether the planning process applies supplier capacity constraints when creating planned orders to buy items from a supplier or infinite supplier capacity is assumed.
    • SupplierCapMultiplier; number; Number to multiply the supplier item processing lead time to set the date to begin accumulating supplier capacity.
    • SupplyParameterOverrides; string; List of parameters to override and the new value to apply for each of them. Used to specify what to override in the profile settings used by the demand forecasting engine.
    • SupplyScheduleIndicator; integer; Plan parameter that indicates whether the replenishment plan considers supply schedules. Valid values are 1 (Yes) and 2 (No). Null indicates No.
    • TimeWindowsForNetSequence; integer; Number of days to be considered to create a netting sequence time window in a plan up to the plan horizon.
    • UnfirmInTransitSupply; integer; Determines whether to treat in-transit supplies as firm supplies. If this attribute is selected, then the plan considers all in-transit supplies as firm. If this attribute isn't selected then the plan can reschedule in-transit supplies when needed.
    • UseBaseModelInConsumption; number; Use base model in forecast consumption. The possible values are Yes or No.
    • UseCalPlanPercent; integer; Specifies whether the planning percentages used for the forecast explosion process in supply planning are from demand planning or from Oracle Fusion Product Model. The valid values are Yes or No.
    • UseItemSpecificValues; integer; Specifies whether to use the values specified for items instead of providing values for parameters. The valid values are Yes or No.
    • UseModelSpecificPlanPercent; integer; Specifies whether to use model-specific planning percentages for options in an option class to calculate dependent demand. 1 indicates yes, that's honoring model-specific planning percentages for options, and null or 2 indicates not honoring model-specific planning percentages.
    • UseSameCal; integer; Indicates whether the forecasting calendar is to be used for supply planning. The valid values are Yes or No.
    • WorkAreaType; integer; Value that indicates the work area type of the plan.
  • 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 : planOptions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planOptions-item-response
Type: object
Show Source
Nested Schema : Aggregate Plan Profiles
Type: array
Title: Aggregate Plan Profiles
Specifications such as the maximum number of records displayed in the table or the maximum number of root nodes in pegging mode. By limiting the number of records or pegging modes, the user can analyze the plan output easily and efficiently.
Show Source
Nested Schema : Plan Access
Type: array
Title: Plan Access
The access type of a plan, public or private. The public access makes the plan accessible to all users. The Private access restricts the plan accessibility to specific users.
Show Source
Nested Schema : Plan Advanced Options
Type: array
Title: Plan Advanced Options
Options used for creating supplies and demands, such as pegging parameters and demand cutoff parameters.
Show Source
Nested Schema : Plan Cluster Demand and Supply
Type: array
Title: Plan Cluster Demand and Supply
The clusters that hold the demand and supply order types to use for inventory rebalancing calculation for the plan.
Show Source
Nested Schema : Plan Clusters
Type: array
Title: Plan Clusters
The clusters included in a replenishment plan for inventory rebalancing.
Show Source
Nested Schema : Plan Dimension Filters
Type: array
Title: Plan Dimension Filters
List of all filters for a plan that the user can add for organization and product dimensions. The levels on which filters can be defined are organizations, categories, suppliers, and customers.
Show Source
Nested Schema : Plan Forecast Profiles
Type: array
Title: Plan Forecast Profiles
Options used in the forecasting process in the plan run.
Show Source
Nested Schema : Plan Optional Dimensions
Type: array
Title: Plan Optional Dimensions
Collection of dimensions in the dimension catalog that are used to enable advanced plan options.
Show Source
Nested Schema : Plan Organizations
Type: array
Title: Plan Organizations
The plan organizations specified in the plan options used in the supply planning process that generates supplies for the organizations, if needed.
Show Source
Nested Schema : Plan Output Measures
Type: array
Title: Plan Output Measures
The plan output measures attached to the measure catalog specified in the plan options such as Projected Available Balance and Revenue. These measures are generated by the supply planning process as part of the plan output, and they're used for analyzing the plan output.
Show Source
Nested Schema : Plan Price Lists
Type: array
Title: Plan Price Lists
Price lists for the plan that the user can select to determine the prices of items planned by the supply plan.
Show Source
Nested Schema : Plan Schedules
Type: array
Title: Plan Schedules
Specified demand schedules that serve as the demands for the supply plan. If the plan type is demand and supply, the demand schedule is automatically included in the supply plan. The supported types of demand schedules are Demand, External, and Production.
Show Source
Nested Schema : Plan Segments
Type: array
Title: Plan Segments
Segments of a plan of the items specified in the plan options used by the supply planning process. Segmentation is the process of grouping on the basis of user-defined, static, or dynamic attributes. In Oracle Fusion Cloud Supply Planning, these combinations can include items, organizations, customers, and demand classes. For example, user can use segments in supply planning to view data and perform drills in tables and graphs by segments.
Show Source
Nested Schema : planOptions-MscAggrPlanProfileInPlan-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanAccess-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanAdvancedOptions-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the plan advanced options.
  • Read Only: true
    Date when the plan advanced options was originally created.
  • Read Only: true
    Date when the user most recently updated the plan advanced options.
  • Read Only: true
    Maximum Length: 64
    User who performed the most recent update on the plan advanced options.
  • Read Only: true
    Maximum Length: 32
    Last time the user logged into the system.
  • Links
  • Determines the maximum number of groups into which all planned items must be divided by the solution engine. The calculations the engine performs plan supplies for the items in each group.
  • Maximum Length: 512
    Determines the settings for each thread after the items in a supply chain are split into threads to obtain an optimized solution.
  • Limits the numeric error in the solution algorithm using an industry standard called Markowitz Tolerance. Larger values typically reduce the error introduced in the algorithm.
  • Specifies the number of groups per thread to be used when plan decomposition is enabled in a constrained plan.
  • Determines the number of threads into which the items in a plan are split. Items across threads can't be part of the same supply chain.
  • Specifies the number of threads into which items in a supply chain need to be divided. The engine calculations then assign an algorithm to each thread, and the thread with the fastest solution is selected.
  • Plan version number.
  • Unique identifier of the parameter.
  • Uniquely identifies the plan.
  • Optimizes the size of the problem before the start of the solution process. Larger values typically mean greater problem complexity.
  • Determines the extent to which the solution model is scaled. Larger values typically reduce solution times but may also lead to larger constraint violations.
  • Specifies the tolerance to which a solution should conform using an industry standard called Simplex Feasibility Tolerance. Tightening this tolerance can produce smaller constraint violations but may also lead to more iterations in the search for the solution.
Nested Schema : planOptions-PlanClusterDmdSup-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanClusters-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanDimensionFilter-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanForecastProfile-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanOptionalDimensions-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanOrganization-item-response
Type: object
Show Source
Nested Schema : Subinventories
Type: array
Title: Subinventories
The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.
Show Source
Nested Schema : planOptions-PlanOrganization-SubInventory-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanOutputMeasure-item-response
Type: object
Show Source
Nested Schema : Plan Output Measure Levels
Type: array
Title: Plan Output Measure Levels
The plan output measure levels reported by the plan such as Projected Available Balance and Revenue. The plan output measure levels provide values of a measure at a granular or summarized level . For example, the measure level for the Time dimension in a Gregorian calendar could be: Day, Month, Quarter, and Year.
Show Source
Nested Schema : planOptions-PlanOutputMeasure-PlanOutputMeasureLevel-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanPriceList-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanSchedule-item-response
Type: object
Show Source
Nested Schema : Forecast Constrained Planning Attributes
Type: array
Title: Forecast Constrained Planning Attributes
The attributes for a demand schedule attached to a plan. User can enable or disable these attributes for forecast consumption by the demand schedules attached to the plan. These attributes, such as Backward Days and Forward Days, determine the range of days from the forecast demand date that the forecast can be consumed in that range by sales orders.
Show Source
Nested Schema : Plan Schedule Measure Levels
Type: array
Title: Plan Schedule Measure Levels
The plan schedule measure levels specified for a demand schedule in the plan options. In supply planning, dimensions such as time can have multiple measure levels. Users can specify measure levels for these dimensions: Time, Demand Class, Customer, Organization, and Product. For example the level for Time could be Day, the level for Customer could be Customer Site, and the level for Product could be Item. On the other hand, the level for organization is fixed as Organization and the level for demand class is only Demand Class.
Show Source
Nested Schema : planOptions-PlanSchedule-FcstConstPlanningAttr-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanSchedule-PlanScheduleMeasureLevel-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanSegments-item-response
Type: object
Show Source
Back to Top