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

Get all plans

get

/fscmRestApi/resources/11.13.18.05/demandPlans

Request

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

    Format: ?fields=Attribute1,Attribute2

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

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

    The following are the available finder names and corresponding finder variables

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

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

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AggregateNonkeyCustomerData; integer; Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data.
    • ArchivePlan; integer; Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. Note that you can archive the plan only if you enable it for archiving. If 2, then don't archive.
    • ArchiveTimeHierarchy; integer; Time hierarchy that the application uses to archive the plan.
    • ArchiveTimeLevel; integer; Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
    • ArchiveVersionDays; integer; Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.
    • AutoRelease; integer; Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
    • AverageInterarrivalTime; integer; This attribute isn't currently used.
    • CalendarCode; string; This attribute isn't currently used.
    • CreatedBy; string; User who created the plan.
    • CreationDate; string; Date when the user created the plan.
    • CutoffDate; string; End date of the planning horizon when planning no longer plans demand or supply.
    • DeleteArchive; integer; Contains one of the following values: 1 or 2. If 1, then delete the plan archive during the next plan run. If 2, then don't delete.
    • DemandHistoryDays; integer; Number of days of historical demand data to load into the plan, starting with the plan refresh date. For example, if Demand History Days is 10, and if the plan refresh date is March 30, then load historical demand data from March 30 to March 20.
    • DemandPlanCompletionDate; string; Date and time when demand planning finished running the plan.
    • DemandPlanPriority; integer; Priority of the scheduled process when running a demand plan.
    • DemandPlanStartDate; string; Date and time when demand planning started running the plan.
    • Description; string; Description of the plan.
    • DmCtoHistoryPeriods; integer; Number of history periods used when calculating planning percentage according to the history of the configure options. Applies only when planning a configured item.
    • EnableArchive; integer; Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures.
    • ExceptionSet; integer; Exception set that the plan references. The exception set determines the exception types that the plan creates.
    • ExplodeDepndtDmdMethod; integer; This attribute isn't currently used.
    • ExposeToAnalytic; integer; Contains one of the following values: 1 or 2. If 1, then use the plan in business intelligence reporting. If 2, then don't use.
    • ForecastProfiles; string; List of forecast profiles that the plan uses. A comma separates each value. Values display in the following sequence: Forecast Profile name, Input Measure, Output Measure, Analysis Set, Historical Buckets, History Start Date, History End Date, Forecast Buckets, Locked Forecast Periods, and Forecast End Date. A set of parentheses encloses each set of forecast profiles.
    • ForecastingCalendar; string; Calendar that the forecast uses to forecast demand.
    • ForecastingTimeLevel; integer; Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
    • 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.
    • IncludeDependentDemand; integer; Contains one of the following values: 1 or 2. If 1, then include configure options when planning demand. If 2, then don't include these options. This attribute applies only when planning demand for a configured item.
    • IncludeTransferOrders; integer; Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.
    • ItemListPrice; integer; This attribute isn't currently used.
    • LastUpdatedBy; string; User who performed the most recent update on the plan.
    • LastUpdatedDate; string; Date when the user most recently updated the plan.
    • MeasureCatalogForArchival; string; Measure catalog that the application uses to archive the plan.
    • ParameterOverrides; string; List of parameters to override and the new value to apply for each parameter. These parameters determine what to override in the profile settings that the demand forecast uses. The following format is used: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter.
    • PlanAccess; integer; Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS.
    • PlanDimensionCatalog; integer; Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
    • PlanHorizonDays; integer; Number of days that the plan considers, starting from the plan start date and proceeding forward in time.
    • PlanHorizonStartDate; string; Date when the plan starts planning demand and supply.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanItemLevelMembers; string; List of level values in the item hierarchy to include in the scope of the plan. A comma separates each value.
    • PlanMeasureCatalog; string; Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
    • PlanName; string; Name of the plan.
    • PlanOrganizationLevelMembers; string; List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
    • PlanOwner; string; Name of the user who owns the plan.
    • 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.
    • PlanType; integer; Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.
    • PlnPctHistCalMeasure; integer; Measure that planning uses to calculate planning percentage history. Contains one of the following values. 1788: option bookings history, or 1789: option shipments history.
    • PlnPercentCalLevel; integer; Planning hierarchy level to use when calculating planning percentage according to history. Contains one of the following values. 1: item and organization, 2: item, or 3: item, organization, and demand class. A list of accepted values is defined in the lookup type ORA_MSC_PLN_PERCENT_CAL_LEVEL. Applies only with a configured item.
    • PriceLists; string; List of price lists to consider in the plan. A comma separates each value.
    • ShortPlanId; integer; Short value that identifies the plan.
    • SimulationSet; integer; Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : demandPlans
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : demandPlans-item-response
Type: object
Show Source
  • Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data.
  • 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.
  • Time hierarchy that the application uses to archive the plan.
  • Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
  • Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.
  • 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.
  • This attribute isn't currently used.
  • Maximum Length: 22
    This attribute isn't currently used.
  • Read Only: true
    Maximum Length: 64
    User who created the plan.
  • Read Only: true
    Date when the user created the plan.
  • End date of the planning horizon when planning no longer plans demand or supply.
  • Contains one of the following values: 1 or 2. If 1, then delete the plan archive during the next plan run. If 2, then don't delete.
  • Number of days of historical demand data to load into the plan, starting with the plan refresh date. For example, if Demand History Days is 10, and if the plan refresh date is March 30, then load historical demand data from March 30 to March 20.
  • Date and time when demand planning finished running the plan.
  • Priority of the scheduled process when running a demand plan.
  • Date and time when demand planning started running the plan.
  • Maximum Length: 100
    Description of the plan.
  • Title: Planning Percentage History Periods
    Number of history periods used when calculating planning percentage according to the history of the configure options. Applies only when planning a configured item.
  • 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.
  • Exception set that the plan references. The exception set determines the exception types that the plan creates.
  • This attribute isn't currently used.
  • Contains one of the following values: 1 or 2. If 1, then use the plan in business intelligence reporting. If 2, then don't use.
  • Maximum Length: 22
    Calendar that the forecast uses to forecast demand.
  • Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
  • List of forecast profiles that the plan uses. A comma separates each value. Values display in the following sequence: Forecast Profile name, Input Measure, Output Measure, Analysis Set, Historical Buckets, History Start Date, History End Date, Forecast Buckets, Locked Forecast Periods, and Forecast End Date. A set of parentheses encloses each set of forecast profiles.
  • 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.
  • Title: Include dependent demand
    Contains one of the following values: 1 or 2. If 1, then include configure options when planning demand. If 2, then don't include these options. This attribute applies only when planning demand for a configured item.
  • Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.
  • This attribute isn't currently used.
  • Items
    Title: Items
    The Items resource manages the items within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
  • Read Only: true
    Maximum Length: 64
    User who performed the most recent update on the plan.
  • Read Only: true
    Date when the user most recently updated the plan.
  • Links
  • Measure catalog that the application uses to archive the plan.
  • Maximum Length: 4000
    List of parameters to override and the new value to apply for each parameter. These parameters determine what to override in the profile settings that the demand forecast uses. The following format is used: {PARAMETER1}={VALUE1}#{PARAMETER2}={VALUE2}. The number symbol is used to separate each parameter.
  • Default Value: 1
    Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS.
  • Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
  • Number of days that the plan considers, starting from the plan start date and proceeding forward in time.
  • Date when the plan starts planning demand and supply.
  • Value that uniquely identifies the plan.
  • List of level values in the item hierarchy to include in the scope of the plan. A comma separates each value.
  • Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
  • Title: Name
    Maximum Length: 30
    Name of the plan.
  • List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
  • Maximum Length: 64
    Name of the user who owns the plan.
  • 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.
  • Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.
  • Title: Planning Percentage History Calculation Measure
    Measure that planning uses to calculate planning percentage history. Contains one of the following values. 1788: option bookings history, or 1789: option shipments history.
  • Title: Planning Percentage Calculation Level
    Planning hierarchy level to use when calculating planning percentage according to history. Contains one of the following values. 1: item and organization, 2: item, or 3: item, organization, and demand class. A list of accepted values is defined in the lookup type ORA_MSC_PLN_PERCENT_CAL_LEVEL. Applies only with a configured item.
  • List of price lists to consider in the plan. A comma separates each value.
  • Runs
    Title: Runs
    The Runs resource manages run details about the demand plan. You can use this resource to run demand plans.
  • Short value that identifies the plan.
  • 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.
