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

Get all plans

get

/fscmRestApi/resources/11.13.18.05/salesAndOperationsPlans

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 sales and operations 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. The default value is 2.
    • AllowLeadTimeCompression; integer; Determines whether to compress lead times for purchased and transferred items. Contains one of the following values: 1 or 2. If 1, then lead-time compression occurs and an exception for each violation is generated. If 2, then lead-time compression doesn't occur. The default value is 1.
    • 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. This attribute doesn't have a default value.
    • 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.
    • 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.
    • BaseCurrencyCode; string; Abbreviation that identifies the base currency of the rate type that's used for conversion rates.
    • CalendarCode; string; This attribute isn't currently used.
    • CategoryLevelMembers; string; List of level values in the item hierarchy to include in the supply scope of a sales and operations plan. A comma separates each value.
    • ConstrainedWorkCenterLevelMembers; string; List of values for the work center level in the resource hierarchy that the scope of a constrained plan includes. A comma separates each value.
    • ConversionRateType; string; Name of the rate type to use for currency conversions.
    • 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. This attribute doesn't have a default value.
    • DemandBackorderingMultiplier; number; Value by which the penalty cost for demand backordering is multiplied.
    • 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.
    • DemandPlanMeasure; string; Name of the demand plan measure to load as the target forecast measure.
    • DemandPlanName; string; Name of the demand plan containing the measure to load as the target forecast measure.
    • DemandPlanPriority; integer; Priority of the scheduled process when running a demand plan.
    • DemandPlanStartDate; string; Date and time when demand planning started running the plan.
    • 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.
    • Description; string; Description of the plan.
    • 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. The default value is 2.
    • EnableMultiThreading; integer; Contains one of the following values: 1 or 2. If 1, then use multithreading when planning supply. If 2, then don't use multithreading. The default value is 1.
    • ExceptionSet; integer; Exception set that the plan references. The exception set determines the exception types that the plan creates.
    • 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. The default value is 2.
    • 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. This attribute doesn't have a default value.
    • HorizonPastDueSupDays; integer; Number of days to consider for past due supply. For example, if Horizon for Past Due Supplies in Days is 7, then the plan won't consider a purchase order that's 10 days late.
    • IncludePtwOrders; integer; Determines whether to include purchase orders and transfer orders as supply or not. Contains one of the following values: 1 or 2. If 1, then include purchase orders and transfer orders as supply. If 2, then don't include. The default value is 2.
    • IncludeSalesOrders; integer; Determines whether to include sales orders in the plan or not. Contains one of the following values: 1 or 2. If 1, then include sales orders in the plan and include them when calculating forecast. If 2, then don't include. The default value is 1.
    • IncludeWorkOrders; integer; Determines whether to include work orders as supply or not. Contains one of the following values: 1 or 2. If 1, then include work orders as supply. 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.
    • LoadMeasureFromDemandPlan; integer; Contains one of the following values: 1 or 2. If 1, then load measure from the demand plan. If 2, then don't load the demand plan measure. The default value is 2.
    • MeasureCatalogForArchival; string; Measure catalog that the application uses to archive the plan.
    • 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.
    • 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. The default value is 1.
    • PlanCompletionDate; string; Date and time when supply planning finished running the plan.
    • PlanDemand; integer; Contains one of the following values: 1 or 2. If 1, then run demand planning when running a plan. If 2, then don't run demand planning. The default value is 1.
    • PlanDimensionCatalog; integer; Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
    • PlanHorizonDays; integer; Number of days that the plan considers, starting from the plan start date and proceeding forward in time.
    • PlanHorizonStartDate; string; Date when the plan starts planning demand and supply.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanItemLevelMembers; string; List of level values in the item hierarchy to include in the scope of the plan. A comma separates each value.
    • PlanMeasureCatalog; string; Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
    • PlanName; string; Name of the plan.
    • PlanOrganizationLevelMembers; string; List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
    • PlanOwner; string; Name of the user who owns the plan.
    • PlanStartDate; string; Date and time when supply planning started running the plan.
    • PlanStatus; integer; Status of the plan run that most recently completed. Valid values include 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. This attribute doesn't have a default value.
    • PlanSupply; integer; Contains one of the following values: 1 or 2. If 1, then run supply planning when running a plan. If 2, then don't run supply planning. The default value is 1.
    • PlanType; integer; Type of plan. Valid values include 4: sales and operations plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. The default value is 4.
    • PlanningCustomerLevel; integer; Customer dimension level that the application uses to aggregate planning for end items.
    • PlanningMode; integer; Contains the following value: 3. If 3, then use aggregate supply planning. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE. The default value is 3.
    • PlanningProductLevel; integer; Item dimension level that the application uses to aggregate planning for end items.
    • PlanningTimeLevel; integer; Time level that the application uses to aggregate planning.
    • PriceLists; string; List of price lists to consider in the plan. A comma separates each value.
    • RequirementsByAssembly; integer; Determines whether to output resource requirements by assembly item or not. Contains one of the following values: 1 or 2. If 1, then output resource requirements by assembly item during planning. If 2, then don't output. The default value is 1.
    • ResourceOverloadMultiplier; number; Value by which the penalty cost for resource capacity overloading is multiplied.
    • RevenueInCurrency; integer; Determines whether to apply currency conversion rates for planning revenue or not. Contains one of the following values: 1 or 2. If 1, then apply currency conversion rates for revenue during planning. If 2, then don't apply. The default value is 2.
    • 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.
    • SopAddPastDueSo; integer; Determines whether to consider past due sales orders after netting the first time bucket. Contains one of the following values: 1 or 2. If 1, then add past due sales orders after netting the first time bucket. If 2, then net the first time bucket with past due sales orders. The default value is 2.
    • SopDemandTargetMeasure; string; Name of the target forecast measure to load data from the demand plan measure.
    • SopManufactureOffset; integer; Determines whether to use processing lead times for assembly items or not. Contains one of the following values: 1 or 2. If 1, then use the processing lead time for assembly items during planning. If 2, then don't use the processing lead time for assembly items. The default value is 2.
    • SopPlanAnchorDate; string; Plan start date used instead of the system date when running the plan. If there's no anchor date, then the system date is used when running the plan.
    • SourcingViolationMultiplier; number; Value by which the penalty cost for violating the sourcing allocation percentage is multiplied.
    • SupplierConstrained; integer; Determines whether to apply supplier capacity constraints or not. Contains one of the following values: 1 or 2. If 1, then apply constraints on supplier capacity during planning. If 2, then don't apply. The default value is 2.
    • SupplierOverloadMultiplier; number; Value by which the penalty cost for supplier capacity overloading is multiplied.
    • UseDecliningStorageCosts; integer; Determines whether to use storage costs that decline over the plan horizon or not. Contains one of the following values: 1 or 2. If 1, then use storage costs that decline over the plan horizon. If 2, then use the same storage cost over the plan horizon. The default value is 1.
    • WorkCenterConstrained; integer; Determines whether to apply work center capacity constraints or not. Contains one of the following values: 1 or 2. If 1, then apply constraints on work center capacity during planning. If 2, then don't apply. The default value is 2.
  • 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 : salesAndOperationsPlans
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : salesAndOperationsPlans-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. The default value is 2.
  • Determines whether to compress lead times for purchased and transferred items. Contains one of the following values: 1 or 2. If 1, then lead-time compression occurs and an exception for each violation is generated. If 2, then lead-time compression doesn't occur. The default value is 1.
  • 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. This attribute doesn't have a default value.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the base currency of the rate type that's used for conversion rates.
  • Maximum Length: 22
    This attribute isn't currently used.
  • List of level values in the item hierarchy to include in the supply scope of a sales and operations plan. A comma separates each value.
  • List of values for the work center level in the resource hierarchy that the scope of a constrained plan includes. A comma separates each value.
  • Read Only: true
    Maximum Length: 30
    Name of the rate type to use for currency conversions.
  • 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. This attribute doesn't have a default value.
  • Value by which the penalty cost for demand backordering is multiplied.
  • 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.
  • Read Only: true
    Maximum Length: 4000
    Name of the demand plan measure to load as the target forecast measure.
  • Read Only: true
    Maximum Length: 4000
    Name of the demand plan containing the measure to load as the target forecast measure.
  • Priority of the scheduled process when running a demand plan.
  • Date and time when demand planning started running the plan.
  • 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.
  • Maximum Length: 100
    Description of the plan.
  • 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. The default value is 2.
  • Contains one of the following values: 1 or 2. If 1, then use multithreading when planning supply. If 2, then don't use multithreading. The default value is 1.
  • Exception set that the plan references. The exception set determines the exception types that the plan creates.
  • 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. The default value is 2.
  • 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. This attribute doesn't have a default value.
  • Number of days to consider for past due supply. For example, if Horizon for Past Due Supplies in Days is 7, then the plan won't consider a purchase order that's 10 days late.
  • Determines whether to include purchase orders and transfer orders as supply or not. Contains one of the following values: 1 or 2. If 1, then include purchase orders and transfer orders as supply. If 2, then don't include. The default value is 2.
  • Determines whether to include sales orders in the plan or not. Contains one of the following values: 1 or 2. If 1, then include sales orders in the plan and include them when calculating forecast. If 2, then don't include. The default value is 1.
  • Determines whether to include work orders as supply or not. Contains one of the following values: 1 or 2. If 1, then include work orders as supply. If 2, then don't include. The default value is 2.
  • This attribute isn't currently used.
  • 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
  • Contains one of the following values: 1 or 2. If 1, then load measure from the demand plan. If 2, then don't load the demand plan measure. The default value is 2.
  • Measure catalog that the application uses to archive the plan.
  • 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.
  • 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. The default value is 1.
  • Date and time when supply planning finished running the plan.
  • Contains one of the following values: 1 or 2. If 1, then run demand planning when running a plan. If 2, then don't run demand planning. The default value is 1.
  • 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.
  • Customer dimension level that the application uses to aggregate planning for end items.
  • Contains the following value: 3. If 3, then use aggregate supply planning. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MODE. The default value is 3.
  • Item dimension level that the application uses to aggregate planning for end items.
  • Time level that the application uses to aggregate planning.
  • 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.
  • Date and time when supply planning started running the plan.
  • Status of the plan run that most recently completed. Valid values include 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. This attribute doesn't have a default value.
  • Contains one of the following values: 1 or 2. If 1, then run supply planning when running a plan. If 2, then don't run supply planning. The default value is 1.
  • Type of plan. Valid values include 4: sales and operations plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE. The default value is 4.
  • List of price lists to consider in the plan. A comma separates each value.
  • Determines whether to output resource requirements by assembly item or not. Contains one of the following values: 1 or 2. If 1, then output resource requirements by assembly item during planning. If 2, then don't output. The default value is 1.
  • Value by which the penalty cost for resource capacity overloading is multiplied.
  • Read Only: true
    Determines whether to apply currency conversion rates for planning revenue or not. Contains one of the following values: 1 or 2. If 1, then apply currency conversion rates for revenue during planning. If 2, then don't apply. The default value is 2.
  • Runs
    Title: Runs
    The Runs resource manages the run details about sales and operations plan runs. You can use this resource to start sales and operations 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.
  • Determines whether to consider past due sales orders after netting the first time bucket. Contains one of the following values: 1 or 2. If 1, then add past due sales orders after netting the first time bucket. If 2, then net the first time bucket with past due sales orders. The default value is 2.
  • Name of the target forecast measure to load data from the demand plan measure.
  • Determines whether to use processing lead times for assembly items or not. Contains one of the following values: 1 or 2. If 1, then use the processing lead time for assembly items during planning. If 2, then don't use the processing lead time for assembly items. The default value is 2.
  • Plan start date used instead of the system date when running the plan. If there's no anchor date, then the system date is used when running the plan.
  • Value by which the penalty cost for violating the sourcing allocation percentage is multiplied.
  • Determines whether to apply supplier capacity constraints or not. Contains one of the following values: 1 or 2. If 1, then apply constraints on supplier capacity during planning. If 2, then don't apply. The default value is 2.
  • Value by which the penalty cost for supplier capacity overloading is multiplied.
  • Determines whether to use storage costs that decline over the plan horizon or not. Contains one of the following values: 1 or 2. If 1, then use storage costs that decline over the plan horizon. If 2, then use the same storage cost over the plan horizon. The default value is 1.
  • Determines whether to apply work center capacity constraints or not. Contains one of the following values: 1 or 2. If 1, then apply constraints on work center capacity during planning. If 2, then don't apply. The default value is 2.
