Get all plans
get
/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans
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 Find the demand and supply plan according to the value that identifies the plan.
Finder Variables- PlanId; integer; Value that uniquely identifies the plan.
- PrimaryKey Find the demand and supply plan according to the value that identifies the plan.
-
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:- AggregateNonkeyCustomerData; integer; Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data.
- AltItemWorkDefOption; integer; Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative item structure or alternative work definition to create each planned order. If 2, then don't allow alternatives.
- AltSupSourceOrgOption; integer; Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative supplier or source organization to create each planned order. If 2, then don't allow alternatives.
- AppliesToOrderTypes; string; List of demand order types to which the NumberOfDaysForDemandCutoff attribute applies. A comma separates each value. Valid values are 1029: Forecast, 1030: Sales order, and 1008: Manual demand. If the value is null, then no order types are considered for demand cutoff. The default value is null. This attribute is only used if the NumberOfDaysForDemandCutoff attribute is populated.
- ApplyPolicyOverrides; integer; Contains one of the following values: 1 or 2. If 1, then calculate the safety stock for an item and organization combination using policy level overrides. If 2, then don't use policy level overrides when calculating the safety stock. The default value is 2.
- ArchivePlan; integer; Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. Note that you can archive the plan only if you enable it for archiving. If 2, then don't archive.
- ArchiveTimeHierarchy; integer; Time hierarchy that the application uses to archive the plan.
- ArchiveTimeLevel; integer; Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
- ArchiveVersionDays; integer; Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.
- AutoRelease; integer; Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
- AverageInterarrivalTime; integer; This attribute isn't currently used.
- BackwardConsumptionBucket; integer; Number of time buckets, such as three weeks or two months. This attribute allows a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of time buckets earlier than the sales order demand.
- BackwardDays; number; Number of days that sales order demand can consume from forecast demand. Sales order demand will consume forecast demand that occurs before sales order demand even if forecast demand already consumed the days that Backward Days specifies.
- CalSsQuantEndItems; integer; Contains one of the following values: 1 or 2. If 1, then calculate a new safety stock level for each end item when running the plan. If 2, then don't do this calculation.
- CalendarCode; string; Abbreviation that identifies the supply planning calendar.
- CapacityConstrainedResources; integer; Contains one of the following values: 1 or 2. If 1, then apply capacity constraints on all resources. If 2, then apply capacity constraints only on bottleneck resources. A list of accepted values is defined in the lookup type ORA_MSC_CAP_CONST_RESOURCES.
- ComponentSubstitutionLogic; integer; This attribute isn't currently used.
- CompressionDaysTolerance; number; Number of compression days that the application can use to release each planned order.
- ConSupplierCapPurOrders; integer; Contains one of the following values: 1 or 2. If 1, then allow each purchase order to consume supplier capacity. If 2, then don't allow.
- ConsumeByForecastBucket; integer; Contains one of the following values: 1 or 2. If 1, then keep the consumption process inside of the consumption bucket for each forecast or sales order. If 2, then don't keep it inside the bucket.
- ConsumeForecastWithNoDc; integer; Specifies the sequence the forecast consumption process uses to consume forecast entries when some entries reference a demand class and others don't reference a demand class. Contains one of the following values. 1: consume each forecast entry in each bucket. 2: consume demand for each forecast, and then consume each forecast entry in each bucket.
- ConsumeForecastWithinDtf; integer; Contains one of the following values: 1 or 2. If 1, then consume forecast entries before applying the demand time fence. Consume forecast entries within the time fence for consumption but not for demand. If 2, then apply the demand time fence before consuming forecast entries. Consume forecast entries within the time fence for demand, not consumption. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
- ConsumeWithInternalOrders; integer; This attribute isn't currently used.
- ConsumptionBucketType; integer; Level of time to use when consuming the forecast such as day, week, or month.
- ConsumptionCalendar; string; Calendar to use when consuming the forecast.
- ConsumptionDtlsCutoffDays; integer; Number of days after the plan start date when consumption details will be written. Consumption detail records are written for sales orders and transfer order demands that have a due date before the plan start date plus theses number of days after the plan start date.
- CreateTimeFence; integer; Contains one of the following values: 1 or 2. If 1, then supply planning creates a time fence for each item. It creates this time fence on completion due date of the supply for the most recent job, purchase order, flow schedule, or shipment. If 2, then don't create a time fence. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
- CreatedBy; string; User who created the plan.
- CreationDate; string; Date when the user created the plan.
- CriticalResourceSupplier; integer; Contains one of the following values: 1 or 2. If 1, then the plan enforces resource and supplier capacity constraints only for critical resources and item suppliers in constrained plans. If 2, then it enforces resources and supplier capacity constraints for bottleneck resources and all item suppliers.
- CutoffDate; string; End date of the planning horizon when planning no longer plans demand or supply.
- DateUsedToPlanSalesOrders; integer; Date used when planning sales orders. A list of accepted values is defined in the lookup type ORA_MSC_SCHEDULE_DEMANDS_BY.
- DefaultForecastPriority; integer; This attribute isn't currently used.
- DefaultSalesOrderPriority; integer; This attribute isn't currently used.
- DeleteArchive; integer; Contains one of the following values: 1 or 2. If 1, then delete the plan archive during the next plan run. If 2, then don't delete.
- DemandHistoryDays; integer; Number of days of historical demand data to load into the plan, starting with the plan refresh date. For example, if Demand History Days is 10, and if the plan refresh date is March 30, then load historical demand data from March 30 to March 20.
- DemandPlanCompletionDate; string; Date and time when demand planning finished running the plan.
- DemandPlanPriority; integer; Priority of the scheduled process when running a demand plan.
- DemandPlanStartDate; string; Date and time when demand planning started running the plan.
- DemandPrioritizationMethod; integer; This attribute isn't currently used.
- DemandPriorityRule; integer; This attribute isn't currently used.
- DemandSchedules; string; Collection of demand schedules that the scope of the plan includes. A comma separates each value. Values include Demand Schedule Name, Description, Demand Schedule Type, Demand Plan Output Measure, and Ship to Consumption Level. A set of parentheses encloses each set of demand schedules.
- DemandTimeFenceControl; integer; Contains one of the following values: 1 or 2. If 1, then use a demand time fence. Ignore forecast demand and consider only sales order demand when calculating the demand requirement. If 2, then don't use a demand time fence. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
- Description; string; Description of the plan.
- DmCtoHistoryPeriods; integer; Number of history periods used when calculating planning percentage according to the history of the configure options. Applies only when planning a configured item.
- DontConsiderInTransitSupplyAsFirm; integer; Contains one of the following values: 1 or 2. If 1, then in-transit supplies aren't treated as firmed supplies. If 2, then in-transit supplies are treated as firmed supplies. The default value is 2.
- EnableArchive; integer; Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures.
- EnableEndItemSubstitution; integer; Contains one of the following values: 1 or 2. If 1, then allow planning to substitute each end item when planning supply. If 2, then don't allow.
- EnableMultiThreading; integer; Contains one of the following values: 1 or 2. If 1, then use multithreading when planning supply. If 2, then don't use multithreading.
- EnableWelcomePage; integer; Contains one of the following values: 1 or 2. If 1, then make the plan available as a source of data for an infolet. If 2, then don't make the plan available.
- EnforceLeadTimeInTransit; integer; Contains one of the following values: 1 or 2. If 1, then the plan enforces lead time constraints for in-transit supplies. If 2, then the plan can compress lead time constraints for in-transit supplies.
- EnforceResourceCapConstr; integer; Contains one of the following values: 1 or 2. If 1, then the plan enforces resource capacity constraints in constrained plans and doesn't overload the resource. If 2, then the plan can overload the resource.
- EnforceSupplierCapConstr; integer; Contains one of the following values: 1 or 2. If 1, then the plan enforces supplier capacity constraints in constrained plans and doesn't overload the supplier capacity. If 2, then the plan can overload the supplier capacity.
- ExceptionSet; integer; Exception set that the plan references. The exception set determines the exception types that the plan creates.
- ExplodeDepndtDmdMethod; integer; This attribute isn't currently used.
- ExplodeModelForecasts; integer; Contains one of the following values: 1 or 2. If 1, then expand the highest level forecast from demand planning when planning supply. If 2, then don't expand.
- ExposeToAnalytic; integer; Contains one of the following values: 1 or 2. If 1, then use the plan in business intelligence reporting. If 2, then don't use.
- FirmIrTf; integer; This attribute isn't currently used.
- FirmPlannedOrderTf; integer; Contains one of the following values: 1 or 2. If 1, then create a time fence for each item that the firmed, planned order references. Create a time fence according to the completion due date of the most recent, firmed, planned order. If 2, then don't create the time fence according to the firmed, planned order.
- FirstPlanningBucketCode; integer; Abbreviation that identifies the time bucket type for the first set of supply planning buckets. Valid values vary based on the supply planning calendar type. If the supply planning calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the supply planning calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the supply planning calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
- FirstPlanningBucketName; string; Meaning associated with the FirstPlanningBucketCode attribute.
- FirstPlanningBucketNumber; number; Number of supply planning buckets to create for the first set of supply planning time buckets. For example, if the FirstPlanningBucketName attribute is Day, this would be the number of daily supply planning buckets that are created when the plan is run.
- ForecastError; integer; Forecast accuracy measure that the plan uses to calculate safety stock. Contains one of the following values. 1: Mean Absolute Deviation, 2: Mean Absolute Percentage Error, or 3: intermittent. A list of accepted values is defined in the lookup type ORA_MSC_FORECAST_ERROR_TYPE.
- ForecastProfiles; string; List of forecast profiles that the plan uses. A comma separates each value. Values display in the following sequence: Forecast Profile name, Input Measure, Output Measure, Analysis Set, Historical Buckets, History Start Date, History End Date, Forecast Buckets, Locked Forecast Periods, and Forecast End Date. A set of parentheses encloses each set of forecast profiles.
- ForecastTimeLevel; integer; Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
- ForecastTimeLevelName; string; Meaning associated with the ForecastTimeLevel attribute.
- ForecastingCalendar; string; Calendar that the forecast uses to forecast demand.
- ForecastingCalendarName; string; Name of the calendar that the forecast uses to forecast demand.
- ForwardConsumptionBucket; integer; Number of time buckets, such as three weeks or two months. This attribute allows a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of time buckets later than the sales order demand.
- ForwardDays; number; Number of days that sales order demand can consume from forecast demand. Sales order demand will consume forecast demand that occurs after sales order demand even if forecast demand already consumed the days that Forward Days specifies.
- GlobalFcstValidOrg; integer; This attribute isn't currently used.
- GroupPlannedOrders; integer; This attribute isn't currently used.
- HasRun; integer; Contains one of the following values. 1: the most recent plan run finished successfully, or 0: the most recent plan run failed, or Empty: the application hasn't run the plan.
- HorizonForAverageDemand; number; Number of days that planning uses to calculate average daily demand.
- InclDropShipDmdSup; integer; Contains one of the following values: 1 or 2. If 1, then include drop-ship demand and supply in the plan. If 2, then don't include.
- IncludeDependentDemand; integer; Contains one of the following values: 1 or 2. If 1, then include configure options when planning demand. If 2, then don't include these options. This attribute applies only when planning demand for a configured item.
- IncludeItemsWithSafetyStock; integer; Contains one of the following values: 1 or 2. If 1, then items with no demand other than safety stock are included in the plan. If 2, then items with no demand other than safety stock aren't included in the plan.
- IncludeItemsWithSupplyButNoDemand; integer; Contains one of the following values: 1 or 2. If 1, then items with existing supplies, but no demands planned in the supply plan are also included in the plan. If 2, then items with existing supplies, but no demands aren't included in the plan. The default value is 2.
- IncludeProdMonitoringAlrts; integer; Contains one of the following values: 1 or 2. If 1, then the plan is enabled for production monitoring alerts. If 2, then the plan doesn't provide production monitoring alerts.
- IncludeTransferOrders; integer; Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.
- ItemListPrice; integer; This attribute isn't currently used.
- LastUpdatedBy; string; User who performed the most recent update on the plan.
- LastUpdatedDate; string; Date when the user most recently updated the plan.
- LatenessThreshold; integer; This attribute isn't currently used.
- LoadedOption; integer; Contains one of the following values: 1 or 2. If 1, then the application loaded the plan into memory. If 2, then the application didn't load the plan into memory.
- MatchTopModelFrcstCosmp; integer; This attribute isn't currently used.
- MaximumVarSafetyStockValue; number; Maximum percent difference to allow between the safety stock quantity in one interval and the next interval.
- MeasureCatalogForArchival; string; Measure catalog that the application uses to archive the plan.
- MinimumVarSafetyStockValue; number; Minimum percent difference to allow between the safety stock quantity in one interval and the next interval.
- NumberOfDaysForDemandCutoff; integer; The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value.
- OrderModifierStartQuantity; integer; This attribute isn't currently used.
- Organizations; string; Collection of organization names and descriptions that the scope of the plan includes. A comma separates the organization name from the description. A set of parentheses encloses each organization name and description.
- OverwriteOption; integer; Contains one of the following values: 1 or 2. If 1, then keep all firmed, planned orders between planning runs. If 2, then don't keep firmed, planned orders between planning runs. A list of accepted values is defined in the lookup type ORA_MSC_OW_FIRM_PLANNED_ORDRS.
- OverwriteSafetyStock; integer; Safety stock levels that planning can override when the plan runs. Contains one of the following values. 1: all, 2: all except for user defined, or 3: none. A list of accepted values is defined in the lookup type MSC_SAFETY_OVERWRITE.
- ParameterOverrides; string; List of parameters to override and the new value to apply for each parameter. These parameters determine what to override in the profile settings that the demand forecast uses. The following format is used: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter.
- PastDueDemandBucket; integer; Number of time buckets, such as three weeks or two months. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due demands into a plan.
- PastDueDemandBucketType; integer; Level of time to use to determine whether to include a past due demand in a plan such as day, week, or month.
- 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. This attribute determines the time period 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. This attribute determines the time period 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. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due shipped sales orders into a plan.
- PlanCompletionDate; string; Date and time when supply planning finished running the plan.
- PlanDemand; integer; Contains one of the following values: 1 or 2. If 1, then run demand planning when running a plan. If 2, then don't run demand planning.
- PlanDimensionCatalog; integer; Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
- PlanHorizonDays; integer; Number of days that the plan considers, starting from the plan start date and proceeding forward in time.
- PlanHorizonStartDate; string; Date when the plan starts planning demand and supply.
- PlanId; integer; Value that uniquely identifies the plan.
- PlanItemLevelMembers; string; List of level values in the item hierarchy to include in the scope of the plan. A comma separates each value.
- PlanMeasureCatalog; string; Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
- PlanName; string; Name of the plan.
- PlanOrganizationLevelMembers; string; List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
- PlanOwner; string; Name of the user who owns the plan.
- PlanStartDate; string; Date and time when supply planning started running the plan.
- PlanStatus; integer; Status of the plan run that most recently completed. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.
- PlanSupply; integer; Contains one of the following values: 1 or 2. If 1, then run supply planning when running a plan. If 2, then don't run supply planning.
- PlanType; integer; Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.
- PlannedItemType; integer; Type of item that supply planning plans. Contains one of the following values. 1: Manufacturing Plan, or 2: Production Plan. You can use attribute Supply Planned Item Type with attribute Planning Method of the item to identify supply planned items from a subset of the items that pass the condition that the Supply Planned Items attribute imposes. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_ITEM_TYPE.
- PlanningBucketType; integer; Time bucket that each forecast demand uses. Values include day, week, or period.
- PlanningMode; integer; Contains one of the following values: 1 or 2. If 1, then constrain supply planning. If 2, then don't constrain. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE.
- PlanningTimeFenceControl; integer; Contains one of the following values: 1 or 2. If 1, then don't create planned orders within the planning time fence. If 2, then create planned orders.
- PlnPctHistCalMeasure; integer; Measure that planning uses to calculate planning percentage history. Contains one of the following values. 1788: option bookings history, or 1789: option shipments history.
- PlnPercentCalLevel; integer; Planning hierarchy level to use when calculating planning percentage according to history. Contains one of the following values. 1: item and organization, 2: item, or 3: item, organization, and demand class. A list of accepted values is defined in the lookup type ORA_MSC_PLN_PERCENT_CAL_LEVEL. Applies only with a configured item.
- PolicyAssignmentSet; string; Name of the policy assignment set used in calculating the safety stock. Only applicable when the ApplyPolicyOverrides attribute is 1.
- PriceLists; string; List of price lists to consider in the plan. A comma separates each value.
- PrivatePlan; integer; Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS.
- RecalculateSafetyStock; integer; Contains one of the following values: 1 or 2. If 1, then recalculate safety stock quantity the next time the plan runs. If 2, then don't recalculate.
- RequisitionLoadGroupBy; integer; Group-by option to use when releasing a planned buy order. Contains one of the following values. 1: all, 2: item, 3: buyer, 4: planner, 5: supplier, 7: category, or 8: location. A list of accepted values is defined in the lookup type ORA_MSC_REQ_LOAD_GROUP_OPT.
- SafetyStockChangeToAll; integer; Contains one of the following values: 1 or 2. If 1, then smooth safety stock quantity for each item, including items that use the Not MRP Planned safety stock method. If 2, then smooth safety stock quantity for each item that uses the Days of Cover safety stock method.
- SafetyStockForecastPlan; string; Demand plan that contains the forecast and forecast error measures that the plan uses to calculate safety stock.
- SafetyStockPlanningMethod; integer; Method that planning uses to calculate safety stock levels. A list of accepted values is defined in the lookup type ORA_MSC_SS_PLANNING_METHD.
- SafetyStockSaveToSimSet; integer; This attribute isn't currently used.
- SafetyStockServiceLevel; number; Percent that planning uses to calculate safety stock. It uses the mean absolute deviation method to determine the probability whether planning can fill each sales order from inventory that's currently available.
- SaveToCollectedData; integer; Contains one of the following values: 1 or 2. If 1, then use the quantity of the calculated safety stock to update collected data. If 2, then don't update collected data.
- SecondPlanningBucketCode; integer; Abbreviation that identifies the time bucket type for the second set of supply planning buckets. Valid values vary based on the supply planning calendar type. If the supply planning calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the supply planning calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the supply planning calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
- SecondPlanningBucketName; string; Meaning associated with the SecondPlanningBucketCode attribute.
- SecondPlanningBucketNumber; number; Number of supply planning buckets to create for the second set of supply planning time buckets. For example, if the SecondPlanningBucketName attribute is Week, this would be the number of weekly supply planning buckets created when the plan is run.
- ShortPlanId; integer; Short value that identifies the plan.
- SimulationSet; integer; Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.
- SmMethodToCalSsInterval; integer; Method that the plan uses to calculate safety stock quantity. Contains one of the following values. 1: minimum, 2: average, or 3: maximum. A list of accepted values is defined in the lookup type ORA_MSC_SM_MTHD_CAL_SS. The plan smooths safety stock quantities in each interval that uses the method you specify, starting from the plan horizon.
- SourcingAllocationWindow; integer; This attribute isn't currently used.
- SourcingSplitPercent; integer; This attribute isn't currently used.
- SsBuckStartOffsetDays; number; Number of days that the plan offsets the start date of the safety stock bucket, starting with the current date. You can use this attribute to ignore the impacts of high, near-term demand that might occur because of backlog demand.
- SsChngeIntervalDays; number; Number of working days to use in the interval when smoothing safety stock.
- SupplyParameterOverrides; string; List of parameters to override and the new value to apply for each parameter. These parameters determine what to override in the profile settings that the demand forecast uses. The following format is used: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter.
- SupplyPlannedItems; integer; Specify items to plan during supply planning. Contains one of the following values. 1: all items, 2: demand planned items and sales orders, 5: demand planned items and work-in-process components, 6: demand planned items, or 7: demand planned items, work-in-process components, and sales orders. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_ITEMS.
- SupplyPlanningCalendar; string; Name associated with the supply planning calendar.
- TransferLoadGroupBy; integer; Group-by option to use when releasing a planned transfer order. Contains one of the following values. 1: all, 2: source, destination, and ship date, or 3: source, destination, shipping method, and ship date. A list of accepted values is defined in the lookup type ORA_MSC_TRAN_LOAD_GROUP_OPT.
- UseAlternateResources; integer; Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative resource to create each planned order. If 2, then don't allow alternative.
- UseEndItemSubstitutes; integer; Contains one of the following values: 1 or 2. If 1, then perform end-item substitution. If 2, then don't perform end-item substitution. The default value is 2.
- UseFcstPlanPercInsteadCollData; integer; Plan option used to specify whether the planning percentages used for the forecast explosion process in supply planning are from demand planning or the Oracle Product Model: Valid values are 1 or 2. If 1, then planning uses planning percentages from demand planning. If 2, then planning uses planning percentages from the Oracle Product Model.
- UseModelSpecificPlanPct; integer; Plan option that enables users to apply different planning percentages for options in an option class to calculate dependent demand. Contains one of the following values: 1 or 2. If 1, then planning allows using different planning percentages for options in an option class. If 2, then planning doesn't allow using different planning percentages for options in an option class.
-
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 : demandAndSupplyPlans
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 : demandAndSupplyPlans-item-response
Type:
Show Source
object
-
AggregateNonkeyCustomerData: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data.
-
AltItemWorkDefOption: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative item structure or alternative work definition to create each planned order. If 2, then don't allow alternatives.
-
AltSupSourceOrgOption: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative supplier or source organization to create each planned order. If 2, then don't allow alternatives.
-
AnalyzingLateDemands: array
Analyzing Late Demands
Title:
Analyzing Late Demands
The root cause for the lateness of an end demand. -
AppliesToOrderTypes: string
Maximum Length:
255
List of demand order types to which the NumberOfDaysForDemandCutoff attribute applies. A comma separates each value. Valid values are 1029: Forecast, 1030: Sales order, and 1008: Manual demand. If the value is null, then no order types are considered for demand cutoff. The default value is null. This attribute is only used if the NumberOfDaysForDemandCutoff attribute is populated. -
ApplyPolicyOverrides: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then calculate the safety stock for an item and organization combination using policy level overrides. If 2, then don't use policy level overrides when calculating the safety stock. The default value is 2.
-
ArchivePlan: integer
Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. Note that you can archive the plan only if you enable it for archiving. If 2, then don't archive.
-
ArchiveTimeHierarchy: integer
(int64)
Time hierarchy that the application uses to archive the plan.
-
ArchiveTimeLevel: integer
(int64)
Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
-
ArchiveVersionDays: integer
Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.
-
AssignmentSetName: string
Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain when running the plan. You can use the Manage Assignment Sets page in one of the work areas for supply chain planning to set the values you can use with this attribute.
-
AutoRelease: integer
Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
-
AverageInterarrivalTime: integer
(int64)
This attribute isn't currently used.
-
BackwardConsumptionBucket: integer
Number of time buckets, such as three weeks or two months. This attribute allows a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of time buckets earlier than the sales order demand.
-
BackwardDays: number
Number of days that sales order demand can consume from forecast demand. Sales order demand will consume forecast demand that occurs before sales order demand even if forecast demand already consumed the days that Backward Days specifies.
-
CalendarCode: string
Maximum Length:
22
Abbreviation that identifies the supply planning calendar. -
CalSsQuantEndItems: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then calculate a new safety stock level for each end item when running the plan. If 2, then don't do this calculation.
-
CapacityConstrainedResources: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then apply capacity constraints on all resources. If 2, then apply capacity constraints only on bottleneck resources. A list of accepted values is defined in the lookup type ORA_MSC_CAP_CONST_RESOURCES.
-
ComponentSubstitutionLogic: integer
This attribute isn't currently used.
-
CompressionDaysTolerance: number
Number of compression days that the application can use to release each planned order.
-
ConsumeByForecastBucket: integer
Contains one of the following values: 1 or 2. If 1, then keep the consumption process inside of the consumption bucket for each forecast or sales order. If 2, then don't keep it inside the bucket.
-
ConsumeForecastWithinDtf: integer
Contains one of the following values: 1 or 2. If 1, then consume forecast entries before applying the demand time fence. Consume forecast entries within the time fence for consumption but not for demand. If 2, then apply the demand time fence before consuming forecast entries. Consume forecast entries within the time fence for demand, not consumption. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
-
ConsumeForecastWithNoDc: integer
Specifies the sequence the forecast consumption process uses to consume forecast entries when some entries reference a demand class and others don't reference a demand class. Contains one of the following values. 1: consume each forecast entry in each bucket. 2: consume demand for each forecast, and then consume each forecast entry in each bucket.
-
ConsumeWithInternalOrders: integer
This attribute isn't currently used.
-
ConsumptionBucketType: integer
Level of time to use when consuming the forecast such as day, week, or month.
-
ConsumptionCalendar: string
Maximum Length:
22
Calendar to use when consuming the forecast. -
ConsumptionDtlsCutoffDays: integer
Number of days after the plan start date when consumption details will be written. Consumption detail records are written for sales orders and transfer order demands that have a due date before the plan start date plus theses number of days after the plan start date.
-
ConSupplierCapPurOrders: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then allow each purchase order to consume supplier capacity. If 2, then don't allow.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the plan. -
CreateTimeFence: integer
Contains one of the following values: 1 or 2. If 1, then supply planning creates a time fence for each item. It creates this time fence on completion due date of the supply for the most recent job, purchase order, flow schedule, or shipment. If 2, then don't create a time fence. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the plan. -
CriticalResourceSupplier: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the plan enforces resource and supplier capacity constraints only for critical resources and item suppliers in constrained plans. If 2, then it enforces resources and supplier capacity constraints for bottleneck resources and all item suppliers.
-
CutoffDate: string
(date)
End date of the planning horizon when planning no longer plans demand or supply.
-
DateUsedToPlanSalesOrders: integer
(int32)
Date used when planning sales orders. A list of accepted values is defined in the lookup type ORA_MSC_SCHEDULE_DEMANDS_BY.
-
DefaultForecastPriority: integer
This attribute isn't currently used.
-
DefaultSalesOrderPriority: integer
This attribute isn't currently used.
-
DeleteArchive: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then delete the plan archive during the next plan run. If 2, then don't delete.
-
DemandExceptions: array
Demand Exceptions
Title:
Demand Exceptions
Order-based exceptions for demands when only demand-related exceptions are generated by planning. For example, the exception Demand at Risk Due to Insufficient Lead Time for demands that are at risk when they're pegged to supplies with insufficient lead time in the plan. -
DemandHistoryDays: integer
Number of days of historical demand data to load into the plan, starting with the plan refresh date. For example, if Demand History Days is 10, and if the plan refresh date is March 30, then load historical demand data from March 30 to March 20.
-
DemandPlanCompletionDate: string
(date-time)
Date and time when demand planning finished running the plan.
-
DemandPlanPriority: integer
Priority of the scheduled process when running a demand plan.
-
DemandPlanStartDate: string
(date-time)
Date and time when demand planning started running the plan.
-
DemandPrioritizationMethod: integer
(int32)
This attribute isn't currently used.
-
DemandPriorityRule: integer
(int64)
This attribute isn't currently used.
-
DemandSchedules: string
Collection of demand schedules that the scope of the plan includes. A comma separates each value. Values include Demand Schedule Name, Description, Demand Schedule Type, Demand Plan Output Measure, and Ship to Consumption Level. A set of parentheses encloses each set of demand schedules.
-
DemandTimeFenceControl: integer
Contains one of the following values: 1 or 2. If 1, then use a demand time fence. Ignore forecast demand and consider only sales order demand when calculating the demand requirement. If 2, then don't use a demand time fence. A time fence specifies a boundary between different time frames in the planning horizon. It defines a short time frame that a planning restriction can use to minimize costly disruption on the shop floor and in the supplier schedule.
-
Description: string
Maximum Length:
100
Description of the plan. -
DmCtoHistoryPeriods: integer
Title:
Planning Percentage History Periods
Number of history periods used when calculating planning percentage according to the history of the configure options. Applies only when planning a configured item. -
DontConsiderInTransitSupplyAsFirm: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then in-transit supplies aren't treated as firmed supplies. If 2, then in-transit supplies are treated as firmed supplies. The default value is 2.
-
EnableArchive: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures.
-
EnableEndItemSubstitution: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then allow planning to substitute each end item when planning supply. If 2, then don't allow.
-
EnableMultiThreading: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then use multithreading when planning supply. If 2, then don't use multithreading.
-
EnableWelcomePage: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then make the plan available as a source of data for an infolet. If 2, then don't make the plan available.
-
EnforceLeadTimeInTransit: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the plan enforces lead time constraints for in-transit supplies. If 2, then the plan can compress lead time constraints for in-transit supplies.
-
EnforceResourceCapConstr: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the plan enforces resource capacity constraints in constrained plans and doesn't overload the resource. If 2, then the plan can overload the resource.
-
EnforceSupplierCapConstr: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the plan enforces supplier capacity constraints in constrained plans and doesn't overload the supplier capacity. If 2, then the plan can overload the supplier capacity.
-
ExceptionSet: integer
(int64)
Exception set that the plan references. The exception set determines the exception types that the plan creates.
-
ExplodeDepndtDmdMethod: integer
This attribute isn't currently used.
-
ExplodeModelForecasts: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then expand the highest level forecast from demand planning when planning supply. If 2, then don't expand.
-
ExposeToAnalytic: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then use the plan in business intelligence reporting. If 2, then don't use.
-
FirmIrTf: integer
This attribute isn't currently used.
-
FirmPlannedOrderTf: integer
Contains one of the following values: 1 or 2. If 1, then create a time fence for each item that the firmed, planned order references. Create a time fence according to the completion due date of the most recent, firmed, planned order. If 2, then don't create the time fence according to the firmed, planned order.
-
FirstPlanningBucketCode: integer
(int32)
Abbreviation that identifies the time bucket type for the first set of supply planning buckets. Valid values vary based on the supply planning calendar type. If the supply planning calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the supply planning calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the supply planning calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
-
FirstPlanningBucketName: string
Read Only:
true
Maximum Length:40
Meaning associated with the FirstPlanningBucketCode attribute. -
FirstPlanningBucketNumber: number
Number of supply planning buckets to create for the first set of supply planning time buckets. For example, if the FirstPlanningBucketName attribute is Day, this would be the number of daily supply planning buckets that are created when the plan is run.
-
ForecastError: integer
Forecast accuracy measure that the plan uses to calculate safety stock. Contains one of the following values. 1: Mean Absolute Deviation, 2: Mean Absolute Percentage Error, or 3: intermittent. A list of accepted values is defined in the lookup type ORA_MSC_FORECAST_ERROR_TYPE.
-
ForecastingCalendar: string
Maximum Length:
22
Calendar that the forecast uses to forecast demand. -
ForecastingCalendarName: string
Read Only:
true
Maximum Length:40
Name of the calendar that the forecast uses to forecast demand. -
ForecastProfiles: string
List of forecast profiles that the plan uses. A comma separates each value. Values display in the following sequence: Forecast Profile name, Input Measure, Output Measure, Analysis Set, Historical Buckets, History Start Date, History End Date, Forecast Buckets, Locked Forecast Periods, and Forecast End Date. A set of parentheses encloses each set of forecast profiles.
-
ForecastTimeLevel: integer
Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
-
ForecastTimeLevelName: string
Read Only:
true
Maximum Length:40
Meaning associated with the ForecastTimeLevel attribute. -
ForwardConsumptionBucket: integer
Number of time buckets, such as three weeks or two months. This attribute allows a sales order demand to consume forecast demand even if the forecast demand is up to the specified number of time buckets later than the sales order demand.
-
ForwardDays: number
Number of days that sales order demand can consume from forecast demand. Sales order demand will consume forecast demand that occurs after sales order demand even if forecast demand already consumed the days that Forward Days specifies.
-
GlobalFcstCalendarName: string
Maximum Length:
255
Calendar used for spreading the global forecast. This field is enabled when the plan option Forecast Spreading is set to Spread forecast evenly. -
GlobalFcstDistrSetName: string
Maximum Length:
255
Assignment set used to distribute the global forecast to respective ship-from organizations. -
GlobalFcstValidOrg: integer
(int64)
This attribute isn't currently used.
-
GroupPlannedOrders: integer
This attribute isn't currently used.
-
HasRun: integer
Contains one of the following values. 1: the most recent plan run finished successfully, or 0: the most recent plan run failed, or Empty: the application hasn't run the plan.
-
HorizonForAverageDemand: number
Number of days that planning uses to calculate average daily demand.
-
InclDropShipDmdSup: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then include drop-ship demand and supply in the plan. If 2, then don't include.
-
IncludeDependentDemand: integer
Title:
Include dependent demand
Contains one of the following values: 1 or 2. If 1, then include configure options when planning demand. If 2, then don't include these options. This attribute applies only when planning demand for a configured item. -
IncludeItemsWithSafetyStock: integer
Contains one of the following values: 1 or 2. If 1, then items with no demand other than safety stock are included in the plan. If 2, then items with no demand other than safety stock aren't included in the plan.
-
IncludeItemsWithSupplyButNoDemand: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then items with existing supplies, but no demands planned in the supply plan are also included in the plan. If 2, then items with existing supplies, but no demands aren't included in the plan. The default value is 2.
-
IncludeProdMonitoringAlrts: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the plan is enabled for production monitoring alerts. If 2, then the plan doesn't provide production monitoring alerts.
-
IncludeTransferOrders: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.
-
ItemExceptions: array
Item Exceptions
Title:
Item Exceptions
The order-based exceptions for items where only item related exceptions are generated by planning. For example, an exception such as Items below Safety Stock where an exception for items that are below a safety stock level are calculated by the plan. -
ItemListPrice: integer
(int32)
This attribute isn't currently used.
-
Items: array
Items
Title:
Items
The Items resource manages the items within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who performed the most recent update on the plan. -
LastUpdatedDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the plan. -
LatenessThreshold: integer
This attribute isn't currently used.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadedOption: integer
Contains one of the following values: 1 or 2. If 1, then the application loaded the plan into memory. If 2, then the application didn't load the plan into memory.
-
MatchTopModelFrcstCosmp: integer
This attribute isn't currently used.
-
MaximumVarSafetyStockValue: number
Maximum percent difference to allow between the safety stock quantity in one interval and the next interval.
-
MeasureCatalogForArchival: string
Measure catalog that the application uses to archive the plan.
-
MinimumVarSafetyStockValue: number
Minimum percent difference to allow between the safety stock quantity in one interval and the next interval.
-
NumberOfDaysForDemandCutoff: integer
The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value.
-
OrderModifierStartQuantity: integer
This attribute isn't currently used.
-
Organizations: string
Collection of organization names and descriptions that the scope of the plan includes. A comma separates the organization name from the description. A set of parentheses encloses each organization name and description.
-
OverwriteOption: integer
Default Value:
1
Contains one of the following values: 1 or 2. If 1, then keep all firmed, planned orders between planning runs. If 2, then don't keep firmed, planned orders between planning runs. A list of accepted values is defined in the lookup type ORA_MSC_OW_FIRM_PLANNED_ORDRS. -
OverwriteSafetyStock: integer
Safety stock levels that planning can override when the plan runs. Contains one of the following values. 1: all, 2: all except for user defined, or 3: none. A list of accepted values is defined in the lookup type MSC_SAFETY_OVERWRITE.
-
ParameterOverrides: string
Maximum Length:
4000
List of parameters to override and the new value to apply for each parameter. These parameters determine what to override in the profile settings that the demand forecast uses. The following format is used: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter. -
PastDueDemandBucket: integer
Number of time buckets, such as three weeks or two months. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due demands into a plan.
-
PastDueDemandBucketType: integer
Level of time to use to determine whether to include a past due demand in a plan such as day, week, or month.
-
PastDueDemandCalendar: string
Maximum Length:
22
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. This attribute determines the time period 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. This attribute determines the time period 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. This attribute determines the time period earlier than the plan start date to use as a threshold for copying past due shipped sales orders into a plan.
-
PlanCompletionDate: string
(date-time)
Date and time when supply planning finished running the plan.
-
PlanDemand: integer
Contains one of the following values: 1 or 2. If 1, then run demand planning when running a plan. If 2, then don't run demand planning.
-
PlanDimensionCatalog: integer
(int64)
Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
-
PlanHorizonDays: integer
Number of days that the plan considers, starting from the plan start date and proceeding forward in time.
-
PlanHorizonStartDate: string
(date)
Date when the plan starts planning demand and supply.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
PlanItemLevelMembers: string
List of level values in the item hierarchy to include in the scope of the plan. A comma separates each value.
-
PlanMeasureCatalog: string
Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
-
PlanName: string
Title:
Name
Maximum Length:30
Name of the plan. -
PlannedItemType: integer
Type of item that supply planning plans. Contains one of the following values. 1: Manufacturing Plan, or 2: Production Plan. You can use attribute Supply Planned Item Type with attribute Planning Method of the item to identify supply planned items from a subset of the items that pass the condition that the Supply Planned Items attribute imposes. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_ITEM_TYPE.
-
PlanningBucketType: integer
Time bucket that each forecast demand uses. Values include day, week, or period.
-
PlanningDemands: array
Planning Demands
Title:
Planning Demands
The Planning Demands resource manages the demand orders and forecasts that are part of the plan. -
PlanningMode: integer
Contains one of the following values: 1 or 2. If 1, then constrain supply planning. If 2, then don't constrain. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE.
-
PlanningSupplies: array
Planning Supplies
Title:
Planning Supplies
The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan. -
PlanningTimeFenceControl: integer
Contains one of the following values: 1 or 2. If 1, then don't create planned orders within the planning time fence. If 2, then create planned orders.
-
PlanOrganizationLevelMembers: string
List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
-
PlanOwner: string
Maximum Length:
64
Name of the user who owns the plan. -
PlanStartDate: string
(date-time)
Date and time when supply planning started running the plan.
-
PlanStatus: integer
Status of the plan run that most recently completed. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.
-
PlanSupply: integer
Contains one of the following values: 1 or 2. If 1, then run supply planning when running a plan. If 2, then don't run supply planning.
-
PlanType: integer
Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.
-
PlnPctHistCalMeasure: integer
(int64)
Title:
Planning Percentage History Calculation Measure
Measure that planning uses to calculate planning percentage history. Contains one of the following values. 1788: option bookings history, or 1789: option shipments history. -
PlnPercentCalLevel: integer
(int32)
Title:
Planning Percentage Calculation Level
Planning hierarchy level to use when calculating planning percentage according to history. Contains one of the following values. 1: item and organization, 2: item, or 3: item, organization, and demand class. A list of accepted values is defined in the lookup type ORA_MSC_PLN_PERCENT_CAL_LEVEL. Applies only with a configured item. -
PolicyAssignmentSet: string
Name of the policy assignment set used in calculating the safety stock. Only applicable when the ApplyPolicyOverrides attribute is 1.
-
PriceLists: string
List of price lists to consider in the plan. A comma separates each value.
-
PrivatePlan: integer
Default Value:
1
Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS. -
RecalculateSafetyStock: integer
Contains one of the following values: 1 or 2. If 1, then recalculate safety stock quantity the next time the plan runs. If 2, then don't recalculate.
-
RequisitionLoadGroupBy: integer
Group-by option to use when releasing a planned buy order. Contains one of the following values. 1: all, 2: item, 3: buyer, 4: planner, 5: supplier, 7: category, or 8: location. A list of accepted values is defined in the lookup type ORA_MSC_REQ_LOAD_GROUP_OPT.
-
ResourceExceptions: array
Resource Exceptions
Title:
Resource Exceptions
Order-based exceptions for resources generated by planning. For example, the exception Resource Capacity Constraints is generated for resources that are constrained by capacity for planning supplies. -
ResourceRequirements: array
Resource Requirements
Title:
Resource Requirements
The resource requirements for resources generated by planning. -
Resources: array
Resources
Title:
Resources
The Resources resource manages the collected resources used as input for the Oracle Supply Chain Planning Cloud solution. -
Runs: array
Runs
Title:
Runs
The Runs resource manages the run details about the demand and supply plan. You can use this resource to run demand and supply plans. -
SafetyStockChangeToAll: integer
Contains one of the following values: 1 or 2. If 1, then smooth safety stock quantity for each item, including items that use the Not MRP Planned safety stock method. If 2, then smooth safety stock quantity for each item that uses the Days of Cover safety stock method.
-
SafetyStockForecastPlan: string
Demand plan that contains the forecast and forecast error measures that the plan uses to calculate safety stock.
-
SafetyStockPlanningMethod: integer
Method that planning uses to calculate safety stock levels. A list of accepted values is defined in the lookup type ORA_MSC_SS_PLANNING_METHD.
-
SafetyStockSaveToSimSet: integer
(int64)
This attribute isn't currently used.
-
SafetyStockServiceLevel: number
Percent that planning uses to calculate safety stock. It uses the mean absolute deviation method to determine the probability whether planning can fill each sales order from inventory that's currently available.
-
SaveToCollectedData: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then use the quantity of the calculated safety stock to update collected data. If 2, then don't update collected data.
-
SecondPlanningBucketCode: integer
(int32)
Abbreviation that identifies the time bucket type for the second set of supply planning buckets. Valid values vary based on the supply planning calendar type. If the supply planning calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the supply planning calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the supply planning calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
-
SecondPlanningBucketName: string
Read Only:
true
Maximum Length:40
Meaning associated with the SecondPlanningBucketCode attribute. -
SecondPlanningBucketNumber: number
Number of supply planning buckets to create for the second set of supply planning time buckets. For example, if the SecondPlanningBucketName attribute is Week, this would be the number of weekly supply planning buckets created when the plan is run.
-
ShortPlanId: integer
Short value that identifies the plan.
-
SimulationSet: integer
(int64)
Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.
-
SmMethodToCalSsInterval: integer
Method that the plan uses to calculate safety stock quantity. Contains one of the following values. 1: minimum, 2: average, or 3: maximum. A list of accepted values is defined in the lookup type ORA_MSC_SM_MTHD_CAL_SS. The plan smooths safety stock quantities in each interval that uses the method you specify, starting from the plan horizon.
-
SourcingAllocationWindow: integer
This attribute isn't currently used.
-
SourcingSplitPercent: integer
This attribute isn't currently used.
-
SsBuckStartOffsetDays: number
Number of days that the plan offsets the start date of the safety stock bucket, starting with the current date. You can use this attribute to ignore the impacts of high, near-term demand that might occur because of backlog demand.
-
SsChngeIntervalDays: number
Number of working days to use in the interval when smoothing safety stock.
-
SupplierExceptions: array
Supplier Exceptions
Title:
Supplier Exceptions
Order-based exceptions for suppliers, generated by planning. For example, the exception Supplier Capacity Constraints is generated for the item supplier and supplier site combination which is constrained by the capacity for planning supplies. -
SupplyExceptions: array
Supply Exceptions
Title:
Supply Exceptions
Order-based exceptions for supplies when only supply-related exceptions are generated by planning. For example, the exception Orders to be Rescheduled Out for supplies is generated for supplies that have been rescheduled to a date later than their prior due date based on the earliest pegged demands date in the plan. -
SupplyParameterOverrides: string
Maximum Length:
250
List of parameters to override and the new value to apply for each parameter. These parameters determine what to override in the profile settings that the demand forecast uses. The following format is used: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter. -
SupplyPlannedItems: integer
Specify items to plan during supply planning. Contains one of the following values. 1: all items, 2: demand planned items and sales orders, 5: demand planned items and work-in-process components, 6: demand planned items, or 7: demand planned items, work-in-process components, and sales orders. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_ITEMS.
-
SupplyPlanningCalendar: string
Read Only:
true
Maximum Length:40
Name associated with the supply planning calendar. -
TransferLoadGroupBy: integer
Group-by option to use when releasing a planned transfer order. Contains one of the following values. 1: all, 2: source, destination, and ship date, or 3: source, destination, shipping method, and ship date. A list of accepted values is defined in the lookup type ORA_MSC_TRAN_LOAD_GROUP_OPT.
-
UseAlternateResources: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then allow planning to use an alternative resource to create each planned order. If 2, then don't allow alternative.
-
UseEndItemSubstitutes: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then perform end-item substitution. If 2, then don't perform end-item substitution. The default value is 2.
-
UseFcstPlanPercInsteadCollData: integer
(int32)
Plan option used to specify whether the planning percentages used for the forecast explosion process in supply planning are from demand planning or the Oracle Product Model: Valid values are 1 or 2. If 1, then planning uses planning percentages from demand planning. If 2, then planning uses planning percentages from the Oracle Product Model.
-
UseModelSpecificPlanPct: integer
(int32)
Plan option that enables users to apply different planning percentages for options in an option class to calculate dependent demand. Contains one of the following values: 1 or 2. If 1, then planning allows using different planning percentages for options in an option class. If 2, then planning doesn't allow using different planning percentages for options in an option class.
Nested Schema : Analyzing Late Demands
Type:
array
Title:
Analyzing Late Demands
The root cause for the lateness of an end demand.
Show Source
Nested Schema : Demand Exceptions
Type:
array
Title:
Demand Exceptions
Order-based exceptions for demands when only demand-related exceptions are generated by planning. For example, the exception Demand at Risk Due to Insufficient Lead Time for demands that are at risk when they're pegged to supplies with insufficient lead time in the plan.
Show Source
Nested Schema : Item Exceptions
Type:
array
Title:
Item Exceptions
The order-based exceptions for items where only item related exceptions are generated by planning. For example, an exception such as Items below Safety Stock where an exception for items that are below a safety stock level are calculated by the plan.
Show Source
Nested Schema : Items
Type:
array
Title:
Items
The Items resource manages the items within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Demands
Type:
array
Title:
Planning Demands
The Planning Demands resource manages the demand orders and forecasts that are part of the plan.
Show Source
Nested Schema : Planning Supplies
Type:
array
Title:
Planning Supplies
The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.
Show Source
Nested Schema : Resource Exceptions
Type:
array
Title:
Resource Exceptions
Order-based exceptions for resources generated by planning. For example, the exception Resource Capacity Constraints is generated for resources that are constrained by capacity for planning supplies.
Show Source
Nested Schema : Resource Requirements
Type:
array
Title:
Resource Requirements
The resource requirements for resources generated by planning.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The Resources resource manages the collected resources used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Runs
Type:
array
Title:
Runs
The Runs resource manages the run details about the demand and supply plan. You can use this resource to run demand and supply plans.
Show Source
Nested Schema : Supplier Exceptions
Type:
array
Title:
Supplier Exceptions
Order-based exceptions for suppliers, generated by planning. For example, the exception Supplier Capacity Constraints is generated for the item supplier and supplier site combination which is constrained by the capacity for planning supplies.
Show Source
Nested Schema : Supply Exceptions
Type:
array
Title:
Supply Exceptions
Order-based exceptions for supplies when only supply-related exceptions are generated by planning. For example, the exception Orders to be Rescheduled Out for supplies is generated for supplies that have been rescheduled to a date later than their prior due date based on the earliest pegged demands date in the plan.
Show Source
Nested Schema : demandAndSupplyPlans-AnalyzingLateDemands-item-response
Type:
Show Source
object
-
AssemblyItemName: string
Read Only:
true
Maximum Length:300
Item name of the final assembly on which there is an end demand. -
Category: string
Read Only:
true
Maximum Length:400
Name of the category to which the item is assigned. -
ComponentName: string
Read Only:
true
Maximum Length:4000
Component name of the final assembly. -
CustomerName: string
Read Only:
true
Maximum Length:4000
Customer name on the demand order. -
DemandItemId: integer
(int64)
Read Only:
true
Unique identifier of the assembly item. -
DemandOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number for an end demand. -
DemandOrderType: integer
Read Only:
true
Order type of an end demand. -
DemandOrderTypeText: string
Read Only:
true
Maximum Length:4000
Name of the order type of an end demand. For example, sales order or forecast. -
DemandOrganizationCode: string
Read Only:
true
Maximum Length:49
Organization code of the final assembly. -
DemandOrganizationId: integer
Read Only:
true
Unique identifier for the organization of final assembly. -
DemandOrgCurrencyCode: string
Read Only:
true
Maximum Length:4000
Currency code for demanded item organization. -
DemandPriority: number
Read Only:
true
Demand priority of the end demand. -
DemandSuggestedDueDate: string
(date)
Read Only:
true
Demand due date of the end demand. -
DemandValue: number
Read Only:
true
Demand value of the end demand. -
DestSupplyOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number of the direct parent supply. -
EarliestStartDate: string
(date)
Read Only:
true
Earliest date that a supply can start. -
EndDemandId: integer
(int64)
Read Only:
true
Unique identifier for the end demand. -
EndSupplyOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number of the supply pegged to end demand. -
FirmPlannedType: integer
Read Only:
true
Indicates whether a supply order is firm. Valid values are 1 and 2. -
FirmStatus: string
Read Only:
true
Maximum Length:4000
Indicates whether a supply order is firm. Valid values are firm or not firm. -
InventoryItemId: integer
(int64)
Read Only:
true
Unique identifier of an inventory item. -
ItemStructureLevel: integer
(int32)
Read Only:
true
Item structure level of a subassembly or component. For final assembly, the level is 0. -
LatestStartDatePegSup: string
(date)
Read Only:
true
Latest date that a supply order can start. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MostCriticalPath: integer
(int32)
Read Only:
true
Most critical supply path for the end demand that's satisfied late. -
MtqSupplyDate: string
(date)
Read Only:
true
Date that the minimum transfer quantity supply is produced. -
NeedByDate: string
(date)
Read Only:
true
Date that the supply order is required. -
OrderQuantity: number
Read Only:
true
Order quantity for the supply order. -
OrderType: integer
Read Only:
true
Order type of the supply order. -
OrderTypeText: string
Read Only:
true
Maximum Length:4000
Name of the supply order types, such as planned order, work order, and so on. -
OrganizationId: integer
(int64)
Read Only:
true
Unique value for an organization. -
OverrideDemandPriority: number
Read Only:
true
Overridden demand priority. -
PlanId: integer
(int64)
Read Only:
true
Unique identifier for a plan name. -
PlannerCode: string
Read Only:
true
Maximum Length:4000
User name of the planner. -
ScheduleCompressionDays: number
Read Only:
true
Number of days a supply is compressed. - SharedSupply: integer
- SharedSupplyText: string
-
SlackDays: integer
Read Only:
true
Number of slack days. -
SourceVendorName: string
Read Only:
true
Maximum Length:4000
Supplier name for the supply order. -
SourceVendorSiteCode: string
Read Only:
true
Maximum Length:4000
Identifies the sites belonging to the supplier. -
SuggestedDueDate: string
(date)
Read Only:
true
Suggested due date of the supply. -
SupplierId: integer
(int64)
Read Only:
true
Unique identifier for a supplier. -
SupplierSiteId: integer
(int64)
Read Only:
true
Unique identifier for a supplier site. -
SupplyOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number of a supply. -
SupplyOrganizationCode: string
Read Only:
true
Maximum Length:4000
Organization code of the supply. -
TransactionId: integer
(int64)
Read Only:
true
Unique identifier of a supply.
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 : demandAndSupplyPlans-DemandExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
Title:
Action Taken
Read Only:true
Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2. -
AvailableLeadTime: number
Title:
Available Lead Time
Read Only:true
Number that represents the available lead time of the supply in the exception. -
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the demand's item in the exception. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog. -
ConstrainedDate: string
(date)
Title:
Constrained Date
Read Only:true
Value that represents the constrained date of the resource or the supplier capacity in the exception. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:4000
Code for the currency of the demand's organization in the exception. -
Customer: string
Title:
Customer
Read Only:true
Maximum Length:4000
Name of the customer in the demand in the exception. -
CustomerId: integer
Read Only:
true
Value that uniquely identifies the customer in the exception. -
CustomerSite: string
Title:
Customer Site
Read Only:true
Maximum Length:4000
Name of the customer site in the demand in the exception. -
CustomerSiteId: integer
Read Only:
true
Value that uniquely identifies the customer site in the exception. -
DaysLate: number
Title:
Exception Days
Read Only:true
Number that represents the number of days a demand is satisfied late or a supply pegged to a demand is late or number of days a demand is past due. Based on the exception, the days late provides the details. -
DemandClass: string
Title:
Demand Class
Read Only:true
Maximum Length:4000
Demand class associated with the demand in the exception. -
DemandId: integer
Read Only:
true
Value that uniquely identifies the demand in the exception. -
DemandLineNumber: string
Title:
Demand Line Number
Read Only:true
Maximum Length:250
Line number of the demand in the exception. -
DemandOrderNumber: string
Title:
Demand Order Number
Read Only:true
Maximum Length:4000
Order number of the demand in the exception. -
DemandOrderType: string
Title:
Demand Order Type
Read Only:true
Maximum Length:4000
Type of order of the demand in the exception. For example, the type of demand order could be a sales order or a forecast. -
DemandQuantity: number
Title:
Demand Quantity
Read Only:true
Quantity of the demand in the exception. -
DemandSatisfiedDate: string
(date)
Title:
Demand Satisfied Date
Read Only:true
Date in the exception when the demand quantity is completely satisfied. -
DepartmentId: integer
Read Only:
true
Value that uniquely identifies the department or the work center of a resource in the exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:120
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the demand exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionValue: number
Title:
Exception Value
Read Only:true
Number that represents the value of the delay, or the value of the unplanned portion, or the value of the demand quantity, or a part of the demand quantity in the exception. -
InventoryItemId: integer
Read Only:
true
Value that uniquely identifies the demand's item in the exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:4000
Name of the item in the demand in the exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:4000
Description of the item in the demand in the exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the exception detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaturityDate: string
(date)
Title:
Maturity Date
Read Only:true
Date of maturity of the supply pegged to the demand in the exception. -
MtqSupplyDate: string
(date)
Title:
MTQ Supply Date
Read Only:true
The supply date of the minimum transfer quantity (MTQ) of the supply pegged to the demand in the exception -
Notes: integer
(int64)
Title:
Notes
Contains information created or updated for an exception detail represented as notes. -
OrderDate: string
(date)
Title:
Order Date
Read Only:true
Date of the demand in the exception. -
OrderValue: number
Title:
Order Value
Read Only:true
Order value of the demand in the exception. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the demand's organization in the exception. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the demand's organization in the exception. -
PartialPlannedQuantity: number
Title:
Partial Planned Quantity
Read Only:true
Partial planned quantity of the demand in the exception. -
PeggedQuantity: number
Title:
Pegged Quantity
Read Only:true
Pegged quantity of the supply to the demand in the exception. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
PlannerCode: string
Title:
Planner
Read Only:true
Maximum Length:4000
Name of the planner associated with the demand's item in the exception. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:4000
Description of the planner associated with the demand's item in the exception. -
PlanningAttribute10: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 10 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute10Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 10 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute11: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 11 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute11Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 11 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute12: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 12 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute12Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 12 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute13: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 13 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute13Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 13 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute14: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 14 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute14Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 14 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute15: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 15 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute15Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 15 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute3: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 3 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute3Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 3 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute4: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 4 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute4Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 4 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute5: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 5 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute5Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 5 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute6: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 6 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute6Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 6 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute7: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 7 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute7Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 7 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute8: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 8 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute8Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 8 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute9: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 9 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute9Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 9 associated with the demand in the exception in an attribute-based plan. -
Priority: number
Title:
Priority
Read Only:true
Priority of the demand in the exception. -
ProjectGroupValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project group associated with the demand in the exception in an attribute-based plan. -
ProjectGroupValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the project group associated with the demand in the exception of an attribute-based plan. -
ProjectValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project associated with the demand in the exception in an attribute-based plan. -
ProjectValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the project associated with the demand in the exception of an attribute-based plan. -
QuantityMismatch: number
Title:
Quantity Mismatch
Read Only:true
Number that represents the unsatisfied quantity of the demand in the exception. -
QuantitySatisfiedByDemandDate: number
Title:
Quantity Satisfied by Demand Date
Read Only:true
Number that represents the quantity of the demand satisfied by the demand order date in the exception. -
RequiredLeadTime: number
Title:
Required Lead Time
Read Only:true
Number that represents the lead time required by the supply pegged to the demand in the exception. -
ResourceCode: string
Title:
Resource Code
Read Only:true
Maximum Length:4000
Name of the resource in the demand exception. -
ResourceId: integer
Read Only:
true
Value that uniquely identifies the resource in the demand exception. -
ResourceOrganization: string
Title:
Resource Organization
Read Only:true
Maximum Length:4000
Name of the organization of the resource in the demand exception. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Start date in the demand exception. For example, the plan start date in the Late Replenishment for Sales Order exception. -
StoreKey: string
Read Only:
true
Maximum Length:240
Name of the store key in the supply exception. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the demand exception. -
SupplierId: integer
Read Only:
true
Value that uniquely identifies the supplier in the demand exception. -
SupplierItem: string
Title:
Supplier Item
Read Only:true
Maximum Length:4000
Supplier item in the demand exception. -
SupplierItemDescription: string
Title:
Supplier Item Description
Read Only:true
Maximum Length:4000
Supplier item description in the demand exception. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the demand exception. -
SupplierSiteId: integer
Read Only:
true
Value that uniquely identifies the supplier site in the demand exception. -
SupplyDueDate: string
(date)
Title:
Supply Due Date
Read Only:true
Due date of the supply in the demand exception. -
SupplyItem: string
Title:
Supply Item
Read Only:true
Maximum Length:4000
Name of the supply's item pegged to the demand in the demand exception. -
SupplyItemDescription: string
Title:
Supply Item Description
Read Only:true
Maximum Length:4000
Description of the supply's item pegged to the demand in the demand exception. -
SupplyLineNumber: string
Title:
Supply Line Number
Read Only:true
Maximum Length:50
Line number of the supply in the demand exception. -
SupplyOrderDemandDueDate: string
(date)
Title:
Supply Order Demand Due Date
Read Only:true
Due date of the supply order demand in the demand exception. -
SupplyOrderNumber: string
Title:
Supply Order Number
Read Only:true
Maximum Length:240
Order number of the supply in the demand exception. -
SupplyOrderType: string
Title:
Supply Order Type
Read Only:true
Maximum Length:4000
Type of order of the supply in the demand exception. For example, a planned order or a work order. -
SupplyOrganization: string
Title:
Supply Organization
Read Only:true
Maximum Length:4000
Name of the supply organization in the demand exception. -
SupplyQuantity: number
Title:
Supply Quantity
Read Only:true
Number that represents the quantity of the supply in the demand exception. -
TaskValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the task associated with the demand in the exception in an attribute-based plan. -
TaskValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the task associated with the demand in the exception of an attribute-based plan. -
TransactionId: integer
Read Only:
true
Value that uniquely identifies the supply in the demand exception. -
WorkCenter: string
Title:
Work Center
Read Only:true
Maximum Length:4000
Name of the work center of the resource in the demand exception.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-ItemExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
Title:
Action Taken
Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2. -
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the item in the exception. the category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:4000
Code for the currency of the demand's organization in the exception. -
DataSecurityEditAllowed: string
Read Only:
true
Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges. -
DaysOfExcess: number
Title:
Days of Excess
Read Only:true
Number of days of excess inventory calculated by the plan in an item with excess inventory exception. -
DaysOfShortage: number
Title:
Days of Shortage
Read Only:true
Number of days of shortage of supply for an item calculated by the plan in an items with a shortage exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:34
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the item exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionQuantity: number
Title:
Exception Quantity
Read Only:true
Number that represents the quantity of supply in an item exception. This represents the shortage quantity in the item with a shortage exception, the quantity below safety sock in items below safety stock, the quantity of excess in item with excess inventory exception, and the expired quantity in items with expired lot exception. -
ExceptionStoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item stored item exception. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Effective start date of an exception detail calculated by the plan. -
InventoryItemId: integer
Read Only:
true
Value that uniquely identifies the item in the exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:4000
Name of the item in the exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:4000
Description of the item in the demand in the exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the exception detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: integer
(int64)
Title:
Notes
Contains information created or updated for an exception detail represented as notes. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the organization of an item for which an exception was calculated by the plan. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of an item in the exception -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Name of the planner associated with the item in the exception. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:4000
Description of the planner associated with the item in the exception. -
ProjectedAvailableBalance: number
Title:
Projected Available Balance
Read Only:true
Number that represents the projected available balance of the item in the exception. -
RowModified: string
Read Only:
true
Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified. -
SafetyStockTarget: number
Title:
Safety Stock Target
Read Only:true
Number that represents the target level of the safety stock for an item in an organization in the exception. -
StoreKey: string
Read Only:
true
Maximum Length:240
Name of the store key in the supply exception. -
ToDate: string
(date)
Title:
To Date
Read Only:true
Effective end date of an exception detail calculated by the plan. -
ValueOfShortage: number
Title:
Value of Shortage
Read Only:true
Name that represents the value of the shortage quantity of supply for an item that's in an exception.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-Items-item-response
Type:
Show Source
object
-
ABCClass: string
Maximum Length:
40
Code assigned to the item for classification purposes. Items are divided into categories called ABC classes, such as A, B, and C, according to a criterion such as revenue generation, turnover, or value. -
AcceptableEarlyDays: integer
Number of days before which the planning process won't reschedule the sales order. For example, if the due date on the original sales order is June 10, and if the Acceptable Early Days is 3, and if the new due date is less than or equal to June 13 then the planning process won't suggest rescheduling.
-
AllowUseOfCommonSupplies: integer
Read Only:
true
Value that indicates whether common supplies are used in case the project inventory isn't sufficient during the demand and supply netting process. Valid values are: 1 or 2. If 1, then common supplies are used. If 2, then not. -
AllowUseOfCommonSuppliesMeaning: string
Read Only:
true
Maximum Length:4000
Indicates whether to allow use of common supplies when the project inventory isn't sufficient during the demand and supply netting process. Valid values are Yes and No. -
AnnualCarryingCostPercentage: number
Percent of unit cost that represents the internal cost to stock one unit for one year.
-
ATPComponents: string
Read Only:
true
Maximum Length:1
Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time. -
ATPComponentsMeaning: string
Read Only:
true
Maximum Length:4000
Indicates whether to include additional components in the item structure for assemble-to-order and pick-to-order items when performing available-to-promise checking. Valid values are Yes and No. -
AutocreatedConfiguration: integer
Read Only:
true
Value that indicates whether the item is a configured item or not. Valid values are: 1 or 2. If 1, then item is a configured item. If 2, then not. -
AutocreatedConfigurationMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the item is configured or not. Valid values are: Yes or No. If Yes, then the item is configured. If No, then the item isn't configured. -
AverageInterarrivalTime: number
Average time, expressed in days, between intervals.
-
AverageInterarrivalTimeOvrride: number
Number of days specified by the user to override the average interarrival time, where the average interarrival time is the average time, expressed in days, between intervals.
-
BackToBack: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the item is enabled for back-to-back ordering or not. Valid values are: Yes or No. If Yes, then the item is enabled for back-to-back ordering. If No, then the item isn't enabled for back-to-back ordering. -
BackToBackEnabled: integer
Read Only:
true
Value that indicates whether the item is enabled for back-to-back ordering or not. Valid values are: 1 or 2. If 1, then item is enabled for back-to-back ordering. If 2, then not. -
BaseModel: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the model to use when creating an assemble-to-order configuration. -
BuildInWIP: string
Read Only:
true
Maximum Length:4000
Value that indicates whether work orders can be created or not. Valid values are Yes or No. If Yes, then work orders can be created. If No, then work orders can't be created. -
BuildInWIPOption: integer
Read Only:
true
Contains one of the following values: 1 or 2. If 1, then work orders can be created. If No, then work orders can't be created. -
Buyer: string
Maximum Length:
240
Name of the buyer associated with the item. -
CalculateATPIndicator: integer
Value that indicates whether to enable available-to-promise functionality in Oracle Fusion Cloud Global Order Promising when planning for this item. Valid values are 1 and 2. If 1, then available-to-promise functionality is enabled. If 2, then available-to-promise functionality isn't enabled.
-
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the item in the exception. the category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog. -
CategoryDescription: string
Read Only:
true
Maximum Length:4000
Description associated with a product category. -
CategoryId: integer
Read Only:
true
Value that uniquely identifies an item category. -
ConsiderInClearToBuild: string
Maximum Length:
1
Value that indicates whether to include this component item when calculating clear-to-build for an assembly item. Valid values are 1 or 2. If 1, then this component item is included. If 2, then it's not. -
ConsiderInClearToBuildMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether to include this component item when calculating clear to build for an assembly item. Valid values are Yes or No. If Yes, then this component item is included. If No, then this component item isn't included. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item. -
CreateSupply: integer
Value that indicates whether planning creates planned orders for this item. Valid values are 1 or 2. If 1, then planned orders are created. If 2, then planned orders aren't created.
-
CreateSupplyAfter: string
(date)
Date after which supplies can be created. This attribute is editable only when the CreateSupply attribute is set to 1.
-
CreateSupplyMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether planning creates planned orders for this item. Valid values are Yes or No. If Yes, then planned orders are created. If No, then planned orders aren't created. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the supplier item. -
CriticalComponent: integer
Value that indicates whether the item is a critical component or not. Valid values are 1 or 2. If 1, then the item is a critical component. If 2, then the item isn't a critical component.
-
CriticalComponentMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the item is a critical component or not. Valid values are Yes or No. If Yes, then the item is a critical component. If No, then the item isn't a critical component. -
CumulativeManufacturingLt: number
Read Only:
true
Number of days required to manufacture the item, including the adjusted, cumulative, and total lead time for the component that requires the longest time to assemble. -
Currency: string
Read Only:
true
Maximum Length:30
Value that indicates the currency associated with the item's price and cost. -
DataSecurityEditAllowed: string
Read Only:
true
Maximum Length:255
Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges. -
DaysOfCover: number
Number of days of cover for the item. Days of Cover is multiplied by the average demand to calculate the safety stock level.
-
DaysOfCoverDemandPeriod: integer
Period of time, specified as a number of days, used to determine the average gross demand when using the Days of Cover method to calculate safety stock.
-
DemandTimeFenceCode: integer
Abbreviation that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
-
DemandTimeFenceDate: string
(date)
Read Only:
true
Date before which forecast demand is ignored. -
DemandTimeFenceDays: integer
Time horizon, expressed in number of days, within which forecast demand is ignored.
-
DemandTimeFenceType: string
Read Only:
true
Maximum Length:4000
Value that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
Description: string
Maximum Length:
240
Description of the item. -
DiscountPercentage: number
Average discount for the item.
-
EnforcePurchaseLtMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether purchasing lead times are imposed as a hard constraint during constraint-based planning. Valid values are: 1 or 2. If 1, then purchasing lead times are enforced. If 2, then not. -
EnforcePurchasingLeadTime: integer
(int32)
Value that indicates whether purchasing lead times are imposed as a hard constraint during constraint-based planning. Valid values are: Yes or No. If Yes, then purchasing lead times are enforced. If No, then purchasing lead times aren't enforced.
-
ExcessHorizon: number
Time horizon, expressed in number of days, after which inventory is considered excess.
-
FixedDaysSupply: number
Number of days to use to modify the size and timing of each planned order quantity.
-
FixedLeadTime: number
Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
-
FixedLotMultiplier: number
Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
-
FixedOrderQuantity: number
Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.
-
ForecastControl: string
Read Only:
true
Maximum Length:4000
Value that indicates how the forecast is exploded and consumed. This attribute isn't currently used. -
ForecastErrorType: string
Maximum Length:
30
Value that indicates how the quality of a forecast is measured. A list of accepted values is defined in the lookup type MSC_FORECAST_ERROR_TYPES. -
ForecastErrorTypeStr: string
Read Only:
true
Maximum Length:4000
Meaning associated with the ForecastErrorType Code attribute. -
ForecastName: string
Read Only:
true
Maximum Length:4000
Name of the forecast used for safety stock calculation. -
HardPeggingLevel: string
Read Only:
true
Maximum Length:25
Value that identifies the type of pegging considered by the planning engine during the supply and demand netting process. A list of accepted values is defined in the lookup type ORA_MSC_HARD_PEGGING_LEVEL. -
HardPeggingLevelStr: string
Read Only:
true
Maximum Length:4000
Meaning associated with the HardPeggingLevel attribute. -
IntermittentDemand: number
Value that indicates whether the demand for the item has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not.
-
IntermittentDemandMeaning: string
Read Only:
true
Maximum Length:4000
Indicates whether the demand has an irregular frequency. Valid values are Yes and No. -
IntermittentDemandOverride: string
Value specified by the user to override the Intermittent Demand, where Intermittent Demand indicates whether the demand has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not.
-
IntermittentDemandOverrideStr: string
Read Only:
true
Maximum Length:4000
Value specified by the user to determine whether to override intermittent demand, which indicates whether the demand has an irregular frequency or not. Valid values are Yes and No. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemCostUOM: string
Read Only:
true
Maximum Length:4000
Unit of measure associated with an item's cost. -
ItemName: string
Maximum Length:
300
Name of the item. -
ItemStructureType: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of bill of material. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User most recently updated the item. -
LeadTimeLotSize: number
Read Only:
true
Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate. -
LeadTimeOffsetPeriodBkts: number
Number of months or periods in which the constrained supply plan offsets the lead time, after converting the number of months or periods to days. Month buckets are used if the supply planning calendar is Gregorian. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
-
LeadTimeOffsetWeekBkts: number
Number of weeks in which the constrained supply plan offsets the lead time, after converting the number of weeks to days. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
-
LifeCyclePhase: string
Maximum Length:
120
Name of lifecycle phase of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotControl: string
Read Only:
true
Maximum Length:4000
Meaning associated with the LotControlCode attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE. -
LotControlCode: integer
Read Only:
true
Value that identifies whether the item is lot controlled. Valid values are 1 and 2. If 1, then lot control isn't established for the item. If 2, then lot control is used to track inventory balances by the lot number. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE. -
LotExpirationControl: string
Read Only:
true
Maximum Length:4000
Meaning associated with the LotsExpiration attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL. -
LotsExpiration: integer
Read Only:
true
Value that identifies how lot expiration dates are calculated. Valid values are 1 and 2. If 1, then lots don't expire. If 2, then lot expiration is based on the number of shelf life days for the item. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL. -
MAD: number
Read Only:
true
Value of the mean absolute deviation for the item. -
MADOverride: number
Value that's the user override of the mean absolute deviation, where mean absolute deviation is a statistical formula used to measure the quantity deviation between actual and forecasted demand.
-
MakeOrBuy: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the item is manufactured or purchased. Valid values are Make or Buy. If Make, then the item is manufactured. If Buy, then the item is purchased. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
MAPE: number
Read Only:
true
Value of the mean absolute percentage error for the item. -
MAPEOverride: number
Value that's the user override of the mean absolute percentage error, where mean absolute percentage error is a statistical formula used to measure the percentage deviation between actual and forecasted demand.
-
MaximumOrderQuantity: number
Maximum order quantity of the item.
-
MinimumOrderQuantity: number
Minimum order quantity of the item.
-
NetSellingPrice: number
Read Only:
true
Selling price of an item after applying an average discount to the item's list price. -
NewPlanId: integer
Most recent value that uniquely identifies the plan.
-
NumberOfDaysForDemandCutoff: integer
Read Only:
true
The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value. -
ObsolescenceDate: string
(date)
Date when the item is obsolete.
-
OrderCost: number
Fixed costs that are associated with placing a sales order for the item.
-
OrderModifierToStartQuantity: integer
Value that indicates whether order modifiers are applied to start quantity or not. Valid values are: 1 or 2. If 1, then order modifiers are applied to start quantity. If 2, then not.
-
OrderModifierToStartQuantityMeaning: string
Read Only:
true
Maximum Length:4000
Value that determines whether the order modifier for the item should be applied to the start quantity of the supply for the item. Valid values are Yes or No. -
Organization: string
Maximum Length:
49
Abbreviation that identifies the organization associated with the item. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
PickComponents: integer
Read Only:
true
Value that indicates whether the item can be picked from finished goods inventory. Valid values are: 1 or 2. If 1, then the item can be picked from finished goods inventory. If 2, then not. -
PickComponentsMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the item can be picked from the finished goods inventory. Valid values are: Yes or No. If Yes, then the item can be picked from the finished goods inventory. If No, then the item can't be picked from the finished goods inventory. -
PlannedSafetyStockType: string
Read Only:
true
Maximum Length:4000
Type of safety stock planning used to calculate safety stock for the item and organization combination. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_SS_TYPE. -
PlannedSafetyStockTypeIndicator: integer
(int32)
Read Only:
true
Abbreviation that identifies the type of safety stock planning used to calculate safety stock for the item and organization combination. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_SS_TYPE. -
Planner: string
Maximum Length:
10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Read Only:
true
Maximum Length:4000
Description of the planner responsible for the item. -
PlanningMethod: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE. -
PlanningMethodCode: integer
Abbreviation that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE.
-
PlanningTimeFenceCode: integer
Abbreviation that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
-
PlanningTimeFenceDate: string
(date)
Read Only:
true
Date before which orders aren't rescheduled. -
PlanningTimeFenceDays: integer
Time horizon, in number of days, in which supply orders aren't scheduled to be due.
-
PlanningTimeFenceType: string
Read Only:
true
Maximum Length:4000
Value that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
PostprocessingLeadTime: number
Number of days required to make an item available in inventory once the supply is complete.
-
PreprocessingLeadTime: number
Number of days which must be added to purchasing or manufacturing lead time to place an order.
-
ProcessingLeadTime: number
Number of days required to procure or manufacture an item.
-
ReleaseTimeFenceCode: integer
Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
-
ReleaseTimeFenceDate: string
(date)
Read Only:
true
Date before which orders are automatically released as work orders or purchase requisitions. -
ReleaseTimeFenceDays: integer
Time horizon, in number of days, in which orders are automatically released as work orders or purchase requisitions.
-
ReleaseTimeFenceType: string
Read Only:
true
Maximum Length:4000
Value that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
Rounding: integer
Value that indicates whether planned order quantity is rounded to a whole number or not. Valid values are: 1 or 2. If 1, then planned order quantity is rounded. If 2, then not.
-
RoundingMeaning: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the planned order quantity is rounded to a whole number or not. Valid values are: Yes or No. If Yes, then the planned order quantity is rounded. If No, then the planned order quantity isn't rounded. -
RowModified: string
Read Only:
true
Maximum Length:255
Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified. -
SafetyStockCode: integer
Value that identifies the method that planning uses to calculate safety stock levels for the item. A list of accepted values is defined in the lookup type ORA_MSC_SS_PLANNING_METHD.
-
SafetyStockForecastPlan: string
Read Only:
true
Maximum Length:4000
Demand plan that contains the forecast and forecast error measures that the plan uses to calculate safety stock. -
SafetyStockPlanningMethod: string
Maximum Length:
4000
Meaning associated with the SafetyStockCode attribute. -
SafetyStockQuantity: number
Desired level of safety stock of an item.
-
SafetyStockQuantityOverride: number
Numeric value provided by the user to override the standard safety stock quantity of an item.
-
SellingPrice: number
Selling price of the item.
-
ServiceLevelPercent: number
Desired level of customer service, expressed as a percentage, in satisfying product demand. This represents the probability that an order can be filled from available inventory.
-
ShrinkageRate: number
Average amount of material you expect to lose when manufacturing or storing the item.
-
StandardCost: number
Standard cost of an item.
-
SupplyType: string
Read Only:
true
Maximum Length:4000
Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE. -
UnitVolume: number
Read Only:
true
Volume of one item. -
UnitWeight: number
Read Only:
true
Weight of one item. -
UOM: string
Read Only:
true
Maximum Length:4000
Planning unit of measure of the item. -
UseUpDate: string
(date)
Read Only:
true
Date when the current on-hand quantity for an item is exhausted based on projected gross requirements. -
VariableLeadTime: number
Time to produce one unit of an assembly.
-
VolumeUOMName: string
Read Only:
true
Maximum Length:4000
Unit of measure to use for the item volume. -
WeightUOMName: string
Read Only:
true
Maximum Length:4000
Unit of measure to use for the item weight.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningDemands-item-response
Type:
Show Source
object
-
Action: string
Read Only:
true
Maximum Length:80
Value that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS. -
ActionCode: integer
Read Only:
true
Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS. -
AssetNumber: string
Title:
Asset
Read Only:true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BillSequenceId: integer
(int64)
Value that uniquely identifies the sequence in which a component is used within an operation.
-
BOMItemType: integer
Name of the item type. Valid values include 1: Model, 2: Option Class, 3: Planning, 4: Standard, and 5: Product Family. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE.
-
BucketType: string
Title:
Bucket Type
Read Only:true
Maximum Length:7
Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG. -
Buyer: string
Title:
Buyer
Read Only:true
Name of the buyer associated with the item. -
CatalogId: integer
Read Only:
true
Value that uniquely identifies the catalog. -
CategoryId: integer
Read Only:
true
Value that uniquely identifies the category. -
CategoryName: string
Title:
Category
Read Only:true
Maximum Length:4000
Name of the category to which the item is assigned. -
ChildOrganization: string
Read Only:
true
Maximum Length:4000
Organization code of an organization that's modeled as a child organization with a modeled subinventory code. -
ChildOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the child organization. -
CompletedQuantity: number
Title:
Completed Quantity
Read Only:true
Sales order quantity that has already been completed. -
ComponentQuantityIssued: number
Title:
Component Quantity Issued
Read Only:true
Quantity of a component issued to a work order. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the order. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the order. -
Customer: string
Title:
Customer
Maximum Length:4000
Name of the customer associated with the sales order or forecast. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerPONumber: string
Read Only:
true
Maximum Length:50
Value that uniquely identifies the customer's purchase order number. -
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site.
-
DataSecurityEditAllowed: string
Read Only:
true
Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges. -
DaysLate: integer
(int64)
Title:
Days Late
Read Only:true
Number of days that the demand is late. -
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number of days that the demand date is in the past. -
DemandClass: string
Read Only:
true
Maximum Length:34
Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task. -
DemandClassCode: string
Title:
Demand Class
Maximum Length:400
Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS. -
DemandPriority: integer
(int64)
Title:
Order Priority
Priority of the demand. -
DestinationTimeZone: string
Title:
Destination Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization. -
DestOrgCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the destination organization of an order. -
EndDemandValue: number
Read Only:
true
Monetary value associated with the end demand. -
EndPeggedSupplies: array
End Pegged Supplies
Title:
End Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand. -
ExpenseDestinationTransfer: string
Read Only:
true
Maximum Length:100
Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination. -
ExpenseTransfer: number
Read Only:
true
Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination. -
FirmDate: string
(date)
Title:
Firm Date
Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmPlannedType: integer
(int32)
Title:
Firm Status
Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FirmQuantity: number
Title:
Firm Quantity
Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStatus: string
Read Only:
true
Maximum Length:200
Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FulfillmentLine: integer
Title:
Fulfillment Line
Read Only:true
Fulfillment line number associated with a sales order. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is implemented. -
ImplementDemandClass: string
Title:
Implement Demand Class
Maximum Length:30
Demand class associated with the order that will be used when the order is released. -
ImplementedQuantity: number
Title:
Implemented Quantity
Cumulative quantity that has been released to date. -
ImplementFirm: integer
Title:
Implement Firm
Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementFirmOption: string
Read Only:
true
Maximum Length:200
Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
ImplementQuantity: number
Title:
Implement Quantity
Order quantity for the released order. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
ImplementShipMethod: string
Maximum Length:
30
Value that identifies the shipping method used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementShippingMethod: string
Title:
Implement Shipping Method
Maximum Length:400
Value that indicates the shipping method used to ship the order when the order is released, or is a concatenation of carrier name, method of transportation, and service level used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementSourceOrganization: string
Title:
Implement Source Organization
Read Only:true
Maximum Length:100
Source organization for the released order. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
Item: string
Title:
Item
Maximum Length:300
Name of the item associated with the demand. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item associated with the demand. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the demand was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the demand. -
LatestAcceptableDate: string
(date)
Title:
Latest Acceptable Date
Read Only:true
Date beyond which the demand line must not be promised. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:100
Line number associated with the demand. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Title:
Lot
Read Only:true
Maximum Length:80
Lot number associated with an expired on-hand lot. -
MakeOrBuy: string
Read Only:
true
Maximum Length:200
Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
MarkForReleaseOption: string
Value that indicates the release status of the order. Valid values are 1: Marked For Release, 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
-
MaterialAvailableDate: string
(date)
Title:
Material Available Date
Read Only:true
Date when the total quantity is available. -
Message: string
Read Only:
true
Text of the error message, if any, encountered when creating or updating a demand. -
ModeOfTransport: integer
(int64)
Value that uniquely identifies the mode of transportation used to ship a demand line from the ship-from organization or drop ship supplier to the customer site. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_MODE_OF_TRANSPORT.
-
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date by when the demand quantity is needed. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Date when the demand quantity was originally due. This attribute value is extracted from the source application. -
OperationSequenceNumber: integer
Read Only:
true
Number that identifies the execution sequence of the operation. -
OrderDateType: string
Title:
Order Date Type
Read Only:true
Maximum Length:4000
Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE. -
OrderDateTypeCode: integer
Read Only:
true
Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Order number associated with the sales order. -
OrderQuantity: number
Title:
Order Quantity
Read Only:true
Quantity associated with the demand. -
OrderType: integer
(int32)
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
-
OrderTypeText: string
Title:
Order Type
Maximum Length:4000
Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Title:
Organization
Maximum Length:49
Name of the organization associated with the order. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationTimeZone: string
Title:
Organization Time Zone
Read Only:true
Maximum Length:100
Time zone of the organization associated with the demand. -
OrgCurrencyCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the base currency of the organization. -
OriginalItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requested item. -
OriginalItemQuantity: number
Title:
Original Item Quantity
Read Only:true
Demand quantity of the original item, which may be different from the order quantity, if substitution is allowed. -
OriginalNeedByDate: string
(date)
Title:
Original Need-by Date
Read Only:true
Date when the order is needed. This value is extracted from the source application. -
OriginalOrderQuantity: number
Title:
Original Order Quantity
Read Only:true
Quantity associated with the order. This value is extracted from the source application. -
OverrideDemandPriority: number
Title:
Override Demand Priority
Override priority of end demands such as sales order, forecast, and manual demand. -
ParentModel: string
Title:
Parent Model
Read Only:true
Maximum Length:200
Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option. -
PeggedSupplies: array
Pegged Supplies
Title:
Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand. -
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
PlannedArrivalDate: string
(date)
Title:
Planned Arrival Date
Read Only:true
Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar. -
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:100
Description of the planner responsible for the item. -
PlanningAttributes: array
Planning Attributes
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply. -
PlanningMakeBuyCode: integer
Title:
Make or Buy
Read Only:true
Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
ProjectGroupValue: string
Maximum Length:
4000
Value that identifies the project group. -
ProjectGroupValueId: integer
(int64)
Value that uniquely identifies the ID of the project group associated with the demand in the exception of an attribute-based plan.
-
ProjectValue: string
Maximum Length:
4000
Value that identifies the project. -
ProjectValueId: integer
(int64)
Value that uniquely identifies the ID of the project associated with the demand in the exception of an attribute-based plan.
-
PromisedArrivalDate: string
(date)
Title:
Promised Arrival Date
Read Only:true
Date when a customer has been promised the delivery of the order. -
PromisedShipDate: string
(date)
Title:
Promised Ship Date
Read Only:true
Date when a customer has been promised the shipping of the order. -
QuantityByDueDate: number
Title:
Quantity by Due Date
Read Only:true
Quantity that can be provided by the due date. For example, the order quantity may be 100 units, but only 50 units may be available by the due date. -
QuantityInProcess: number
Title:
Quantity in Process
Read Only:true
Quantity that's in process of being released. -
ReleaseErrors: string
Read Only:
true
Maximum Length:400
Errors that are generated in the release process. -
ReleaseStatus: integer
Title:
Release Status
Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseStatusText: string
Read Only:
true
Maximum Length:80
Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
RequestedArrivalDate: string
(date)
Title:
Requested Arrival Date
Read Only:true
Date when the material must arrive at the customer site. -
RequestedItem: string
Title:
Requested Item
Read Only:true
Maximum Length:4000
Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand. -
RequestedItemDescription: string
Title:
Requested Item Description
Read Only:true
Maximum Length:4000
Description of the item that's being requested. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Read Only:true
Date when the material must be shipped out to the customer. -
Rescheduled: string
Read Only:
true
Maximum Length:200
Value that indicates whether or not the order has been rescheduled. Contains one of the following values: Yes or No. If Yes, then the order has been rescheduled. If No, then the order hasn't been rescheduled. -
RescheduledOption: integer
Title:
Rescheduled
Value that indicates whether the order has been rescheduled or not. Contains one of the following values: 1 or 2. If 1, then the order has been rescheduled. If 2, then the order hasn't been rescheduled. -
ReservedQuantity: number
Title:
Reserved Quantity
Read Only:true
Quantity that has been reserved against an order. -
RowModified: string
Read Only:
true
Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified. -
ScheduledArrivalDate: string
(date)
Title:
Scheduled Arrival Date
Read Only:true
Date when the demand has been scheduled to arrive at a customer site. -
ScheduledShipDate: string
(date)
Title:
Scheduled Ship Date
Read Only:true
Date when the demand has been scheduled to be shipped. -
ScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:4000
Name of the supply or demand schedule associated with an order. -
SegmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the segment. -
SegmentName: string
Title:
Segment
Read Only:true
Maximum Length:120
Name of the segment used for a set of items. -
SellingPrice: number
Read Only:
true
Selling price of an item on the order line. -
ServiceLevel: integer
(int64)
Value that uniquely identifies the service level to use to ship a demand line from the ship-from organization or drop ship supplier to the customer site. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_SERVICE_LEVELS.
-
ShipCalendar: string
Read Only:
true
Maximum Length:15
Shipping calendar associated with the order. -
ShipMethod: string
Maximum Length:
30
Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShippingMethod: string
Title:
Shipping Method
Maximum Length:4000
Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShipTo: string
Title:
Ship To
Read Only:true
Maximum Length:4000
Abbreviation that indicates the specific ship-to location. -
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set used in the plan, if any.
-
SourceOrder: string
Title:
Source Order
Read Only:true
Maximum Length:50
Value that identifies the order number in the source application against which fulfillment line has been created. -
SourceOrderLine: string
Title:
Source Order Line
Read Only:true
Maximum Length:50
Value that identifies the order line number in the source application against which fulfillment line has been created. -
SourceOrganization: string
Title:
Source Organization
Maximum Length:49
Organization that will source the order. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceTablePrimary: string
Maximum Length:
12
Value that identifies the data table source of the supply. -
SourceTimeZone: string
Title:
Source Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization. -
Subinventory: string
Title:
Subinventory
Read Only:true
Maximum Length:40
Subinventory code associated with the demand. -
SuggestedDueDate: string
(date)
Title:
Suggested Due Date
Read Only:true
Date when the demand is recommended to be completed. -
SuggestedOrderDate: string
(date)
Title:
Suggested Order Date
Read Only:true
Date when the order is recommended to be placed. -
SuggestedShipDate: string
(date)
Title:
Suggested Ship Date
Read Only:true
Date when the order is recommended to be shipped. -
Supplier: string
Title:
Supplier
Maximum Length:4000
Name of the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier ship-from location. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
TaskValueId: integer
(int64)
Value that uniquely identifies the ID of the task associated with the demand in the exception of an attribute-based plan.
-
TransactionId: integer
(int64)
Value that uniquely identifies the demand. This value is internally generated by the application.
-
TransitLeadTime: number
Title:
Transit Lead Time
Read Only:true
Number of days that the demand is in transit between two locations. -
UnitNumber: string
Title:
Unit Number
Read Only:true
Maximum Length:30
Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number. -
UnmetDemandQuantity: number
Title:
Unmet Demand Quantity
Read Only:true
Quantity of demand that's not satisfied. -
UOM: string
Read Only:
true
Maximum Length:200
Name of the unit of measure that's associated with the order quantity. -
UOMCode: string
Title:
UOM
Read Only:true
Abbreviation that identifies the unit of measure associated with the order quantity. -
UsingAssembly: string
Title:
Using Assembly
Maximum Length:4000
For component demands, this field refers to the assembly item that uses this item as a component. -
Zone: string
Title:
Zone
Read Only:true
Maximum Length:400
Region or zone where the demand quantity is being shipped.
Nested Schema : End Pegged Supplies
Type:
array
Title:
End Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pegged Supplies
Type:
array
Title:
Pegged Supplies
The End Pegged Supplies resource manages all the supplies that are end pegged to a specific planning demand.
Show Source
Nested Schema : Planning Attributes
Type:
array
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningDemands-EndPeggedSupplies-item-response
Type:
Show Source
object
-
Item: string
Read Only:
true
Maximum Length:4000
Name of the item associated with the supply. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the supply. -
OrderTypeText: string
Read Only:
true
Maximum Length:4000
Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Read Only:
true
Maximum Length:4000
Name of the organization associated with the order. -
PeggedQuantity: number
Read Only:
true
Quantity of supply that's pegged to this demand. -
PeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association with the end pegged supply. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when the supply is expected to be completed. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the end pegged supply.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningDemands-PeggedSupplies-item-response
Type:
Show Source
object
-
Item: string
Read Only:
true
Maximum Length:4000
Name of the item associated with the supply. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the supply. -
OrderTypeText: string
Read Only:
true
Maximum Length:4000
Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Read Only:
true
Maximum Length:4000
Name of the organization associated with the order. -
PeggedQuantity: number
Read Only:
true
Quantity of supply that's pegged to this demand. -
PeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association with the pegged supply. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that uniquely identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when the supply is expected to be completed. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pegged supply.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningDemands-PlanningAttributes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Title:
Order Number
Maximum Length:4000
Number that identifies the order associated with the demand or supply. -
PlanningAttributeNumber10: string
Maximum Length:
4000
Value for the planning attribute number 10 in attribute-based planning. -
PlanningAttributeNumber11: string
Maximum Length:
4000
Value for the planning attribute number 11 in attribute-based planning. -
PlanningAttributeNumber12: string
Maximum Length:
4000
Value for the planning attribute number 12 in attribute-based planning. -
PlanningAttributeNumber13: string
Maximum Length:
4000
Value for the planning attribute number 13 in attribute-based planning. -
PlanningAttributeNumber14: string
Maximum Length:
4000
Value for the planning attribute number 14 in attribute-based planning. -
PlanningAttributeNumber15: string
Maximum Length:
4000
Value for the planning attribute number 15 in attribute-based planning. -
PlanningAttributeNumber3: string
Maximum Length:
4000
Value for the planning attribute number 3 in attribute-based planning. -
PlanningAttributeNumber4: string
Maximum Length:
4000
Value for the planning attribute number 4 in attribute-based planning. -
PlanningAttributeNumber5: string
Maximum Length:
4000
Value for the planning attribute number 5 in attribute-based planning. -
PlanningAttributeNumber6: string
Maximum Length:
4000
Value for the planning attribute number 6 in attribute-based planning. -
PlanningAttributeNumber7: string
Maximum Length:
4000
Value for the planning attribute number 7 in attribute-based planning. -
PlanningAttributeNumber8: string
Maximum Length:
4000
Value for the planning attribute number 8 in attribute-based planning. -
PlanningAttributeNumber9: string
Maximum Length:
4000
Value for the planning attribute number 9 in attribute-based planning. -
TransactionId: integer
(int64)
Value that uniquely identifies the demand or supply. This value is internally generated by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningSupplies-item-response
Type:
Show Source
object
-
Action: string
Read Only:
true
Maximum Length:80
Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS. -
ActionCode: integer
Read Only:
true
Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS. -
AlternateBOMDesignator: string
Maximum Length:
4000
Name of the alternate bill of material. -
AlternateFacilityUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate facility. Valid values are Yes or No. If Yes, then the planned order uses an alternate facility. If No, then the planned order doesn't use an alternate facility. Only applicable for constrained plans. -
AlternateResourceUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate resource. Valid values are Yes or No. If Yes, then the planned order uses an alternate resource. If No, then the planned order doesn't use an alternate resource. Only applicable for constrained plans. -
AlternateRoutingDesignator: string
Maximum Length:
400
Name of a routing used for the make order. -
AlternateSupplierUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate supplier. Valid values are Yes or No. If Yes, then the planned order uses an alternate supplier. If No, then the planned order doesn't use an alternate supplier. Only applicable for constrained plans. -
AlternateWorkDefinitionUsed: string
Read Only:
true
Maximum Length:4000
Indicates whether the planned order uses an alternate work definition. Valid values are Yes or No. If Yes, then the planned order uses an alternate work definition. If No, then the planned order doesn't use an alternate work definition. Only applicable for constrained plans. -
AltFacilityUsed: integer
Title:
Alternate Facility Used
Read Only:true
Value that indicates whether the planned order uses an alternate facility or not. -
AltResourceUsed: integer
Title:
Alternate Resource Used
Read Only:true
Value that indicates whether the planned order uses an alternate resource or not. -
AltSupplierUsed: integer
Title:
Alternate Supplier Used
Read Only:true
Value that indicates whether the planned order uses an alternate supplier or not. -
AltWorkDefinitionUsed: integer
Title:
Alternate Work Definition Used
Read Only:true
Value that indicates whether the planned order uses an alternate work definition or not. -
AssetNumber: string
Title:
Asset
Read Only:true
Maximum Length:80
Number that identifies the asset associated with a maintenance work order. -
BatchQuantity: number
Title:
Batch Quantity
Read Only:true
Quantity that moves through operations in a process work order. -
BatchUOM: string
Title:
Batch Quantity UOM
Read Only:true
Maximum Length:30
Identifies the unit of measure for the batch quantity in a process work definition. -
BillSequenceId: integer
(int64)
Value that uniquely identifies the sequence in which a component is used within an operation.
-
BmtOption: integer
Title:
Buyer-Managed Transportation
Read Only:true
Contains one of the following values: 1 or 2. If 1, then the buyer is responsible for the transportation of the purchased item. If 2, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items. -
BOMItemType: integer
Read Only:
true
Name of the type of item. Valid values include 1: Model, 2: Option Class, 3: Planning, 4: Standard, or 5: Product Family. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE. -
Buyer: string
Title:
Buyer
Read Only:true
Name of the buyer associated to the item. -
BuyerManagedTransportation: string
Read Only:
true
Maximum Length:200
Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items. -
Canceled: integer
Read Only:
true
Value that indicates whether the supply has been canceled. -
CanceledText: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the supply has been canceled. Valid values are: Yes or No. If Yes, then the supply has been canceled. If No, then the supply hasn't been canceled. -
CarrierId: integer
(int64)
Value that uniquely identifies the carrier.
-
CatalogId: integer
Read Only:
true
Value that uniquely identifies the catalog. -
CategoryId: integer
Read Only:
true
Value that uniquely identifies the category. -
CategoryName: string
Title:
Category
Read Only:true
Maximum Length:4000
Name of the category to which the item is assigned. -
ChildOrganization: string
Read Only:
true
Maximum Length:4000
Organization code of an organization that's modeled as a child organization with a modeled subinventory code. -
ChildOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the child organization. -
ClusterId: integer
(int64)
Value that uniquely identifies the cluster.
-
CompletedQuantity: number
Title:
Completed Quantity
Read Only:true
Quantity of the work order that's already completed. -
ComponentQuantityIssued: number
Title:
Component Quantity Issued
Read Only:true
Quantity of a component issued to a work order. -
CompressionDays: number
Title:
Compression Days
Read Only:true
Number of days prior to the plan start date that the order has to be scheduled to be considered on time. -
ConsumptionStartDate: string
(date)
Title:
Consumption Start Date
Read Only:true
Date when a supply starts being consumed by demands. -
ContributesDmdLateness: number
Title:
Contributes to Demand Lateness
Read Only:true
Indicates whether the supply is on the critical path leading to a demand that's satisfied late. Valid values are 1 or 2. If 1, then the supply is on the critical path leading to a demand that's satisfied late. If 2, then the supply isn't on the critical path leading to a demand that's satisfied late. Only applicable for constrained plans. -
ContributesOverload: number
Title:
Contributes to Overload
Read Only:true
Indicates whether the supply contributes to a capacity overload. Valid values are 1 or 2. If 1, then the supply contributes to a capacity overload. If 2, then the supply doesn't contribute to a capacity overload. Only applicable for constrained plans. -
ContributesToDemandLateness: string
Read Only:
true
Meaning associated with the ContributesDmdLateness attribute. Value values are Yes and No. -
ContributesToOverload: string
Read Only:
true
Maximum Length:4000
Meaning associated with the ContributesOverload attribute. Value values are Yes and No. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the order. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the order. -
CumulativeYield: number
Title:
Cumulative Yield
Read Only:true
Name of the column that contains the cumulative yield. For example, the name of the column in the Supplies and Demands view. This column is the product of operation yields of all the operations in the work definition of an item. -
Customer: string
Title:
Customer
Maximum Length:4000
Name of the customer associated with the drop ship purchase order. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site.
-
DataSecurityEditAllowed: string
Read Only:
true
Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges. -
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number of days that the supply date is in the past. -
DestinationTimeZone: string
Title:
Destination Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization. -
DestinationType: string
Read Only:
true
Maximum Length:200
Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE. -
DestOrgCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the destination organization for an order. -
DropShipDestType: integer
Title:
Destination Type
Code that identifies where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE. -
EarliestStartDate: string
(date)
Title:
Earliest Start Date
Read Only:true
Earliest date on which a supply can start based on the lead times of all its upstream supplies, or its planning time-fence date, or based on the constrained capacity of a resource or supplier. This date is calculated by constraint-based plans -
ExpectedScrapQuantity: number
Title:
Expected Scrap Quantity
Read Only:true
Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped. -
ExpenseDestinationTransfer: string
Read Only:
true
Maximum Length:100
Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination. -
ExpenseTransfer: number
Read Only:
true
Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination. -
ExpirationDate: string
(date)
Title:
Expiration Date
Date when the existing lot associated with the supply expires. -
FgOrderType: integer
Value used by the planning engine to identify the type of order at a more granular level than the OrderType attribute.
-
FirmComponents: string
Read Only:
true
Contains one of the following values: Yes or No. If Yes, then the make order has an associated firm component. If No, then the make order doesn't have an associated firm component. -
FirmDate: string
(date)
Title:
Firm Date
Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmPlannedType: integer
(int32)
Title:
Firm Status
Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FirmQuantity: number
Title:
Firm Quantity
Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmResources: string
Read Only:
true
Contains one of the following values: Yes or No. If Yes, then the make order has an associated firm resource. If No, then the make order doesn't have an associated firm resource. -
FirmStartDate: string
(date)
Date when supply begins. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
-
FirmStartQuantity: number
Title:
Firm Start Quantity
User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStatus: string
Title:
Firm Status
Maximum Length:200
Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
HasFirmComponent: integer
Read Only:
true
Contains one of the following values: 1 or 2. If 1, then the make order has an associated firm component. If 2, then the make order doesn't have an associated firm component. -
HasFirmResource: integer
Read Only:
true
Contains one of the following values: 1 or 2. If 1, then the make order has an associated firm resource. If 2, then the make order doesn't have an associated firm resource. -
HoldDate: string
(date)
Title:
Hold Date
Read Only:true
Date on which the on-hand inventory lot is no longer on hold. -
ImplementAlternateBOM: string
Maximum Length:
100
Name of an alternate, nonprimary item structure that will be used when the order is released. -
ImplementAlternateRouting: string
Maximum Length:
100
Name of a routing that will be used when the order is released. -
ImplementAs: integer
Title:
Implement Order Type
Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is released. -
ImplementDockDate: string
(date)
Title:
Implement Dock Date
Date when the material should be on the receiving dock when the order is released. -
ImplementedQuantity: number
Title:
Implemented Quantity
Cumulative quantity that has been released to date. -
ImplementFirm: integer
Title:
Implement Firm
Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementFirmOption: string
Read Only:
true
Maximum Length:200
Status to use when the order is released. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
ImplementItemStructure: string
Title:
Implement Item Structure Name
Maximum Length:4000
Name of the item structure for the order that's released. -
ImplementJobName: string
Title:
Implement Work Order Number
Maximum Length:120
Job name of the work order to be created when the order is released. -
ImplementLocation: string
Title:
Implement Location
Maximum Length:400
Value that identifies the deliver-to location to use when the order is released. -
ImplementLocationId: integer
(int64)
Value that uniquely identifies the deliver-to location to use when the order is released.
-
ImplementOrderType: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of order to use when the order is released. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS. -
ImplementQuantity: number
Title:
Implement Quantity
Quantity of the order that's released. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
ImplementShipMethod: string
Maximum Length:
30
Value that indicates the shipping method to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementShippingMethod: string
Title:
Implement Shipping Method
Maximum Length:400
Value that indicates the shipping method to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ImplementSourceOrganization: string
Title:
Implement Source Organization
Maximum Length:100
Source organization used for the order that's released. -
ImplementSourceOrgId: integer
(int64)
Value that uniquely identifies the source organization to use when the order is released.
-
ImplementStatus: string
Title:
Implement Status
Read Only:true
Maximum Length:200
Status of the order to use when the order is released. Valid Values are Unreleased or Released. -
ImplementStatusCode: integer
Title:
Implement Status
Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released. -
ImplementSupplier: string
Title:
Implement Supplier
Maximum Length:360
Name of the supplier for the order that's released. -
ImplementSupplierSite: string
Title:
Implement Supplier Site
Maximum Length:300
Abbreviation that indicates the specific supplier ship-from location to use when the order is released. -
ImplementVendorId: integer
(int64)
Value that uniquely identifies the supplier to use when the order is released.
-
ImplementVendorSiteId: integer
(int64)
Value that uniquely identifies the specific supplier ship-from location to use when the order is released.
-
ImplementWIPClassCode: string
Title:
Implement Work Order Subtype
Maximum Length:40
Value that indicates the subtype of the work order to be implemented. Valid values are 1: Standard production, 2: Repair, 3: Prototype, 4: Pilot lot, or 5: Test lot. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE. -
ImplementWorkDefinition: string
Title:
Implement Work Definition Name
Maximum Length:4000
Name of the work definition that's used when the order is released. -
ImplementWorkOrderSubtype: string
Title:
Implement Work Order Subtype
Read Only:true
Maximum Length:200
Meaning associated with the ImplementWIPClassCode attribute. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
Item: string
Title:
Item
Maximum Length:300
Name of the item associated with the supply. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item that's associated with the supply. -
ItemStructureName: string
Title:
Item Structure Name
Maximum Length:100
Name of the item structure planned to be used for the make order. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the order was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the supply. -
LatestStartDate: string
(date)
Title:
Latest Start Date
Read Only:true
Latest date on which a supply can start. This date is computed by offsetting the lead time of the supply from its need-by date. This date is calculated by constraint-based plans. -
LineNumber: string
Title:
Line Number
Read Only:true
Maximum Length:100
Number that identifies the order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Title:
Lot
Read Only:true
Maximum Length:80
Number that identifies the lot of the on-hand supply. -
MakeOrBuy: string
Read Only:
true
Maximum Length:100
Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
MarkForReleaseOption: string
Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
-
MaturityDate: string
(date)
Title:
Maturity Date
Read Only:true
Date when an inventory lot fully matures. It can then be used to fulfill demand. -
Message: string
Read Only:
true
Text of the error message, if any, encountered when creating or updating a supply. -
ModeOfTransport: integer
(int64)
Value that uniquely identifies the mode of transportation that's planned to be used to ship an order from the source organization or supplier. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_MODE_OF_TRANSPORT.
-
MtqSupplyDate: string
(date)
Title:
MTQ Supply Date
Read Only:true
Date when the first minimum transfer quantity supply of the upstream process is available for the downstream process. -
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date when the supply quantity is needed. -
OldDockDate: string
(date)
Title:
Old Dock Date
Read Only:true
Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Date when the order was originally due. This attribute value is extracted from the source application. -
OperationSequenceNumber: integer
Read Only:
true
Number that identifies the execution sequence of the operation. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:4000
Number that identifies the order associated with the supply. -
OrderQuantity: number
Title:
Order Quantity
Read Only:true
Quantity associated with the supply. -
OrderStatus: string
Read Only:
true
Maximum Length:200
SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process. -
OrderType: integer
(int32)
Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
-
OrderTypeText: string
Title:
Order Type
Maximum Length:4000
Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Title:
Organization
Maximum Length:49
Name of the organization associated with the order. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationTimeZone: string
Title:
Organization Time Zone
Read Only:true
Maximum Length:100
Time zone associated with an organization. -
OrgCurrencyCode: string
Read Only:
true
Abbreviation that identifies the base currency of the organization. -
OriginalItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requested item. -
OriginalItemName: string
Title:
Requested Item
Read Only:true
Maximum Length:4000
Name of the requested item associated with the demand. -
OriginalNeedByDate: string
(date)
Title:
Original Need-by Date
Read Only:true
Date when the order was originally needed. This value is extracted from the source application. -
OriginalOrderQuantity: number
Title:
Original Order Quantity
Read Only:true
Original quantity associated with the order. This value is extracted from the source application. -
ParentModel: string
Title:
Parent Model
Read Only:true
Maximum Length:200
Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option. -
PeggedDemands: array
Pegged Demands
Title:
Pegged Demands
The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level. -
PeggedToFirm: number
Title:
Pegged to Firm
Read Only:true
Indicates whether the supply pegs to a downstream supply that's firm. Valid values are 1 or 2. If 1, then the supply pegs to a downstream supply that's firm. If 2, then it doesn't peg to a downstream supply that's firmed. -
PeggedToFirmText: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the supply pegs to a downstream supply that's firm. Valid values are: Yes or No. If Yes, then supply is pegged to a downstream supply that's firm. If No, then it isn't pegged to a downstream supply that's firmed. -
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:100
Description of the planner responsible for the item. -
PlanningAttributes: array
Planning Attributes
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply. -
PlanningMakeBuyCode: integer
Title:
Make or Buy
Read Only:true
Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
ProcessName: string
Title:
Process Name
Read Only:true
Maximum Length:120
Name of the manufacturing process used for this work order or planned order. -
ProcessSequenceId: integer
(int64)
Value that uniquely identifies the manufacturing process that was used for the make order.
-
ProjectGroupValue: string
Maximum Length:
4000
Value that identifies the project group. -
ProjectGroupValueId: integer
(int64)
Value that uniquely identifies the ID of the project group associated with the demand in the exception of an attribute-based plan.
-
ProjectValue: string
Maximum Length:
4000
Value that identifies the project. -
ProjectValueId: integer
(int64)
Value that uniquely identifies the ID of the project associated with the demand in the exception of an attribute-based plan.
-
PromisedArrivalDate: string
(date)
Title:
Promised Arrival Date
Date when a customer has been promised the delivery of the order. -
PromisedShipDate: string
(date)
Title:
Promised Ship Date
Date when a customer has been promised the shipping of the order. -
QuantityInProcess: number
Title:
Quantity in Process
Quantity that's in the process of being released. -
ReadyToBuildPercentage: number
Title:
Ready-to-Build Percentage
Read Only:true
Percent of order quantity that can be built with currently available material. -
ReadyToBuildQuantity: number
Read Only:
true
Number of units of an assembly item for which components are available on hand. -
ReleaseErrors: string
Read Only:
true
Maximum Length:400
Errors that are generated in the release process. -
ReleaseStatus: integer
Title:
Release Status
Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseStatusText: string
Read Only:
true
Maximum Length:80
Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseTimeFenceCode: integer
Read Only:
true
Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
RemainingQuantity: number
Read Only:
true
Work order quantity that remains to be completed. -
ReplInvRebalanceOption: 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.
-
RequestedArrivalDate: string
(date)
Title:
Requested Arrival Date
Date when the material must arrive at the customer site. -
RequestedItem: string
Title:
Requested Item
Read Only:true
Maximum Length:4000
Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand. -
RequestedItemDescription: string
Title:
Requested Item Description
Read Only:true
Maximum Length:4000
Description of the item that's being requested. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Date when the material must be shipped out to the customer. -
Rescheduled: string
Read Only:
true
Maximum Length:100
Value that indicates whether the order has been rescheduled. Contains one of the following values: Yes or No. If Yes, then the order has been rescheduled. If No, then the order hasn't been rescheduled. -
RescheduleDays: number
Title:
Reschedule Days
Read Only:true
Number of days to reschedule for a supply order. The reschedule days is the difference between the original due date and the revised due date. A negative value indicates the order is rescheduled to an earlier date. -
RescheduledOption: integer
Title:
Rescheduled
Value that indicates whether the order has been rescheduled or not. Contains one of the following values: 1 or 2. If 1, then the order has been rescheduled. If 2, then the order hasn't been rescheduled. -
ReservationType: string
Read Only:
true
Value that indicates whether the supply order has been reserved to a demand. Valid values are 1 or 2. If 1, then the supply is reserved to one or more demands. If 2, then planning is suggesting that the supply be reserved to one or more demands. A list of accepted values is defined in the lookup type ORA_MSC_RESERVATION_TYPE. -
ReservedQuantity: number
Title:
Reserved Quantity
Read Only:true
Quantity that's reserved against an order. -
RoutingSequenceId: integer
(int64)
Value that uniquely identifies the routing that was used for the make order.
-
RowModified: string
Read Only:
true
Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified. -
ScheduledShipDate: string
(date)
Title:
Scheduled Ship Date
Read Only:true
Date when the order is scheduled to be shipped. -
ScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:4000
Name of the supply schedule associated with an order. -
ScrappedQuantity: number
Title:
Scrapped Quantity
Read Only:true
Work order quantity that has been scrapped. -
SegmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the segment. -
SegmentName: string
Title:
Segment
Read Only:true
Maximum Length:120
Name of the segment used for a set of items. -
SellingPrice: number
Read Only:
true
Selling price of an item on the order line. -
ServiceLevel: integer
(int64)
Value that uniquely identifies the service level to use to ship an order from the source organization or supplier. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_SERVICE_LEVELS.
- SharedSupply: number
- SharedSupplyText: string
-
ShipCalendar: string
Read Only:
true
Maximum Length:15
Shipping calendar associated with the order. -
ShipMethod: string
Maximum Length:
30
Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShippingMethod: string
Title:
Shipping Method
Maximum Length:4000
Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab. -
ShipTo: string
Title:
Ship To
Read Only:true
Maximum Length:4000
Abbreviation that identifies the specific ship-to location. -
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set used in the plan, if any.
-
SourceOrganization: string
Title:
Source Organization
Maximum Length:49
Organization that will source the order. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceTablePrimary: string
Maximum Length:
12
Value that identifies the data table source of the supply. -
SourceTimeZone: string
Title:
Source Time Zone
Read Only:true
Maximum Length:100
Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization. -
SourceType: integer
Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.
-
StartQuantity: number
Title:
Start Quantity
Quantity at the beginning of a manufacturing process. -
Subinventory: string
Title:
Subinventory
Maximum Length:40
Subinventory code associated with the supply. -
SubinventoryCodeOfChildOrg: string
Read Only:
true
Maximum Length:40
Subinventory code of an organization that's a modeled as a child of a parent organization, and from which supply is recast into a modeled subinventory in its parent organization. -
SubstItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute item. -
SubstituteComponentUsed: integer
Title:
Substitute Component Used
Read Only:true
Value that indicates whether the planned order uses a substitute component or not. -
SubstituteComponentUsedText: string
Read Only:
true
Maximum Length:4000
Meaning associated with the SubstituteComponentUsed attribute. Valid values are Yes and No. -
SuggestedCompletionDate: string
(date)
Title:
Suggested Completion Date
Read Only:true
Date when the process work order or a planned order completed. This attribute is required because the primary product can be produced in an operation that's prior to the last operation of the order. -
SuggestedDockDate: string
(date)
Title:
Suggested Dock Date
Read Only:true
Date when the order is recommended to arrive at the receiving dock. -
SuggestedDueDate: string
(date)
Title:
Suggested Due Date
Read Only:true
Date when a supply is expected to be completed. -
SuggestedOrderDate: string
(date)
Title:
Suggested Order Date
Read Only:true
Date when an order is recommended to be placed. -
SuggestedShipDate: string
(date)
Title:
Suggested Ship Date
Read Only:true
Date when the order is recommended to be shipped. -
SuggestedStartDate: string
(date)
Title:
Suggested Start Date
Read Only:true
Date when work on the order is recommended to begin. -
SuppliedItem: string
Title:
Supplied Item
Read Only:true
Maximum Length:4000
Name of the supplied item. -
SuppliedItemDescription: string
Title:
Supplied Item Description
Read Only:true
Maximum Length:4000
Description of the supplied item. -
Supplier: string
Title:
Supplier
Maximum Length:4000
Name of the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier location from where the item is being sourced. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
TaskValueId: integer
(int64)
Value that uniquely identifies the ID of the task associated with the demand in the exception of an attribute-based plan.
-
TransactionId: integer
(int64)
Value that uniquely identifies the supply transaction. This value is internally generated by the application.
-
TransitLeadTime: number
Title:
Transit Lead Time
Read Only:true
Number of days that the supply is in transit between two locations. -
UOM: string
Read Only:
true
Maximum Length:200
Name of the unit of measure associated with the order quantity. -
UOMCode: string
Title:
UOM
Read Only:true
Abbreviation that identifies the unit of measure associated with the order quantity. -
UpstreamSupplies: array
Upstream Supplies
Title:
Upstream Supplies
The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream. -
UsesOrderModifier: number
Title:
Uses Order Modifier
Read Only:true
Meaning associated with the UsesOrderModifierIndicator attribute. Valid values are Yes and No. -
UsesOrderModifierText: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the supply quantity has been determined by applying an order modifier. Valid values are: Yes or No. If Yes, then an order modifier was applied to the supply quantity. If No, then it hasn't. -
WIPStatusCode: integer
Read Only:
true
Code that identifies the status of the work order. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS. -
WIPSupplyType: integer
(int64)
Read Only:
true
Type of supply transaction created when issuing items from inventory to work orders. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE. -
WorkDefinition: string
Title:
Work Definition
Maximum Length:100
Name that uniquely identifies a work definition used for a make order. -
WorkMethod: string
Read Only:
true
Maximum Length:4000
Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing. -
WorkMethodCode: integer
Title:
Work Method
Type of manufacturing used for the production process. Valid values are 1: Discrete Manufacturing and 2: Process Manufacturing. -
WorkOrderStatus: string
Title:
Work Order Status
Read Only:true
Maximum Length:4000
Value that indicates the status of the work order. Valid values include Unreleased, Released, Complete, or On hold. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS. -
Zone: string
Title:
Zone
Read Only:true
Maximum Length:400
Region or zone where the demand quantity is being shipped.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pegged Demands
Type:
array
Title:
Pegged Demands
The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level.
Show Source
Nested Schema : Planning Attributes
Type:
array
Title:
Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Show Source
Nested Schema : Upstream Supplies
Type:
array
Title:
Upstream Supplies
The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningSupplies-PeggedDemands-item-response
Type:
Show Source
object
-
DemandId: integer
(int64)
Read Only:
true
Value that identifies the pegged demand. -
EndDemandId: integer
(int64)
Read Only:
true
Value that identifies the end pegged independent demand. -
EndDemandOrderNumber: string
Read Only:
true
Maximum Length:400
Number that identifies the order associated with the pegged independent demand. -
Item: string
Read Only:
true
Maximum Length:400
Name of the item associated with the supply. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:400
Number that identifies the order associated with the demand. -
OrderQuantity: number
Read Only:
true
Quantity associated with the demand. -
OrderTypeText: string
Read Only:
true
Maximum Length:400
Type of demand such as forecast or sales order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Read Only:
true
Maximum Length:400
Name of the organization associated with the demand. -
PeggedQuantity: number
Read Only:
true
Quantity of the supply that's pegged to this demand. -
PeggingId: integer
(int64)
Read Only:
true
Value that identifies the association of the supply with the pegged demand. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when a demand is expected to be satisfied.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningSupplies-PlanningAttributes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Title:
Order Number
Maximum Length:4000
Number that identifies the order associated with the demand or supply. -
PlanningAttributeNumber10: string
Maximum Length:
4000
Value for the planning attribute number 10 in attribute-based planning. -
PlanningAttributeNumber11: string
Maximum Length:
4000
Value for the planning attribute number 11 in attribute-based planning. -
PlanningAttributeNumber12: string
Maximum Length:
4000
Value for the planning attribute number 12 in attribute-based planning. -
PlanningAttributeNumber13: string
Maximum Length:
4000
Value for the planning attribute number 13 in attribute-based planning. -
PlanningAttributeNumber14: string
Maximum Length:
4000
Value for the planning attribute number 14 in attribute-based planning. -
PlanningAttributeNumber15: string
Maximum Length:
4000
Value for the planning attribute number 15 in attribute-based planning. -
PlanningAttributeNumber3: string
Maximum Length:
4000
Value for the planning attribute number 3 in attribute-based planning. -
PlanningAttributeNumber4: string
Maximum Length:
4000
Value for the planning attribute number 4 in attribute-based planning. -
PlanningAttributeNumber5: string
Maximum Length:
4000
Value for the planning attribute number 5 in attribute-based planning. -
PlanningAttributeNumber6: string
Maximum Length:
4000
Value for the planning attribute number 6 in attribute-based planning. -
PlanningAttributeNumber7: string
Maximum Length:
4000
Value for the planning attribute number 7 in attribute-based planning. -
PlanningAttributeNumber8: string
Maximum Length:
4000
Value for the planning attribute number 8 in attribute-based planning. -
PlanningAttributeNumber9: string
Maximum Length:
4000
Value for the planning attribute number 9 in attribute-based planning. -
TransactionId: integer
(int64)
Value that uniquely identifies the demand or supply. This value is internally generated by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-PlanningSupplies-UpstreamSupplies-item-response
Type:
Show Source
object
-
Item: string
Read Only:
true
Maximum Length:4000
Name of the item associated with the upstream supply. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:4000
Number that identifies the order associated with the upstream supply. -
OrderQuantity: number
Read Only:
true
Quantity associated with the upstream supply. -
OrderTypeText: string
Read Only:
true
Maximum Length:4000
Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Read Only:
true
Maximum Length:4000
Name of the organization associated with the upstream supply. -
PeggedQuantity: number
Read Only:
true
Quantity of the upstream supply that's pegged to this supply. -
PeggingId: integer
(int64)
Read Only:
true
Value that identifies the association of this supply with the upstream supply. -
PreviousPeggingId: integer
(int64)
Read Only:
true
Value that identifies the next level of supply and demand in the supply chain. -
SuggestedDueDate: string
(date)
Read Only:
true
Date when a upstream supply is expected to be completed. -
TransactionId: integer
(int64)
Read Only:
true
Value that identifies the pegged upstream supply.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-ResourceExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
Title:
Action Taken
Read Only:true
Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2. -
AdditionalCapacityRequiredByConstraintDate: number
Title:
Additional Capacity Required by Date of Supplier Capacity Constraint
Read Only:true
Additional capacity to be added to the resource availability by the resource constraint date in the resource exception. -
AvailableCapacity: number
Title:
Available Capacity
Read Only:true
Available capacity of the resource in the resource exception. -
EndConstraintDate: string
(date)
Title:
Constraint End Date
Read Only:true
End constraint date of the resource requirement of the resource in the resource exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:120
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the resource exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionStoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the stored resource exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the exception detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: integer
(int64)
Title:
Notes
Contains information created or updated for an exception detail represented as notes. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the organization of an item for which an exception was calculated by the plan. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of an item in the exception -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
RequiredCapacity: number
Title:
Required Capacity
Read Only:true
Capacity required by the resource in the resource exception. -
ResourceCode: string
Title:
Resource
Read Only:true
Maximum Length:4000
Code of the resource in the resource exception. -
ResourceConstraintDate: string
(date)
Title:
Resource Constraint Date
Read Only:true
Capacity constraint date of the resource in the resource exception. -
ResourceId: integer
Read Only:
true
Value that uniquely identifies the resource in the resource exception. -
ResourceLoadRatio: number
Title:
Resource Load Ratio
Read Only:true
Load ratio of the resource in the resource exception. -
ResourceRequiredByConstraintDate: number
Title:
Resource Requirement by Resource Constraint Date
Read Only:true
Resource requirement of the resource by the resource constraint date in the resource exception. -
StartConstraintDate: string
(date)
Title:
Start Constraint Date
Read Only:true
Constraint start date of the resource requirement of the resource in the resource exception. -
StoreKey: string
Read Only:
true
Maximum Length:240
Name of the store key in the supply exception. -
WorkCenter: string
Title:
Work Center
Read Only:true
Maximum Length:4000
Code of the work center of the resource in the resource exception. -
WorkCenterId: integer
Read Only:
true
Value that uniquely identifies the work center of the resource in the resource exception.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-ResourceRequirements-item-response
Type:
Show Source
object
-
ActualStartDate: string
(date)
Read Only:
true
Actual operation start date. This is the first day that the resource is required for production. -
AlternateNumber: integer
Read Only:
true
Alternate number of the corresponding operation resource. -
AssemblyItemId: integer
(int64)
Read Only:
true
Assembly that uses the resource for the production generating resource requirement. -
AssignedUnits: number
Read Only:
true
Number of resource units assigned to perform the operation. For example assigned units of 2 means that two of that resource are used. -
CompileDesignator: string
Read Only:
true
Maximum Length:255
Name of the plan. -
ConstrDateAdditionalCap: number
Read Only:
true
Additional capacity required by the resource computed by the planning engine on the resource constraint date. -
ConstrDateResourceCapacity: number
Read Only:
true
Total capacity required by the resource computed by the planning engine on the resource constraint date. -
ConsumptionStartDate: string
(date)
Read Only:
true
Start date of the next resource requirement in the sequence. If this is the last resource requirement in the supply, then this date is the same as the consumption start date of the supply. -
ContributesDmdLateness: number
Read Only:
true
This attribute value is Yes, if the Need by Date - Earliest Start Date is less than the lead time of the resource requirement. -
ContributesDmdLatenessCode: string
Read Only:
true
Maximum Length:4000
Indicates whether the lead time of the resource requirement is greater than the difference between the need-by date and the earliest start date of the resource in a supply plan. If Yes, then it's greater. If no, then it isn't. The default value is Yes. -
ContributesOverload: number
Read Only:
true
The resource requirement has this attribute set to Yes if it belongs to a time bucket in which the resource capacity is overloaded. -
ContributesOverloadCode: string
Read Only:
true
Maximum Length:4000
Indicates whether the resource requirement belongs to a time bucket in which the resource capacity is overloaded in a supply plan. If Yes, then it does. If no, then it doesn't. The default value is Yes. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
CummulativeQuantity: number
Read Only:
true
Indicates the total resource requirement of the resource. -
DepartmentCode: string
Read Only:
true
Maximum Length:120
Value that uniquely identifies the department that the resource belongs to. -
DepartmentId: integer
(int64)
Read Only:
true
Department identifier or the work center of the resource. -
Description: string
Read Only:
true
Maximum Length:4000
Description of the resource. -
EarliestStartDate: string
(date)
Read Only:
true
Earliest start date for improved exceptions. -
EndDate: string
(date)
Read Only:
true
End date of the resource requirement. The resource isn't required after this date. -
ExecutionSequence: number
Read Only:
true
Indicates the execution sequence number of the operation if the work order has resequence operations. -
FirmEndDate: string
(date)
Read Only:
true
End date marked as firm so that it doesn't change during replan. -
FirmPlannedType: integer
Read Only:
true
Indicates whether the resource requirement is marked as firm. -
FirmStartDate: string
(date)
Read Only:
true
Start date is marked to be firm. -
FirmStatus: string
Read Only:
true
Maximum Length:4000
Description of how a resource requirement is firmed. -
FixedLeadTime: number
Read Only:
true
Value of the Fixed Lead Time. This is used irrespective of the quantity being manufactured. -
HoursExpended: number
Read Only:
true
Hours expended on a resource of a job. -
ItemName: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the assembly item associated with the resource requirement. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session sign-in associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialAvailDate: string
(date)
Read Only:
true
Completion date of the previous resource requirement in the sequence. If this is the first resource requirement in the supply, then this date is the same as the material available date of the supply. -
MaximumAssignedUnits: number
Read Only:
true
Number of maximum resource units assigned to perform the operation. -
NeedByDate: string
(date)
Read Only:
true
Date on which a resource requirement should be complete to meet the demand on time. -
NewScheduleDate: string
(date)
Read Only:
true
Value that indicates the new schedule date of the resource requirement demand. -
OperationCost: number
Read Only:
true
Value that indicates the outside processing operation cost. -
OperationSequenceId: integer
Read Only:
true
Operation sequence identifier of the operation where the resource requirement is generated. -
OperationSequenceNumber: integer
Read Only:
true
Sequence number of the operation for the resource requirement. -
OrderNumber: string
Read Only:
true
Maximum Length:240
Value that uniquely identifies the order number of the supply that generates the resource requirement. -
OrganizationCode: string
Read Only:
true
Maximum Length:4000
Indicates the organization identifier. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization that the department resource belongs to. -
OSPOperationType: integer
Read Only:
true
Value that indicates the type of outside processing operation. -
OSPOperationTypeStr: string
Read Only:
true
Maximum Length:4000
Descriptive value of the type of resource requirements, whether In-House or Supplier. -
ParentId: integer
(int64)
Read Only:
true
Reference to the parent transaction identifier of the resource requirement. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan associated with the resource requirements of a resource. -
QuantityInQueue: number
Read Only:
true
Number of units in the queue of the operation. -
ResourceCode: string
Read Only:
true
Maximum Length:40
Identifier of the resource associated with the resource requirement. -
ResourceConstraintDate: string
(date)
Read Only:
true
Date populated by the planning engine process for a bottleneck or resource marked critical because it's constrained. -
ResourceHours: number
Read Only:
true
Value that indicates the resource hours required. -
ResourceId: integer
Read Only:
true
Value that uniquely identifies the resource. -
ResourceSequenceNumber: integer
Read Only:
true
Identifier of the planned resource sequence for the operation requirement. -
ResourceUOMCode: string
Read Only:
true
Maximum Length:4000
Identifier of the unit of measure of the resource. -
RoutingSequenceId: integer
Read Only:
true
Routing sequence identifier for the routing or the work definition. -
SchedulePriority: number
Read Only:
true
Order priority of the resource requirement. -
ScheduleType: integer
Read Only:
true
Schedule identifier on the resource. If this is set then the resource is used in planning. -
ScheduleTypeCode: string
Read Only:
true
Maximum Length:4000
Descriptive value of how the resource requirement is scheduled. -
StartDate: string
(date)
Read Only:
true
Start date of the resource requirement. -
Supplier: string
Read Only:
true
Maximum Length:4000
Value that identifies the supplier of an outside processing operation. -
SupplierId: integer
(int64)
Read Only:
true
Value that indicates the unique supplier identifier of an outside processing operation. -
SupplierSite: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the supplier site of an outside processing operation. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that indicates the unique supplier site identifier for an outside processing operation in the planning system. -
SupplyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply generating the Resource Requirements resource. -
SupplyType: integer
Read Only:
true
Value that indicates the type of supply generating the resource requirement. -
SupplyTypeCode: string
Read Only:
true
Maximum Length:4000
Descriptive value of the supply type generating the Resource Requirements resource. -
TimezoneName: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the time zone. -
TotalResourceHours: number
Read Only:
true
Total inflated resource hours required for an activity of a job. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies a resource requirement entry. -
UnadjustedResourceHours: number
Read Only:
true
Resource hours unadjusted for utilization and efficiency. -
UOMCode: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the unit of measure. -
UsageRate: number
Read Only:
true
Rate per assembly or amount per job or schedule. -
VariableLeadTime: number
Read Only:
true
Variable lead time used in conjunction with the quantity of the assembly being manufactured. This is used to compute the duration of the outside processing operation. -
WorkAreaCode: string
Read Only:
true
Maximum Length:120
Value that uniquely identifies the work area that the department resource belongs to. -
WorkAreaId: integer
(int64)
Read Only:
true
Value indicates the work area identifier of the department resource. -
Yield: number
Read Only:
true
Indicates the operation yield that uses the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-Resources-item-response
Type:
Show Source
object
-
AvailableAllDayIndicator: integer
Value that indicates whether the resource is available 24 hours a day or not. Valid values are: 1 or 2. If 1, then resource is available 24 hours a day. If 2, then not.
-
AvailableAllDayResource: string
Maximum Length:
4000
Value that indicates whether the resource is available 24 hours a day or not. Valid values are: Yes or No. If Yes, then the resource is available 24 hours a day. If No, then the resource isn't available 24 hours a day. -
Bottleneck: string
Maximum Length:
4000
Value that indicates whether the resource is a bottleneck resource or not. Valid values are: 1 or 2. If 1, then resource is a bottleneck. If 2, then not. -
BottleneckIndicator: integer
Value that indicates whether the resource is a bottleneck or not. Valid values are: Yes or No. If Yes, then the resource is a bottleneck. If No, then the resource isn't a bottleneck.
-
CapacityUnits: number
Read Only:
true
Number of units of this resource that are available. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the resource. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the resource. -
Critical: integer
Value that indicates whether the resource is critical to honor resource capacity constraint or not. Valid values are: 1 or 2. If 1, then the resource is critical. If 2, then the resource isn't critical.
-
CriticalResource: string
Maximum Length:
4000
Value that indicates whether the resource is critical to honor the resource capacity constraint or not. Valid values are: Yes or No. If Yes, then the resource is critical. If No, then the resource isn't critical. -
CurrencyCode: string
Read Only:
true
Maximum Length:4000
Code for the currency in which the resource cost is defined. -
DataSecurityEditAllowed: string
Read Only:
true
Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges. -
DisableDate: string
(date)
Read Only:
true
Date when the resource is no longer available. -
EfficiencyPercent: number
Percentage of the actual output compared to the expected standard output.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the resource. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotesCount: integer
Read Only:
true
Value that's used to enable Create Note or Manage Notes. Valid values are 1 or 2. If 1, then Create Note is enabled. If 2, Manage Notes is enabled. The default value is 1. -
NotesIndicator: number
Read Only:
true
Cost associated with using the resource. -
NumberOfLineOperations: number
Read Only:
true
Cost associated with using the resource. -
Organization: string
Read Only:
true
Maximum Length:4000
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
PlanId: integer
(int64)
Unique identifier of the plan.
-
ResourceCode: string
Read Only:
true
Maximum Length:40
Abbreviation that identifies the resource. -
ResourceCost: number
Read Only:
true
Cost associated with using the resource. -
ResourceDescription: string
Read Only:
true
Maximum Length:240
Description of the resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource.
-
ResourceName: string
Read Only:
true
Maximum Length:80
Name of the resource. -
ResourceType: integer
Read Only:
true
Value that identifies the type of resource. Valid values are 1 or 2. If 1, then the resource is a piece of equipment. If 2, then the resource is a crew. A list of accepted values is defined in the lookup type ORA_MSC_RESOURCE_TYPE. -
ResourceTypeName: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of resource. Valid values are Equipment or Crew. -
ResourceUOM: string
Read Only:
true
Maximum Length:3
Unit of measure associated with the resource. -
RowModified: string
Read Only:
true
Text that identifies whether the resource record has been modified or is newly created in the simulation set. Valid values are Changed or Null. If it's Changed, then the resource record has been modified or newly created in the simulation set. If it's Null, then the resource record hasn't been modified or newly created in the simulation set. -
RunRate: number
Read Only:
true
Cost associated with using the resource. -
UnitOfMeasureDisplay: string
Read Only:
true
Maximum Length:4000
Unit of measure associated with the resource. -
UtilizationPercent: number
Percentage of how much a resource is utilized.
-
WorkAreaCode: string
Read Only:
true
Maximum Length:120
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Read Only:
true
Maximum Length:240
Description of the work area. -
WorkAreaName: string
Read Only:
true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Read Only:
true
Maximum Length:120
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Read Only:
true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. -
WorkCenterName: string
Read Only:
true
Maximum Length:80
Name of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-Runs-item-response
Type:
Show Source
object
-
ActionParams: string
List of entities to be refreshed. A comma separates each value. Valid values are 2: Demand history and measures, 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
-
ApproveDemandPlanFlag: boolean
Contains one of the following values: 1 or 2. If 1, then automatically approve the demand forecast after running the plan. If 2, then don't approve.
-
ArchivePlanFlag: boolean
Contains one of the following values: true or false. If true, then archive the plan before the next plan run. If false, then don't archive. The default value is false. Note that you can archive a plan only if you enable it for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.
-
CausalFactorsFlag: boolean
Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.
-
EndDate: string
(date-time)
Date and time when the plan run completed.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the process.
-
ExecutionUser: string
Maximum Length:
64
Login that the user used when launching the process. -
ForceRunFlag: boolean
Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.
-
ForecastBookingsFlag: boolean
Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
-
ForecastMethodsFlag: boolean
Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.
-
ForecastProfiles: string
List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
-
ForecastShipmentsFlag: boolean
Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
-
JobId: integer
(int64)
Value that uniquely identifies the scheduled process.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Text of the error messages, if any, that occurred when running the scheduled process.
-
Mode: string
Specifies whether data is to be refreshed or not. Contains one of the following values: 1, 2, or 3. If 1, then all data is refreshed. If 2, then only selected entities are refreshed. If 3, then data isn't refreshed. The default value is 1.
-
PlanDemandFlag: boolean
Contains one of the following values: true or false. If true, then run the demand planning engine when running a plan. If false, then don't run the demand planning engine when running a plan.
-
PlanId: integer
Value that uniquely identifies the plan.
-
PlanSupplyFlag: boolean
Contains one of the following values: true or false. If true, then run supply planning when running a plan. If false, then don't run supply planning.
-
RecalculateSafetyStockFlag: boolean
Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.
-
SavePlanToDb: string
This attribute isn't currently used.
-
SimulateForecastProfileId: integer
Unique identifier of the forecast profile associated with the simulate demand request.
-
StartDate: string
(date-time)
Date and time to start the scheduled process.
-
Status: integer
(int32)
Status of the plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.
-
SubmissionNotes: string
Notes provided by the user while submitting the plan from the Run Plan page.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-SupplierExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
Title:
Action Taken
Read Only:true
Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2. -
AdditionalCapacityRequiredByDateOfSupplierCapacityConstraint: number
Title:
Additional Capacity Required by Date of Supplier Capacity Constraint
Read Only:true
Additional capacity required by the item supplier and supplier site combination by date of the supplier capacity constraint in the supplier exception. -
AvailableCapacity: number
Title:
Available Capacity
Read Only:true
Available capacity of the item supplier and supplier site combination in the supplier exception. -
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the item in the supplier exception. -
DateOfSupplierCapacityConstraint: string
(date)
Title:
Date of Supplier Capacity Constraint
Read Only:true
Date of the supplier capacity constraint in the supplier exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:29
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the supplier exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionStoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the stored supplier exception. -
FromDate: string
(date)
Title:
From Date
Read Only:true
From date of the supplier capacity overload in the supplier exception. -
InventoryItemId: integer
Read Only:
true
Number that uniquely identifies the item in the supplier exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:4000
Name of the item in the supplier exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:4000
Description of the item in the supplier exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the exception detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: integer
(int64)
Title:
Notes
Contains information created or updated for an exception detail represented as notes. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the organization of an item for which an exception was calculated by the plan. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of an item in the exception -
OverloadPercent: number
Title:
Overload Percentage
Read Only:true
Percentage of supplier capacity overload in the supplier exception. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Name of the planner associated with the item in the exception. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:4000
Description of the planner associated with the item in the exception. -
RequiredCapacity: number
Title:
Required Capacity
Read Only:true
Required supplier capacity of the item supplier and supplier site combination in the supplier exception. -
StoreKey: string
Read Only:
true
Maximum Length:240
Name of the store key in the supply exception. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the supplier exception. -
SupplierId: integer
Read Only:
true
Number that uniquely identifies the supplier in the supplier exception. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the supplier exception. -
SupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the supplier site in the supplier exception. -
ToDate: string
(date)
Title:
To Date
Read Only:true
To date of the supplier capacity overload in the supplier exception.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-SupplyExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
Title:
Action Taken
Read Only:true
Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2. -
AlternateBOM: string
Title:
Alternate BOM
Read Only:true
Maximum Length:4000
Name of the alternate bill of material in the supply exception. -
AlternateBOMId: integer
Read Only:
true
Number that uniquely identifies the alternate bill of material in the supply exception. -
AlternateFacilityRank: number
Title:
Alternate Facility Rank
Read Only:true
Number that represents the alternate facility rank from the sourcing rule used in the supply in the exception. -
AlternateResourceUsage: number
Title:
Alternate Resource Requirement
Read Only:true
Number that represents the usage of an alternate resource in the supply in the exception. -
AlternateRouting: string
Title:
Alternate Routing
Read Only:true
Maximum Length:4000
Name of the alternate routing or work definition in the supply exception. -
AlternateRoutingId: integer
Read Only:
true
Number that uniquely identifies the alternate routing or work definition in the supply exception. -
AlternateSupplier: string
Title:
Alternate Supplier
Read Only:true
Maximum Length:4000
Name of the alternate supplier in the supply exception. -
AlternateSupplierId: integer
Read Only:
true
Number that uniquely identifies the alternate supplier in the supply exception. -
AlternateSupplierRank: number
Title:
Alternate Supplier Rank
Read Only:true
Number that represents the alternate supplier rank in the supply exception. -
AlternateSupplierSite: string
Title:
Alternate Supplier Site
Read Only:true
Maximum Length:4000
Name of the alternate supplier site in the supply exception. -
AlternateSupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the alternate supplier site in the supply exception. -
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the item in the supply exception. -
CompressionDays: number
Title:
Compression Days
Read Only:true
Number that represents the compression days of the supply in the exception. -
CompressionRatio: number
Title:
Compression Ratio
Read Only:true
Compression ratio of the supply in the exception. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:4000
Code for the currency of the supply's organization in the exception. -
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number that represents the number of days the supply is past due based on the plan start date in the exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:15
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the supply exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionStoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the stored supply exception. -
FirmPlannedType: integer
Title:
Firm Status
Read Only:true
Indicates whether the resource requirement is marked as firm. -
FirmStatus: string
Maximum Length:
4000
Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm. -
FromDate: string
(date)
Title:
From Date
Read Only:true
From date in the supply exception. -
InventoryItemId: integer
Read Only:
true
Number that uniquely identifies the item in the supply exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:300
Name of the item in the supply exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item in the supply exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the exception detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot Number
Read Only:true
Maximum Length:80
Lot number of the on-hand supply in the supply exception. -
Notes: integer
(int64)
Title:
Notes
Contains information created or updated for an exception detail represented as notes. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Old due date of the supply order in the supply exception. -
OrderDate: string
(date)
Title:
Order Date
Read Only:true
Supply order date in the exception. -
OrderLineNumber: string
Title:
Order Line Number
Read Only:true
Maximum Length:50
Line number of the supply in the exception. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:240
Order number of the supply in the exception. -
OrderStartDate: string
(date)
Title:
Order Start Date
Read Only:true
Start date of the supply order in the supply exception. -
OrderValue: number
Title:
Order Value
Read Only:true
Order value of the supply in the exception. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the organization of the supply in the supply exception. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of the supply in the supply exception. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Name of the planner associated with the item in the exception. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:4000
Description of the planner associated with the item in the exception. -
PlanningAttribute10: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 10 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute10Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 10 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute11: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 11 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute11Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 11 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute12: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 12 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute12Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 12 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute13: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 13 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute13Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 13 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute14: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 14 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute14Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 14 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute15: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 15 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute15Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 15 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute3: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 3 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute3Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 3 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute4: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 4 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute4Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 4 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute5: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 5 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute5Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 5 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute6: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 6 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute6Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 6 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute7: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 7 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute7Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 7 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute8: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 8 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute8Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 8 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute9: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 9 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute9Id: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the planning attribute number 9 associated with the supply in the exception in an attribute-based plan. -
PlanStartDate: string
(date)
Title:
Plan Start Date
Read Only:true
Start date of the plan the exception is generated in. -
PrimaryItem: string
Title:
Primary Item
Read Only:true
Maximum Length:300
Name of the primary item in the supply exception. -
PrimaryResourceRequirement: number
Title:
Primary Resource Requirement
Read Only:true
Resource requirement of the primary resource of the supply in the exception. -
ProjectGroupValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project group associated with the supply in the exception of an attribute-based plan. -
ProjectGroupValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the project group associated with the supply in the exception in an attribute-based plan. -
ProjectValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project associated with the supply in the exception of an attribute-based plan. -
ProjectValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the project associated with the supply in the exception of an attribute-based plan. -
Quantity: number
Title:
Quantity
Read Only:true
Number that represents the quantity of the supply in the supply exception. -
RescheduledDays: number
Title:
Reschedule Days
Read Only:true
Number that represents rescheduled days for the supply in the exception. -
ResourceCode: string
Title:
Resource
Read Only:true
Maximum Length:4000
Code of the supply's resource in the supply exception. -
ResourceId: integer
Read Only:
true
Value that uniquely identifies the supply's resource in the supply exception. -
ShipMethod: string
Title:
Shipping Method
Read Only:true
Maximum Length:4000
Name of the ship method associated with the supply in the supply exception. -
SourceOrganization: string
Title:
Source Organization
Read Only:true
Maximum Length:4000
Name of the source organization of the supply in the supply exception. -
SourceOrganizationId: integer
Read Only:
true
Value that uniquely identifies the source organization of the supply in the supply exception. -
StoreKey: string
Read Only:
true
Maximum Length:240
Name of the store key in the supply exception. -
SubInventory: string
Title:
Subinventory
Read Only:true
Maximum Length:80
Name of the subinventory of supply in the supply exception. -
SubstituteComponent: string
Title:
Substitute Component
Read Only:true
Maximum Length:300
Name of the substitute component in the supply exception. -
SubstituteResourceCode: string
Title:
Alternate Resource
Read Only:true
Maximum Length:4000
Code of the supply's alternate resource in the supply exception. -
SubstituteResourceId: integer
Read Only:
true
Value that uniquely identifies the supply's alternate resource in the supply exception. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the supply exception. -
SupplierId: integer
Read Only:
true
Number that uniquely identifies the supplier in the supply exception. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the supply exception. -
SupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the supplier site in the supply exception. -
SupplyOrderType: string
Title:
Supply Order Type
Read Only:true
Maximum Length:4000
Type of supply order in the exception, such as a planned order or transfer order. -
TaskValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the task associated with the supply in the exception in an attribute-based plan. -
TaskValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ID of the task associated with the supply in the exception of an attribute-based plan. -
ToDate: string
(date)
Title:
To Date
Read Only:true
To date of the supply in the supply exception. -
TransactionId: integer
Read Only:
true
Value that uniquely identifies the supply in the supply exception. -
WorkCenter: string
Title:
Work Center
Read Only:true
Maximum Length:4000
Code of the work center of the supply's resource in the supply exception. -
WorkCenterId: integer
Read Only:
true
Value that uniquely identifies the work center of the supply's resource in the supply exception.
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 plan option details.
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/demandAndSupplyPlans"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AggregateNonkeyCustomerData": 0, "AltItemWorkDefOption": 1, "UseAlternateResources": 1, "AltSupSourceOrgOption": 1, "OrderModifierStartQuantity": 2, "ArchiveTimeHierarchy": null, "ArchiveTimeLevel": null, "ArchivePlan": null, "ArchiveVersionDays": null, "CompressionDaysTolerance": null, "AverageInterarrivalTime": -1, "BackwardConsumptionBucket": null, "BackwardDays": null, "CalSsQuantEndItems": 2, "CapacityConstrainedResources": 2, "PlanName": "RTPC-AI-PC-Plan-Flow1", "ComponentSubstitutionLogic": 1, "ConsumeByForecastBucket": 2, "ConsumeWithInternalOrders": null, "ConsumeForecastWithNoDc": 1, "ConsumeForecastWithinDtf": 2, "ConsumptionBucketType": 1, "ConsumptionCalendar": "76635", "ConSupplierCapPurOrders": 2, "CreateTimeFence": 2, "CreatedBy": "SCP_PC_USER", "CreationDate": "2023-02-02T16:06:25.002+00:00", "CutoffDate": "2030-07-02", "CalendarCode": "76635", "DefaultForecastPriority": null, "DefaultSalesOrderPriority": null, "DemandPrioritizationMethod": null, "DemandPriorityRule": null, "DemandTimeFenceControl": 2, "DemandHistoryDays": 182, "DemandPlanPriority": 1, "DemandPlanStartDate": "2023-04-26T03:24:23.001+00:00", "DemandPlanCompletionDate": "2023-04-26T03:24:43.854+00:00", "Description": "Order modifier, Transfer order flow", "DeleteArchive": 4, "DmCtoHistoryPeriods": null, "IncludeDependentDemand": null, "EnableEndItemSubstitution": 2, "EnableMultiThreading": 1, "EnableWelcomePage": null, "ExceptionSet": 1, "ExplodeModelForecasts": null, "ExplodeDepndtDmdMethod": null, "ExposeToAnalytic": null, "FirmIrTf": 2, "FirmPlannedOrderTf": 2, "ForwardConsumptionBucket": null, "ForwardDays": null, "ForecastingCalendar": "76635", "ForecastTimeLevel": 1, "GlobalFcstValidOrg": null, "GroupPlannedOrders": 1, "HorizonForAverageDemand": 7, "InclDropShipDmdSup": 2, "IncludeTransferOrders": null, "IncludeProdMonitoringAlrts": null, "IncludeItemsWithSafetyStock": null, "IncludeItemsWithSupplyButNoDemand": null, "DontConsiderInTransitSupplyAsFirm": null, "EnforceLeadTimeInTransit": null, "ItemListPrice": 1, "LastUpdatedDate": "2023-04-26T03:24:43.854+00:00", "LastUpdatedBy": "SCP_PC_USER", "LatenessThreshold": null, "RequisitionLoadGroupBy": 5, "TransferLoadGroupBy": 1, "LoadedOption": null, "MatchTopModelFrcstCosmp": 1, "MaximumVarSafetyStockValue": null, "MinimumVarSafetyStockValue": null, "OverwriteOption": 1, "ParameterOverrides": null, "PastDueForecastBucket": null, "PastDueDemandBucket": 1, "PastDueOpenSoBucket": null, "PastDueShippedSoBucket": null, "PastDueDemandBucketType": null, "PastDueDemandCalendar": null, "PlanDemand": 1, "PlanSupply": 1, "PlanDimensionCatalog": 100, "PlanHorizonDays": null, "PlanId": 300100570590806, "PlanStartDate": "2023-04-26T03:25:34+00:00", "PlanCompletionDate": "2023-04-26T03:25:54+00:00", "PlanType": 3, "PlannedItemType": 1, "SupplyPlannedItems": 6, "PlanningBucketType": null, "PlanningMode": 2, "PlanningTimeFenceControl": 1, "PlnPctHistCalMeasure": null, "PlnPercentCalLevel": null, "PlanOwner": "300100137531628", "PrivatePlan": 1, "RecalculateSafetyStock": null, "ForecastError": null, "OverwriteSafetyStock": 1, "SafetyStockPlanningMethod": 1, "SafetyStockSaveToSimSet": null, "SafetyStockServiceLevel": null, "SaveToCollectedData": null, "DateUsedToPlanSalesOrders": null, "SimulationSet": null, "SmMethodToCalSsInterval": null, "SourcingAllocationWindow": null, "SourcingSplitPercent": null, "SsBuckStartOffsetDays": null, "SsChngeIntervalDays": null, "SafetyStockChangeToAll": null, "PlanStatus": 0, "ShortPlanId": 168748, "SupplyParameterOverrides": null, "HasRun": 1, "AutoRelease": 2, "EnableArchive": 2, "ApplyPolicyOverrides": null, "ConsumptionDtlsCutoffDays": null, "NumberOfDaysForDemandCutoff": null, "UseEndItemSubstitutes": 2, "EnforceResourceCapConstr": null, "EnforceSupplierCapConstr": null, "UseModelSpecificPlanPct": null, "UseFcstPlanPercInsteadCollData": null, "FirstPlanningBucketCode": 1, "FirstPlanningBucketNumber": 180, "SecondPlanningBucketCode": null, "SecondPlanningBucketNumber": null, "SupplyPlanningCalendar": "APS Calendar EX8", "FirstPlanningBucketName": "Day", "SecondPlanningBucketName": null, "ForecastingCalendarName": "APS Calendar EX8", "ForecastTimeLevelName": "Day", "MeasureCatalogForArchival": "Default Demand and Supply Catalog", "PlanItemLevelMembers": "AI_IGB_Category", "PriceLists": "", "PlanOrganizationLevelMembers": "EX8:M1,EX8:M2", "ForecastProfiles": "(Forecast Shipments,Final Shipments History,Shipments Forecast,,730,2027-03-19,2030-01-03,128,0,2030-07-02) ", "DemandSchedules": "(AI-IGB-FC,null,External,,Item) (RTPC-AI-PC-Plan-Flow1,Order modifier, Transfer order flow,Demand,,Item) ", "Organizations": "(EX8:M1,Denver ManufacturingEX8) (EX8:M2,Boston ManufacturingEX8) ", "AssignmentSetName": "AI-EX8-Flow1-ASET", "PlanMeasureCatalog": "Default Demand and Supply Catalog", "SafetyStockForecastPlan": "RTPC-AI-PC-Plan-Flow1", "PolicyAssignmentSet": null, "AppliesToOrderTypes": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100570590806", "name": "demandAndSupplyPlans", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100570590806", "name": "demandAndSupplyPlans", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100570590806/child/PlanningDemands", "name": "PlanningDemands", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100570590806/child/PlanningSupplies", "name": "PlanningSupplies", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/demandAndSupplyPlans/300100570590806/child/Runs", "name": "Runs", "kind": "collection" } ] }, . . .