Nested Schema : Items
Type: array
Title: Items
The Items resource manages the items within a simulation set used as input for the Oracle Supply Chain Planning Cloud solution.
Show Source
Nested Schema : Runs
Type: array
Title: Runs
The Runs resource manages run details about the demand plan. You can use this resource to run demand plans.
Show Source
Nested Schema : demandPlans-Items-item-response
Type: object
Show Source
  • Maximum Length: 40
    Code assigned to the item for classification purposes. Items are divided into categories called ABC classes, such as A, B, and C, according to a criterion such as revenue generation, turnover, or value.
  • Number of days before which the planning process won't reschedule the sales order. For example, if the due date on the original sales order is June 10, and if the Acceptable Early Days is 3, and if the new due date is less than or equal to June 13 then the planning process won't suggest rescheduling.
  • Read Only: true
    Value that indicates whether common supplies are used in case the project inventory isn't sufficient during the demand and supply netting process. Valid values are: 1 or 2. If 1, then common supplies are used. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether to allow use of common supplies when the project inventory isn't sufficient during the demand and supply netting process. Valid values are Yes and No.
  • Percent of unit cost that represents the internal cost to stock one unit for one year.
  • Read Only: true
    Maximum Length: 1
    Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether to include additional components in the item structure for assemble-to-order and pick-to-order items when performing available-to-promise checking. Valid values are Yes and No.
  • Read Only: true
    Value that indicates whether the item is a configured item or not. Valid values are: 1 or 2. If 1, then item is a configured item. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the item is configured or not. Valid values are: Yes or No. If Yes, then the item is configured. If No, then the item isn't configured.
  • Average time, expressed in days, between intervals.
  • Number of days specified by the user to override the average interarrival time, where the average interarrival time is the average time, expressed in days, between intervals.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the item is enabled for back-to-back ordering or not. Valid values are: Yes or No. If Yes, then the item is enabled for back-to-back ordering. If No, then the item isn't enabled for back-to-back ordering.
  • Read Only: true
    Value that indicates whether the item is enabled for back-to-back ordering or not. Valid values are: 1 or 2. If 1, then item is enabled for back-to-back ordering. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the model to use when creating an assemble-to-order configuration.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether work orders can be created or not. Valid values are Yes or No. If Yes, then work orders can be created. If No, then work orders can't be created.
  • Read Only: true
    Contains one of the following values: 1 or 2. If 1, then work orders can be created. If No, then work orders can't be created.
  • Maximum Length: 240
    Name of the buyer associated with the item.
  • Value that indicates whether to enable available-to-promise functionality in Oracle Fusion Cloud Global Order Promising when planning for this item. Valid values are 1 and 2. If 1, then available-to-promise functionality is enabled. If 2, then available-to-promise functionality isn't enabled.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Category of the item in the exception. the category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
  • Read Only: true
    Maximum Length: 4000
    Description associated with a product category.
  • Read Only: true
    Value that uniquely identifies an item category.
  • Maximum Length: 1
    Value that indicates whether to include this component item when calculating clear-to-build for an assembly item. Valid values are 1 or 2. If 1, then this component item is included. If 2, then it's not.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether to include this component item when calculating clear to build for an assembly item. Valid values are Yes or No. If Yes, then this component item is included. If No, then this component item isn't included.
  • Read Only: true
    Maximum Length: 64
    User who created the item.
  • Value that indicates whether planning creates planned orders for this item. Valid values are 1 or 2. If 1, then planned orders are created. If 2, then planned orders aren't created.
  • Date after which supplies can be created. This attribute is editable only when the CreateSupply attribute is set to 1.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether planning creates planned orders for this item. Valid values are Yes or No. If Yes, then planned orders are created. If No, then planned orders aren't created.
  • Read Only: true
    Date and time when the user created the supplier item.
  • Value that indicates whether the item is a critical component or not. Valid values are 1 or 2. If 1, then the item is a critical component. If 2, then the item isn't a critical component.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the item is a critical component or not. Valid values are Yes or No. If Yes, then the item is a critical component. If No, then the item isn't a critical component.
  • Read Only: true
    Number of days required to manufacture the item, including the adjusted, cumulative, and total lead time for the component that requires the longest time to assemble.
  • Read Only: true
    Maximum Length: 30
    Value that indicates the currency associated with the item's price and cost.
  • Read Only: true
    Maximum Length: 255
    Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
  • Number of days of cover for the item. Days of Cover is multiplied by the average demand to calculate the safety stock level.
  • Period of time, specified as a number of days, used to determine the average gross demand when using the Days of Cover method to calculate safety stock.
  • Abbreviation that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Read Only: true
    Date before which forecast demand is ignored.
  • Time horizon, expressed in number of days, within which forecast demand is ignored.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Maximum Length: 240
    Description of the item.
  • Average discount for the item.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether purchasing lead times are imposed as a hard constraint during constraint-based planning. Valid values are: 1 or 2. If 1, then purchasing lead times are enforced. If 2, then not.
  • Value that indicates whether purchasing lead times are imposed as a hard constraint during constraint-based planning. Valid values are: Yes or No. If Yes, then purchasing lead times are enforced. If No, then purchasing lead times aren't enforced.
  • Time horizon, expressed in number of days, after which inventory is considered excess.
  • Number of days to use to modify the size and timing of each planned order quantity.
  • Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
  • Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
  • Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates how the forecast is exploded and consumed. This attribute isn't currently used.
  • Maximum Length: 30
    Value that indicates how the quality of a forecast is measured. A list of accepted values is defined in the lookup type MSC_FORECAST_ERROR_TYPES.
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the ForecastErrorType Code attribute.
  • Read Only: true
    Maximum Length: 4000
    Name of the forecast used for safety stock calculation.
  • Read Only: true
    Maximum Length: 25
    Value that identifies the type of pegging considered by the planning engine during the supply and demand netting process. A list of accepted values is defined in the lookup type ORA_MSC_HARD_PEGGING_LEVEL.
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the HardPeggingLevel attribute.
  • Value that indicates whether the demand for the item has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the demand has an irregular frequency. Valid values are Yes and No.
  • Value specified by the user to override the Intermittent Demand, where Intermittent Demand indicates whether the demand has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value specified by the user to determine whether to override intermittent demand, which indicates whether the demand has an irregular frequency or not. Valid values are Yes and No.
  • Value that uniquely identifies the item.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure associated with an item's cost.
  • Maximum Length: 300
    Name of the item.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of bill of material. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE.
  • Read Only: true
    Date and time when the user most recently updated the item.
  • Read Only: true
    Maximum Length: 64
    User most recently updated the item.
  • Read Only: true
    Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
  • Number of months or periods in which the constrained supply plan offsets the lead time, after converting the number of months or periods to days. Month buckets are used if the supply planning calendar is Gregorian. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
  • Number of weeks in which the constrained supply plan offsets the lead time, after converting the number of weeks to days. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
  • Maximum Length: 120
    Name of lifecycle phase of the item.
  • Links
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the LotControlCode attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE.
  • Read Only: true
    Value that identifies whether the item is lot controlled. Valid values are 1 and 2. If 1, then lot control isn't established for the item. If 2, then lot control is used to track inventory balances by the lot number. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE.
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the LotsExpiration attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL.
  • Read Only: true
    Value that identifies how lot expiration dates are calculated. Valid values are 1 and 2. If 1, then lots don't expire. If 2, then lot expiration is based on the number of shelf life days for the item. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL.
  • Read Only: true
    Value of the mean absolute deviation for the item.
  • Value that's the user override of the mean absolute deviation, where mean absolute deviation is a statistical formula used to measure the quantity deviation between actual and forecasted demand.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the item is manufactured or purchased. Valid values are Make or Buy. If Make, then the item is manufactured. If Buy, then the item is purchased. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Read Only: true
    Value of the mean absolute percentage error for the item.
  • Value that's the user override of the mean absolute percentage error, where mean absolute percentage error is a statistical formula used to measure the percentage deviation between actual and forecasted demand.
  • Maximum order quantity of the item.
  • Minimum order quantity of the item.
  • Read Only: true
    Selling price of an item after applying an average discount to the item's list price.
  • Most recent value that uniquely identifies the plan.
  • Read Only: true
    The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value.
  • Date when the item is obsolete.
  • Fixed costs that are associated with placing a sales order for the item.
  • Value that indicates whether order modifiers are applied to start quantity or not. Valid values are: 1 or 2. If 1, then order modifiers are applied to start quantity. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value that determines whether the order modifier for the item should be applied to the start quantity of the supply for the item. Valid values are Yes or No.
  • Maximum Length: 49
    Abbreviation that identifies the organization associated with the item.
  • Value that uniquely identifies the organization.
  • Read Only: true
    Value that indicates whether the item can be picked from finished goods inventory. Valid values are: 1 or 2. If 1, then the item can be picked from finished goods inventory. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the item can be picked from the finished goods inventory. Valid values are: Yes or No. If Yes, then the item can be picked from the finished goods inventory. If No, then the item can't be picked from the finished goods inventory.
  • Read Only: true
    Maximum Length: 4000
    Type of safety stock planning used to calculate safety stock for the item and organization combination. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_SS_TYPE.
  • Read Only: true
    Abbreviation that identifies the type of safety stock planning used to calculate safety stock for the item and organization combination. A list of accepted values is defined in the lookup type ORA_MSC_PLANNED_SS_TYPE.
  • Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Read Only: true
    Maximum Length: 4000
    Description of the planner responsible for the item.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE.
  • Abbreviation that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE.
  • Abbreviation that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Read Only: true
    Date before which orders aren't rescheduled.
  • Time horizon, in number of days, in which supply orders aren't scheduled to be due.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Number of days required to make an item available in inventory once the supply is complete.
  • Number of days which must be added to purchasing or manufacturing lead time to place an order.
  • Number of days required to procure or manufacture an item.
  • 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.
  • Read Only: true
    Date before which orders are automatically released as work orders or purchase requisitions.
  • Time horizon, in number of days, in which orders are automatically released as work orders or purchase requisitions.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Value that indicates whether planned order quantity is rounded to a whole number or not. Valid values are: 1 or 2. If 1, then planned order quantity is rounded. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the planned order quantity is rounded to a whole number or not. Valid values are: Yes or No. If Yes, then the planned order quantity is rounded. If No, then the planned order quantity isn't rounded.
  • Read Only: true
    Maximum Length: 255
    Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified.
  • Value that identifies the method that planning uses to calculate safety stock levels for the item. A list of accepted values is defined in the lookup type ORA_MSC_SS_PLANNING_METHD.
  • Read Only: true
    Maximum Length: 4000
    Demand plan that contains the forecast and forecast error measures that the plan uses to calculate safety stock.
  • Maximum Length: 4000
    Meaning associated with the SafetyStockCode attribute.
  • Desired level of safety stock of an item.
  • Numeric value provided by the user to override the standard safety stock quantity of an item.
  • Selling price of the item.
  • Desired level of customer service, expressed as a percentage, in satisfying product demand. This represents the probability that an order can be filled from available inventory.
  • Average amount of material you expect to lose when manufacturing or storing the item.
  • Standard cost of an item.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
  • Read Only: true
    Volume of one item.
  • Read Only: true
    Weight of one item.
  • Read Only: true
    Maximum Length: 4000
    Planning unit of measure of the item.
  • Read Only: true
    Date when the current on-hand quantity for an item is exhausted based on projected gross requirements.
  • Time to produce one unit of an assembly.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure to use for the item volume.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure to use for the item weight.
