Update one plan advanced option
patch
/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanAdvancedOptions/{ParameterId}
Request
Path Parameters
-
ParameterId(required): integer(int64)
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=
-
PlanId(required): integer(int64)
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=
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
MaximumGrps: integer
(int64)
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
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. -
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
(int64)
Specifies the number of groups per thread to be used when plan decomposition is enabled in a constrained plan.
-
NumberThreadsDcm: integer
(int64)
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
(int32)
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
(int32)
Plan version number.
-
ParameterId: integer
(int64)
Unique identifier of the parameter.
-
PlanId: integer
(int64)
Uniquely identifies the plan.
-
PsLevel: integer
(int32)
Optimizes the size of the problem before the start of the solution process. Larger values typically mean greater problem complexity.
-
ScalingFactor: integer
(int32)
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : planOptions-PlanAdvancedOptions-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the plan advanced options. -
CreationDate: string
(date-time)
Read Only:
true
Date when the plan advanced options was originally created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the plan advanced options. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who performed the most recent update on the plan advanced options. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last time the user logged into the system. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumGrps: integer
(int64)
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
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. -
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
(int64)
Specifies the number of groups per thread to be used when plan decomposition is enabled in a constrained plan.
-
NumberThreadsDcm: integer
(int64)
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
(int32)
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
(int32)
Plan version number.
-
ParameterId: integer
(int64)
Unique identifier of the parameter.
-
PlanId: integer
(int64)
Uniquely identifies the plan.
-
PsLevel: integer
(int32)
Optimizes the size of the problem before the start of the solution process. Larger values typically mean greater problem complexity.
-
ScalingFactor: integer
(int32)
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.