Get one plan definition

get

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : planOptions-item-response
Type: object
Show Source
Nested Schema : Aggregate Plan Profiles
Type: array
Title: Aggregate Plan Profiles
Specifications such as the maximum number of records displayed in the table or the maximum number of root nodes in pegging mode. By limiting the number of records or pegging modes, the user can analyze the plan output easily and efficiently.
Show Source
Nested Schema : Plan Access
Type: array
Title: Plan Access
The access type of a plan, public or private. The public access makes the plan accessible to all users. The Private access restricts the plan accessibility to specific users.
Show Source
Nested Schema : Plan Advanced Options
Type: array
Title: Plan Advanced Options
Options used for creating supplies and demands, such as pegging parameters and demand cutoff parameters.
Show Source
Nested Schema : Plan Cluster Demand and Supply
Type: array
Title: Plan Cluster Demand and Supply
The clusters that hold the demand and supply order types to use for inventory rebalancing calculation for the plan.
Show Source
Nested Schema : Plan Clusters
Type: array
Title: Plan Clusters
The clusters included in a replenishment plan for inventory rebalancing.
Show Source
Nested Schema : Plan Dimension Filters
Type: array
Title: Plan Dimension Filters
List of all filters for a plan that the user can add for organization and product dimensions. The levels on which filters can be defined are organizations, categories, suppliers, and customers.
Show Source
Nested Schema : Plan Forecast Profiles
Type: array
Title: Plan Forecast Profiles
Options used in the forecasting process in the plan run.
Show Source
Nested Schema : Plan Optional Dimensions
Type: array
Title: Plan Optional Dimensions
Collection of dimensions in the dimension catalog that are used to enable advanced plan options.
Show Source
Nested Schema : Plan Organizations
Type: array
Title: Plan Organizations
The plan organizations specified in the plan options used in the supply planning process that generates supplies for the organizations, if needed.
Show Source
Nested Schema : Plan Output Measures
Type: array
Title: Plan Output Measures
The plan output measures attached to the measure catalog specified in the plan options such as Projected Available Balance and Revenue. These measures are generated by the supply planning process as part of the plan output, and they're used for analyzing the plan output.
Show Source
Nested Schema : Plan Price Lists
Type: array
Title: Plan Price Lists
Price lists for the plan that the user can select to determine the prices of items planned by the supply plan.
Show Source
Nested Schema : Plan Schedules
Type: array
Title: Plan Schedules
Specified demand schedules that serve as the demands for the supply plan. If the plan type is demand and supply, the demand schedule is automatically included in the supply plan. The supported types of demand schedules are Demand, External, and Production.
Show Source
Nested Schema : Plan Segments
Type: array
Title: Plan Segments
Segments of a plan of the items specified in the plan options used by the supply planning process. Segmentation is the process of grouping on the basis of user-defined, static, or dynamic attributes. In Oracle Fusion Cloud Supply Planning, these combinations can include items, organizations, customers, and demand classes. For example, user can use segments in supply planning to view data and perform drills in tables and graphs by segments.
Show Source
Nested Schema : planOptions-MscAggrPlanProfileInPlan-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanAccess-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanAdvancedOptions-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the plan advanced options.
  • Read Only: true
    Date when the plan advanced options was originally created.
  • Read Only: true
    Date when the user most recently updated the plan advanced options.
  • Read Only: true
    Maximum Length: 64
    User who performed the most recent update on the plan advanced options.
  • Read Only: true
    Maximum Length: 32
    Last time the user logged into the system.
  • Links
  • Determines the maximum number of groups into which all planned items must be divided by the solution engine. The calculations the engine performs plan supplies for the items in each group.
  • Maximum Length: 512
    Determines the settings for each thread after the items in a supply chain are split into threads to obtain an optimized solution.
  • Limits the numeric error in the solution algorithm using an industry standard called Markowitz Tolerance. Larger values typically reduce the error introduced in the algorithm.
  • Specifies the number of groups per thread to be used when plan decomposition is enabled in a constrained plan.
  • Determines the number of threads into which the items in a plan are split. Items across threads can't be part of the same supply chain.
  • Specifies the number of threads into which items in a supply chain need to be divided. The engine calculations then assign an algorithm to each thread, and the thread with the fastest solution is selected.
  • Plan version number.
  • Unique identifier of the parameter.
  • Uniquely identifies the plan.
  • Optimizes the size of the problem before the start of the solution process. Larger values typically mean greater problem complexity.
  • Determines the extent to which the solution model is scaled. Larger values typically reduce solution times but may also lead to larger constraint violations.
  • Specifies the tolerance to which a solution should conform using an industry standard called Simplex Feasibility Tolerance. Tightening this tolerance can produce smaller constraint violations but may also lead to more iterations in the search for the solution.
Nested Schema : planOptions-PlanClusterDmdSup-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanClusters-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanDimensionFilter-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanForecastProfile-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanOptionalDimensions-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanOrganization-item-response
Type: object
Show Source
Nested Schema : Subinventories
Type: array
Title: Subinventories
The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.
Show Source
Nested Schema : planOptions-PlanOrganization-SubInventory-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanOutputMeasure-item-response
Type: object
Show Source
Nested Schema : Plan Output Measure Levels
Type: array
Title: Plan Output Measure Levels
The plan output measure levels reported by the plan such as Projected Available Balance and Revenue. The plan output measure levels provide values of a measure at a granular or summarized level . For example, the measure level for the Time dimension in a Gregorian calendar could be: Day, Month, Quarter, and Year.
Show Source
Nested Schema : planOptions-PlanOutputMeasure-PlanOutputMeasureLevel-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanPriceList-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanSchedule-item-response
Type: object
Show Source
Nested Schema : Forecast Constrained Planning Attributes
Type: array
Title: Forecast Constrained Planning Attributes
The attributes for a demand schedule attached to a plan. User can enable or disable these attributes for forecast consumption by the demand schedules attached to the plan. These attributes, such as Backward Days and Forward Days, determine the range of days from the forecast demand date that the forecast can be consumed in that range by sales orders.
Show Source
Nested Schema : Plan Schedule Measure Levels
Type: array
Title: Plan Schedule Measure Levels
The plan schedule measure levels specified for a demand schedule in the plan options. In supply planning, dimensions such as time can have multiple measure levels. Users can specify measure levels for these dimensions: Time, Demand Class, Customer, Organization, and Product. For example the level for Time could be Day, the level for Customer could be Customer Site, and the level for Product could be Item. On the other hand, the level for organization is fixed as Organization and the level for demand class is only Demand Class.
Show Source
Nested Schema : planOptions-PlanSchedule-FcstConstPlanningAttr-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanSchedule-PlanScheduleMeasureLevel-item-response
Type: object
Show Source
Nested Schema : planOptions-PlanSegments-item-response
Type: object
Show Source
Back to Top