Nested Schema : demandPlans-Runs-item-response
Type: object
Show Source
  • Maximum Length: 255
    List of entities to be refreshed. A comma separates each value. Valid values are 2: Demand history and measures, 3: Forecasts, 4: Sales orders, and 6: Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
  • 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.
  • Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.
  • Date and time when the plan run completed.
  • Value that uniquely identifies the process.
  • Maximum Length: 64
    Login that the user used when launching the process.
  • 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.
  • Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
  • Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.
  • List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
  • Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
  • Value that uniquely identifies the scheduled process.
  • Links
  • Text of the error messages, if any, that occurred when running the scheduled process.
  • 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.
  • Value that uniquely identifies the plan.
  • Unique identifier of the forecast profile associated with the simulate demand request.
  • Date and time to start the scheduled process.
  • 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.
  • Notes provided by the user while submitting the plan from the Run Plan page.
Back to Top

Examples

This example describes how to get all demand plan option details.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/demandPlans"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "AggregateNonkeyCustomerData": null,
            "ArchiveTimeHierarchy": null,
            "ArchiveTimeLevel": null,
            "ArchivePlan": null,
            "MeasureCatalogForArchival": 1926,
            "ArchiveVersionDays": null,
            "AverageInterarrivalTime": null,
            "PlanName": "DM-30-11-201504:38:35",
            "CreatedBy": "APS_ALL",
            "CreationDate": "2015-11-30T12:39:30.002+00:00",
            "CutoffDate": "2016-05-28",
            "CalendarCode": null,
            "DeleteArchive": 4,
            "Description": null,
            "DemandHistoryDays": 182,
            "DemandPlanPriority": 1,
            "DemandPlanStartDate": "2018-03-14T09:32:11.380+00:00",
            "DemandPlanCompletionDate": "2018-03-14T09:32:11.705+00:00",
            "DmCtoHistoryPeriods": 26,
            "IncludeDependentDemand": null,
            "EnableArchive": 2,
            "ExceptionSet": 1,
            "ExposeToAnalytic": null,
            "ExplodeDepndtDmdMethod": 1,
            "ForecastingCalendar": "17",
            "ForecastingTimeLevel": 4,
            "HasRun": 1,
            "IncludeTransferOrders": null,
            "ItemListPrice": 1,
            "LastUpdatedDate": "2017-08-28T05:39:10+00:00",
            "LastUpdatedBy": "SCMOPERATIONS",
            "ParameterOverrides": null,
            "PlanDimensionCatalog": 100,
            "PlanHorizonDays": 180,
            "PlanId": 300100071618784,
            "PlanMeasureCatalog": 1926,
            "PlanOwner": "100010032928435",
            "PlanHorizonStartDate": "2015-11-30",
            "PlanType": 1,
            "PlnPctHistCalMeasure": null,
            "PlnPercentCalLevel": null,
            "PlanAccess": 1,
            "SimulationSet": null,
            "PlanStatus": 0,
            "ShortPlanId": 102001,
            "AutoRelease": null,
            "PlanItemLevelMembers": "KB_REF_Items",
            "PriceLists": "",
            "PlanOrganizationLevelMembers": "M3,M2",
            "ForecastProfiles": "(Forecast Bookings,Final Bookings History,Bookings Forecast,,24,2013-11-01,2015-10-31,6,0,2016-04-30) (Forecast Shipments,Final Shipments History,Shipments Forecast,,24,2013-11-01,2015-10-31,6,0,2016-04-30) ",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784",
                    "name": "demandPlans",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784",
                    "name": "demandPlans",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784/child/Runs",
                    "name": "Runs",
                    "kind": "collection"
                }
            ]
        },...}
Back to Top