Nested Schema : Runs
Type: array
Title: Runs
The Runs resource manages the run details about sales and operations plan runs. You can use this resource to start sales and operations plans.
Show Source
Nested Schema : salesAndOperationsPlans-Runs-item-response
Type: object
Show Source
  • 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.
  • 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 include the forecast bookings profile when running the plan. If false, then don't include this profile. The default value is false.
  • List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
  • Contains one of the following values: true or false. If true, then include the forecast shipments profile when running the plan. If false, then don't include this profile. The default value is false.
  • 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. Valid values are 1 or 3. If 1, then all data is refreshed. If 3, then data isn't refreshed. The default value is 1.
  • Contains one of the following values: true or false. If true, then run the demand planning engine when running a plan. If false, then don't run the demand planning engine when running a plan. The default value is true.
  • Value that uniquely identifies the plan.
  • Contains one of the following values: true or false. If true, then run supply planning when running a plan. If false, then don't run supply planning. The default value is true.
  • Date and time to start the scheduled process.
  • Status of the plan run. Valid values include 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. This attribute doesn't have a default value.
Back to Top

Examples

This example describes how to get all plan option details.

Example cURL Command

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

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

Example Response Body

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

{
    "items": [
        {
            "AggregateNonkeyCustomerData": null,
            "AllowLeadTimeCompression": 2,
            "ArchiveTimeHierarchy": 17,
            "ArchiveTimeLevel": 52,
            "ArchivePlan": null,
            "MeasureCatalogForArchival": 1932,
            "ArchiveVersionDays": null,
            "DeleteArchive": 4,
            "AssignmentSetName": 300100097264072,
            "PlanName": "RT-SalesOrg",
            "CreatedBy": "john",
            "CreationDate": "2017-07-26T18:07:47.001+00:00",
            "CutoffDate": "2020-07-31",
            "CalendarCode": null,
            "Description": "Gregorian Month+Item+Site-DM",
            "DemandPlanStartDate": "2018-03-13T19:19:15.433+00:00",
            "DemandPlanCompletionDate": "2018-03-13T19:20:14.655+00:00",
            "DemandHistoryDays": 182,
            "DemandPlanPriority": 1,
            "EnableArchive": 2,
            "EnableMultiThreading": 1,
            "ExposeToAnalytic": null,
            "ExceptionSet": 2,
            "ForecastingCalendar": "17",
            "ForecastingTimeLevel": 4,
            "HorizonPastDueSupDays": 7,
            "IncludePtwOrders": 2,
            "IncludeSalesOrders": 2,
            "IncludeWorkOrders": 2,
            "ItemListPrice": 1,
            "LastUpdatedDate": "2017-07-27T15:10:43+00:00",
            "LastUpdatedBy": "john",
            "ParameterOverrides": null,
            "PlanAccess": 1,
            "PlanDemand": 1,
            "PlanDimensionCatalog": 300100120594267,
            "PlanHorizonDays": 550,
            "PlanId": 300100120609034,
            "PlanMeasureCatalog": 1931,
            "PlanOwner": "100010032916705",
            "PlanHorizonStartDate": "2019-01-04",
            "PlanStartDate": null,
            "PlanCompletionDate": null,
            "PlanSupply": 2,
            "PlanType": 4,
            "PlanningTimeLevel": null,
            "PlanningMode": 3,
            "SimulationSet": null,
            "SupplierConstrained": 2,
            "WorkCenterConstrained": 2,
            "PlanningCustomerLevel": 43,
            "PlanningProductLevel": 1,
            "PlanStatus": 0,
            "HasRun": 1,
            "ShortPlanId": 168121,
            "PlanItemLevelMembers": "RC-TABLETS,RC-COMPONENTS",
            "PriceLists": "",
            "PlanOrganizationLevelMembers": "M1",
            "ForecastProfiles": "(Forecast Shipments,Final Shipments History,Shipments Forecast,,24,2017-01-01,2018-12-31,18,0,2020-06-30) ",
            "DemandSchedules": "(RT-SalesOrg,Gregorian Month+Item+Site-DM,Sales and Operations,Consensus Forecast) ",
            "Organizations": "(M1,Tall Manufacturing) ",
            "ConstrainedWorkCenterLevelMembers": "",
            "CategoryLevelMembers": "",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesAndOperationsPlans/300100120609034",
                    "name": "salesAndOperationsPlans",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesAndOperationsPlans/300100120609034",
                    "name": "salesAndOperationsPlans",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesAndOperationsPlans/300100120609034/child/Runs",
                    "name": "Runs",
                    "kind": "collection"
                }
            ]
        },..
}
Back to Top