Get one replenish parameter.
get
/fscmRestApi/resources/11.13.18.05/inventoryReplenishParameters/{ReplParamId}
Request
Path Parameters
-
ReplParamId(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 : inventoryReplenishParameters-item-response
Type:
Show Source
object-
AverageDailyDemand: number
Indicates the average daily demand for an item.
-
CurParLevel: number
Indicates the current minimum PAR quantity for the item.
-
CurrentMaximumQuantity: number
Indicates the current maximum value for the item quantity.
-
CurrentMinimumQuantity: number
Indicates the current minimum value for the item quantity.
-
CurrentParMaximumQuantity: number
Indicates the current maximum PAR quantity for the item.
-
DataSource: string
Maximum Length:
1Source associated with the record. S indicates calculated by system and U indicates user uploaded. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemDescription: string
Read Only:
trueMaximum Length:255Description of the inventory item. -
ItemNumber: string
Read Only:
trueMaximum Length:255Number that uniquely identifies the item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Read Only:
trueMaximum Length:255Name of the inventory locator. -
MaximumValueDeviation: string
Read Only:
trueMaximum Length:255Indicates the maximum value deviation percentage. -
MinimumValueDeviation: string
Read Only:
trueMaximum Length:255Indicates the minimum value deviation percentage. -
OrganizationCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Unique identifier for the organization.
-
OrganizationName: string
Read Only:
trueMaximum Length:255Name of the organization. -
OverrideMaximumQuantity: number
Indicates the override value for the maximum quantity for the item.
-
OverrideMinimumQuantity: number
Indicates the override value for the minimum quantity for the item.
-
OverrideParLevel: number
Indicates the override value for the PAR minimum quantity for the item.
-
OverrideParMaximumQuantity: number
Indicates the override value for the PAR maximum quantity for the item.
-
ParMaximumQuantityDeviation: string
Read Only:
trueMaximum Length:255Indicates the PAR maximum deviation percentage. -
ParValueDeviation: string
Read Only:
trueMaximum Length:255Indicates the PAR value deviation percentage. -
PublishedDate: string
(date)
Publish date for min-max values and PAR levels.
-
ReplenishType: string
Maximum Length:
1The replenishment parameter type for min-max or PAR. A value of M indicates min-max and value of P indicates PAR. -
ReplParamId: integer
(int64)
Unique identifier for the replenish parameters.
-
RunDate: string
(date-time)
Indicates the date the replenish parameters were created.
-
SafetyStock: number
Indicates the safety stock for an item.
-
Status: string
Maximum Length:
1Indicates the status of the record. Valid values are P and U. P indicates Published, and U indicates Unpublished. -
StatusMeaning: string
Read Only:
trueMaximum Length:255Status meaning for the status value. -
SubinventoryCode: string
Maximum Length:
10Abbreviation that identifies the subinventory. -
SubinventoryName: string
Read Only:
trueMaximum Length:255Name of the subinventory. -
SuggestedMaximumQuantity: number
Indicates the maximum quantity calculated for the item.
-
SuggestedMinimumQuantity: number
Indicates the suggested minimum quantity calculated for the item.
-
SuggestedParMaximumQuantity: number
Indicates the suggested maximum PAR quantity for the item.
-
SugtParLevel: number
Indicates the suggested minimum PAR quantity for the item.
-
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure associated with an item. -
UOMName: string
Read Only:
trueMaximum Length:255Name that identifies the unit of measure associated with an item.
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.