Get all plans
get
/fscmRestApi/resources/11.13.18.05/supplyPlans
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 supply plan according to the value that identifies the plan.
Finder Variables- PlanId; integer; Value that uniquely identifies the plan.
- PrimaryKey Find the 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:- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- EnableForArchiving; 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- LastUpdatedDate; string; Date when the user most recently updated the plan.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- SupplyParameterOverrides; string; List of parameters to override supply engine default behavior. They use the following format: {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:
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.
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 : supplyPlans
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 : supplyPlans-item-response
Type:
Show Source
object
-
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.
-
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.
-
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.
-
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.
-
CalendarCode: string
Maximum Length:
22
Abbreviation that identifies the supply planning calendar. -
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
EnableForArchiving: 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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
LastUpdatedDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the plan. -
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.
-
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.
-
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.
-
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.
-
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.
-
PlanName: string
Title:
Name
Maximum Length:30
Name of the plan. -
PlanningDemands: array
Planning Demands
Title:
Planning Demands
The Planning Demands resource manages the demand orders and forecasts that are part of the plan. -
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.
-
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.
-
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.
-
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.
-
Runs: array
Runs
Title:
Runs
The Runs resource manages run details about supply plan. You can use this resource to run 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.
-
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.
-
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.
-
SupplyParameterOverrides: string
Maximum Length:
250
List of parameters to override supply engine default behavior. They use the following format: {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 : 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 : Runs
Type:
array
Title:
Runs
The Runs resource manages run details about supply plan. You can use this resource to run supply plans.
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 : supplyPlans-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. -
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. -
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. -
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
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. -
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. -
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. -
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. -
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. -
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. -
ProjectValue: string
Maximum Length:
4000
Value that identifies the project. -
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. -
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 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. -
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. -
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. -
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. -
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. -
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier ship-from location. -
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
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 : supplyPlans-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 : supplyPlans-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 : supplyPlans-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 : supplyPlans-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. -
AlternateBOMDesignator: string
Maximum Length:
4000
Name of the alternate bill of material. -
AlternateRoutingDesignator: string
Maximum Length:
400
Name of a routing used for the make order. -
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. -
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. -
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 drop ship purchase order. -
CustomerSite: string
Title:
Customer Site
Maximum Length:4000
Code associated with a specific customer ship-to location. -
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. -
DestOrgCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the destination organization for an order. -
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. -
ExpirationDate: string
(date)
Title:
Expiration Date
Date when the existing lot associated with the supply expires. -
FirmComponents: string
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. -
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: 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. -
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
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. -
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. -
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. -
ImplementStatus: string
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. -
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
Read Only:
true
Maximum Length:200
Meaning associated with the ImplementWIPClassCode attribute. -
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.
-
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. -
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. -
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. -
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. -
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. -
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. -
ProjectGroupValue: string
Maximum Length:
4000
Value that identifies the project group. -
ProjectValue: string
Maximum Length:
4000
Value that identifies the project. -
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. -
RequestedArrivalDate: string
(date)
Title:
Requested Arrival Date
Date when the material must arrive at the customer site. -
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
Contains one of the following values: true or false. If true, then the order has been rescheduled. If false, 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. -
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. -
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. -
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.
-
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. -
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
Read Only:true
Maximum Length:40
Subinventory code associated with the supply. -
SubstituteComponentUsed: integer
Title:
Substitute Component Used
Read Only:true
Value that indicates whether the planned order uses a substitute component or not. -
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. -
Supplier: string
Title:
Supplier
Maximum Length:4000
Name of the source supplier. -
SupplierSite: string
Title:
Supplier Site
Maximum Length:4000
Abbreviation that indicates the specific supplier location from where the item is being sourced. -
TaskValue: string
Maximum Length:
4000
Value that identifies task. -
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. -
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.
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 : supplyPlans-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 : supplyPlans-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 : supplyPlans-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 : supplyPlans-Runs-item-response
Type:
Show Source
object
-
ActionParams: string
List of entities to be refreshed. A comma separates each value. Valid values are 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
-
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.
-
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.
-
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.
-
PlanId: integer
Value that uniquely identifies the plan.
-
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.
-
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.
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 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/supplyPlans"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AltItemWorkDefOption": 1, "UseAlternateResources": 1, "AltSupSourceOrgOption": 1, "OrderModifierStartQuantity": 2, "ArchiveTimeHierarchy": null, "ArchiveTimeLevel": null, "ArchivePlan": null, "CompressionDaysTolerance": null, "BackwardConsumptionBucket": null, "CapacityConstrainedResources": 1, "PlanName": "RTSP-GB-EX8-ONHOLDPL01", "ConsumeByForecastBucket": 2, "ConsumeWithInternalOrders": null, "ConsumptionBucketType": 1, "ConsumptionCalendar": "10002", "CutoffDate": "2030-03-17", "CalendarCode": "10002", "DemandPrioritizationMethod": 1, "DemandPriorityRule": null, "DemandTimeFenceControl": 2, "EnableForArchiving": 2, "ExceptionSet": 4, "ForwardConsumptionBucket": null, "GroupPlannedOrders": null, "HorizonForAverageDemand": 7, "IncludeProdMonitoringAlrts": null, "IncludeItemsWithSafetyStock": null, "IncludeItemsWithSupplyButNoDemand": null, "DontConsiderInTransitSupplyAsFirm": null, "EnforceLeadTimeInTransit": null, "LastUpdatedDate": "2022-06-29T08:25:14+00:00", "LoadedOption": null, "RequisitionLoadGroupBy": 5, "TransferLoadGroupBy": 1, "MaximumVarSafetyStockValue": null, "MinimumVarSafetyStockValue": null, "PastDueForecastBucket": null, "PastDueDemandBucket": 1, "PastDueOpenSoBucket": null, "PastDueShippedSoBucket": null, "PastDueDemandBucketType": null, "PastDueDemandCalendar": null, "PlanId": 300100551624915, "PlanHorizonStartDate": "2030-01-04", "SupplyPlannedItems": 6, "PlanningTimeFenceControl": 2, "ForecastError": null, "OverwriteSafetyStock": 1, "SaveToCollectedData": 2, "DateUsedToPlanSalesOrders": null, "SimulationSet": 300100176684635, "SafetyStockChangeToAll": null, "PlanStatus": 0, "SupplyParameterOverrides": null, "HasRun": 1, "AutoRelease": 2, "ApplyPolicyOverrides": 2, "ConsumptionDtlsCutoffDays": null, "NumberOfDaysForDemandCutoff": null, "UseEndItemSubstitutes": 2, "EnforceResourceCapConstr": null, "EnforceSupplierCapConstr": null, "UseModelSpecificPlanPct": null, "UseFcstPlanPercInsteadCollData": null, "FirstPlanningBucketCode": 1, "FirstPlanningBucketNumber": 60, "SecondPlanningBucketCode": 2, "SecondPlanningBucketNumber": 2, "SupplyPlanningCalendar": "APS Calendar", "FirstPlanningBucketName": "Day", "SecondPlanningBucketName": "Week", "PlanItemLevelMembers": "", "PriceLists": "", "PlanOrganizationLevelMembers": "EX8:M2,EX8:M1,EX8:M3", "DemandSchedules": "(GB-EX8-FDS,null,External,,Item) (GB-DP,null,External,,Item) (GB-EXP3,null,External,,Item) (GB-HLDEX9,null,External,,Item) (GB-EXP1,null,External,,Item) (GB-CSA,null,External,,Item) ", "Organizations": "(EX8:M1,Denver ManufacturingEX8) (EX8:M2,Boston ManufacturingEX8) (EX8:M3,New Orleans ManufacturingEX8) ", "SafetyStockForecastPlan": null, "MeasureCatalogForArchival": "DEMO:Measure Catalog", "AssignmentSetName": "GB-ONHOLD", "PolicyAssignmentSet": null, "AppliesToOrderTypes": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915", "name": "supplyPlans", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915", "name": "supplyPlans", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915/child/PlanningDemands", "name": "PlanningDemands", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915/child/PlanningSupplies", "name": "PlanningSupplies", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100551624915/child/Runs", "name": "Runs", "kind": "collection" } ] }, . . .