1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Plan Definitions
  5. Plan Advanced Options

Get all plan advanced options

get

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

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
  • 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 Finds the plan advanced option according to the value that identifies the plan advanced option.
      Finder Variables
      • ParameterId; integer; Value that uniquely identifies the plan advanced option.
  • 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:
    • CreatedBy; string; User who created the plan advanced options.
    • CreationDate; string; Date when the plan advanced options was originally created.
    • LastUpdateDate; string; Date when the user most recently updated the plan advanced options.
    • LastUpdateLogin; string; Last time the user logged into the system.
    • LastUpdatedBy; string; User who performed the most recent update on the plan advanced options.
    • MaximumGrps; integer; 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.
    • MthreadSettings; string; Determines the settings for each thread after the items in a supply chain are split into threads to obtain an optimized solution.
    • MzTolerance; number; 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.
    • NumberDcmGrps; integer; Specifies the number of groups per thread to be used when plan decomposition is enabled in a constrained plan.
    • NumberThreadsDcm; integer; 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.
    • NumberThreadsOpt; integer; 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.
    • ObjectVersionNumber; integer; Plan version number.
    • ParameterId; integer; Unique identifier of the parameter.
    • PlanId; integer; Uniquely identifies the plan.
    • PsLevel; integer; Optimizes the size of the problem before the start of the solution process. Larger values typically mean greater problem complexity.
    • ScalingFactor; integer; Determines the extent to which the solution model is scaled. Larger values typically reduce solution times but may also lead to larger constraint violations.
    • SfTolerance; number; 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.
  • 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 : planOptions-PlanAdvancedOptions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
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.
Back to Top