Get one policy profile
get
/fscmRestApi/resources/11.13.18.05/minMaxPolicyProfiles/{PolicyId}
Request
Path Parameters
-
PolicyId(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=
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : minMaxPolicyProfiles-item-response
Type:
Show Source
object-
AssociationAvailableFlag: boolean
Read Only:
trueMaximum Length:255Value that indicates if the policy profile is used in any of the existing policy assignments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the policy profile. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the policy profile. -
DefCarryingCost: integer
Default value defined for the carrying cost percentage.
-
DefDailyDemand: integer
(int64)
Default value defined for the average daily demand.
-
DefOrderingCost: integer
Default value defined for the ordering cost.
-
DefStandardCost: integer
Default value defined for the standard cost.
-
DeliveriesPerTimePeriod: number
Number of deliveries to be done in a time period.
-
EoqOverride: integer
(int64)
Manual override value defined for the economic order quantity.
-
ExPercentage: integer
(int32)
Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.
-
HistoryDataDays: integer
(int64)
Number of days used to consider history when calculating average daily demand.
-
LastUpdateDate: string
(date-time)
Read Only:
trueLast update date of the policy profile. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the policy profile. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login used to update the policy profile. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaxCalcMethod: integer
(int32)
Code of the maximum quantity calculation method.
-
MaxCalcMethodName: string
Maximum Length:
255Method used to calculate the maximum quantity. Valid values are Days of Cover, Minimum plus order quantity, and Minimum plus EOQ. The default value is Days of Cover. -
MaxOverride: integer
(int64)
Manual override value of the maximum quantity.
-
MaxQty: integer
Value of the maximum quantity.
-
MinOverride: integer
(int64)
Manual override value of the minimum quantity.
-
ObjectVersionNumber: integer
(int32)
Number of times the object has been updated.
-
OrdQty: integer
Value of order quantity.
-
ParTimePeriod: number
Value of the PAR time period.
-
PolicyCode: string
Maximum Length:
120Code of the policy profile. -
PolicyDescription: string
Maximum Length:
240Name of the policy profile. -
PolicyId: integer
(int64)
Unique identifier of the policy profile.
-
PolicyProfileName: string
Maximum Length:
120Name of the policy profile. -
PolicySpec: integer
(int32)
Code of the policy unit of measure.
-
PolicyType: integer
(int32)
Code of the policy type.
-
PolicyTypeName: string
Maximum Length:
255Type of policy. -
PolicyUnitsSpecName: string
Read Only:
trueMaximum Length:255Policy unit of measure type. -
SsCalcMethod: integer
(int32)
Code of the safety stock calculation method.
-
SSCalcMethodName: string
Read Only:
trueMaximum Length:255Method used to calculate the safety stock. -
SsDaysOfCoverage: integer
(int64)
Value that indicates the safety stock days of cover.
-
SsOverride: integer
(int64)
Manual override value defined for the safety stock.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.