Update one record for policy comparison
patch
/fscmRestApi/resources/11.13.18.05/replenishmentPolicyComparisons/{replenishmentPolicyComparisonsUniqID}
Request
Path Parameters
-
replenishmentPolicyComparisonsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId, SegmentId, InventoryItemId and OrganizationId ---for the Policy Comparisons resource and used to uniquely identify an instance of Policy Comparisons. The client should not generate the hash key value. Instead, the client should query on the Policy Comparisons collection resource with a filter on the primary key values in order to navigate to a specific instance of Policy Comparisons.
For example: replenishmentPolicyComparisons?q=PlanId=<value1>;SegmentId=<value2>;InventoryItemId=<value3>;OrganizationId=<value4>
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-
AcceptAllExecute: array
Run Accept-All Processes
Title:
Run Accept-All ProcessesAcceptance of policies for selected item location combinations. -
FinalMaximumDays: integer
Final maximum value in days.
-
FinalMaximumQuantity: integer
Final maximum quantity value.
-
FinalMinimumDays: integer
Final minimum value in days.
-
FinalMinimumQuantity: integer
Final minimum quantity value.
-
FinalParLevel: integer
Final par-level value.
-
FinalParMaximum: integer
Final maximum par value.
-
FinalROPDays: integer
Final reorder point value in days.
-
FinalROPQuantity: integer
Final reorder point value.
-
ItemName: string
Maximum Length:
255Name of the item. -
LocationName: string
Maximum Length:
255Name of the location. -
MaximumDaysAdjusted: integer
Adjusted maximum policy value in days.
-
MaximumDaysDeviation: integer
Deviation in maximum days policy value.
-
MaximumDaysPriorTypeName: string
Maximum Length:
255Name of the type of the prior maximum days policy value. -
MaximumQuantityAdjusted: integer
Adjusted maximum quantity value.
-
MaximumQuantityDeviation: integer
Deviation in maximum quantity value.
-
MaximumQuantityPriorTypeName: string
Maximum Length:
255Name of type of the prior maximum quantity value. -
MinimumDaysAdjusted: integer
Adjusted minimum policy value in days.
-
MinimumDaysDeviation: integer
Deviation in minimum days policy value.
-
MinimumDaysPriorTypeName: string
Maximum Length:
255Name of the type of the prior minimum days policy value. -
MinimumQuantityAdjusted: integer
Adjusted minimum quantity value.
-
MinimumQuantityDeviation: integer
Deviation in minimum quantity value.
-
MinimumQuantityPriorTypeName: string
Maximum Length:
255Name of the type of prior minimum quantity value. -
NotesIndicator: string
Maximum Length:
255Value that indicates whether notes are present for the item. -
ParLevelAdjusted: integer
Adjusted par-level value.
-
ParLevelDeviation: integer
Deviation in par-level value.
-
ParLevelPriorTypeName: string
Maximum Length:
255Name of prior par-level value type. -
ParMaximumAdjusted: integer
Adjusted par maximum value.
-
ParMaximumDeviation: integer
Deviation in par maximum value.
-
ParMaximumPriorTypeName: string
Maximum Length:
255Name of the type of prior par maximum value. -
PlanName: string
Maximum Length:
255Unique identifier for a plan name. -
PlannerCode: string
Maximum Length:
255Abbreviation that identifies the planner responsible for the item. -
PolicyReviewStatus: integer
Status of the policy comparison review process.
-
PolicyReviewStatusName: string
Maximum Length:
255Name of the status of the policy comparison review process. -
PolicyTypeName: string
Maximum Length:
255Name of the type of policy. -
PolicyUOMName: string
Maximum Length:
255Name of the unit of measure in which policies are defined or calculated. -
PublishParExecute: array
Run Publish Par Processes
Title:
Run Publish Par ProcessesPublishing of par policies for selected item locations. -
RopDaysAdjusted: integer
Adjusted reorder point value in days.
-
RopDaysDeviation: integer
Deviation in reorder point days value.
-
RopDaysPriorTypeName: string
Maximum Length:
255Name of the type of prior reorder point policy value. -
RopQuantityAdjusted: integer
Adjusted reorder point value.
-
RopQuantityDeviation: integer
Deviation in reorder point value.
-
RopQuantityPriorTypeName: string
Maximum Length:
255Name of the type of prior reorder point value. -
SegmentName: string
Maximum Length:
255Name of the segment. -
UpdatePoliciesExecute: array
Run Update Policies Processes
Title:
Run Update Policies ProcessesUpdate of policies for selected item location combinations. -
UpdateStatus: integer
(int32)
Updated status of the policy comparison row.
Nested Schema : Run Accept-All Processes
Type:
arrayTitle:
Run Accept-All ProcessesAcceptance of policies for selected item location combinations.
Show Source
Nested Schema : Run Publish Par Processes
Type:
arrayTitle:
Run Publish Par ProcessesPublishing of par policies for selected item locations.
Show Source
Nested Schema : Run Update Policies Processes
Type:
arrayTitle:
Run Update Policies ProcessesUpdate of policies for selected item location combinations.
Show Source
Nested Schema : replenishmentPolicyComparisons-AcceptAllExecute-item-patch-request
Type:
Show Source
object-
ESSProcessId: integer
(int64)
Value that uniquely identifies the accept-all process.
-
Message: string
Maximum Length:
4000Name of the message. -
WhereCondition: string
Maximum Length:
4000Value that uniquely identifies the condition.
Nested Schema : replenishmentPolicyComparisons-PublishParExecute-item-patch-request
Type:
Show Source
object-
ESSProcessId: string
Maximum Length:
255Value that uniquely identifies the publish par process. -
ExecutionId: integer
(int64)
Value that uniquely identifies the execution process.
-
Message: string
Maximum Length:
4000Name of the message. -
PlanId: integer
Value that uniquely identifies the plan.
-
PolicyAssignmentSetId: integer
Value that uniquely identifies the policy assignment set.
-
SegmentGroupId: integer
Value that uniquely identifies the segment group.
Nested Schema : replenishmentPolicyComparisons-UpdatePoliciesExecute-item-patch-request
Type:
Show Source
object-
ESSProcessId: integer
(int64)
Value that uniquely identifies the update policies process.
-
Message: string
Maximum Length:
4000Name of the message. -
PlanId: integer
Value that uniquely identifies the plan.
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 : replenishmentPolicyComparisons-item-response
Type:
Show Source
object-
AcceptAllExecute: array
Run Accept-All Processes
Title:
Run Accept-All ProcessesAcceptance of policies for selected item location combinations. -
AverageDailyDmdPrior: integer
Prior average daily demand value.
-
AverageDailyDmdSuggested: integer
Suggested average daily demand value.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the policy comparison records. -
CreationDate: string
(date-time)
Read Only:
trueDate when the policy comparison records were created. -
EoqPrior: integer
Prior economic order quantity value.
-
EoqSuggested: integer
Suggested economic order quantity value.
-
FinalMaximumDays: integer
Final maximum value in days.
-
FinalMaximumQuantity: integer
Final maximum quantity value.
-
FinalMinimumDays: integer
Final minimum value in days.
-
FinalMinimumQuantity: integer
Final minimum quantity value.
-
FinalParLevel: integer
Final par-level value.
-
FinalParMaximum: integer
Final maximum par value.
-
FinalROPDays: integer
Final reorder point value in days.
-
FinalROPQuantity: integer
Final reorder point value.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemName: string
Maximum Length:
255Name of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the policy comparison records. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the policy comparison records. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationName: string
Maximum Length:
255Name of the location. -
MaximumDays: integer
Maximum policy value in days.
-
MaximumDaysAdjusted: integer
Adjusted maximum policy value in days.
-
MaximumDaysDeviation: integer
Deviation in maximum days policy value.
-
MaximumDaysPrior: integer
Prior maximum policy value in days.
-
MaximumDaysPriorType: integer
Type of prior maximum policy value in days.
-
MaximumDaysPriorTypeName: string
Maximum Length:
255Name of the type of the prior maximum days policy value. -
MaximumDaysSuggested: integer
Suggested maximum policy value in days.
-
MaximumQuantity: integer
Maximum quantity value.
-
MaximumQuantityAdjusted: integer
Adjusted maximum quantity value.
-
MaximumQuantityDeviation: integer
Deviation in maximum quantity value.
-
MaximumQuantityPrior: integer
Prior maximum quantity value.
-
MaximumQuantityPriorType: integer
Type of prior maximum quantity value.
-
MaximumQuantityPriorTypeName: string
Maximum Length:
255Name of type of the prior maximum quantity value. -
MaximumQuantitySuggested: integer
Suggested maximum quantity value.
-
MinimumDays: integer
Minimum policy value in days.
-
MinimumDaysAdjusted: integer
Adjusted minimum policy value in days.
-
MinimumDaysDeviation: integer
Deviation in minimum days policy value.
-
MinimumDaysPrior: integer
Prior minimum policy value in days.
-
MinimumDaysPriorType: integer
Type of prior minimum policy value in days.
-
MinimumDaysPriorTypeName: string
Maximum Length:
255Name of the type of the prior minimum days policy value. -
MinimumDaysSuggested: integer
Suggested minimum policy value in days.
-
MinimumQuantity: integer
Minimum quantity value.
-
MinimumQuantityAdjusted: integer
Adjusted minimum quantity value.
-
MinimumQuantityDeviation: integer
Deviation in minimum quantity value.
-
MinimumQuantityPrior: integer
Prior minimum quantity value.
-
MinimumQuantityPriorType: integer
Type of prior minimum quantity value.
-
MinimumQuantityPriorTypeName: string
Maximum Length:
255Name of the type of prior minimum quantity value. -
MinimumQuantitySuggested: integer
Suggested minimum quantity value.
-
NotesIndicator: string
Maximum Length:
255Value that indicates whether notes are present for the item. -
OrderQuantityPrior: integer
Value of the prior order quantity.
-
OrderQuantitySuggested: integer
Suggested order quantity value.
-
OrganizationId: integer
(int64)
Value that identifies the organization code.
-
ParLevel: integer
Par level value.
-
ParLevelAdjusted: integer
Adjusted par-level value.
-
ParLevelDeviation: integer
Deviation in par-level value.
-
ParLevelPrior: integer
Prior par-level value.
-
ParLevelPriorType: integer
Type of prior par-level value.
-
ParLevelPriorTypeName: string
Maximum Length:
255Name of prior par-level value type. -
ParLevelSuggested: integer
Suggested par-level value.
-
ParMaximum: integer
Par maximum value.
-
ParMaximumAdjusted: integer
Adjusted par maximum value.
-
ParMaximumDeviation: integer
Deviation in par maximum value.
-
ParMaximumPrior: integer
Prior par maximum value.
-
ParMaximumPriorType: integer
Type of prior par maximum value.
-
ParMaximumPriorTypeName: string
Maximum Length:
255Name of the type of prior par maximum value. -
ParMaximumSuggested: integer
Suggested maximum par value.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
PlanName: string
Maximum Length:
255Unique identifier for a plan name. -
PlannerCode: string
Maximum Length:
255Abbreviation that identifies the planner responsible for the item. -
PolicyReviewStatus: integer
Status of the policy comparison review process.
-
PolicyReviewStatusName: string
Maximum Length:
255Name of the status of the policy comparison review process. -
PolicyType: integer
Type of policy.
-
PolicyTypeName: string
Maximum Length:
255Name of the type of policy. -
PolicyUOM: integer
Unit of measure in which policies are defined or calculated.
-
PolicyUOMName: string
Maximum Length:
255Name of the unit of measure in which policies are defined or calculated. -
PublishParExecute: array
Run Publish Par Processes
Title:
Run Publish Par ProcessesPublishing of par policies for selected item locations. -
RopDays: integer
Reorder point value in days.
-
RopDaysAdjusted: integer
Adjusted reorder point value in days.
-
RopDaysDeviation: integer
Deviation in reorder point days value.
-
RopDaysPrior: integer
Prior reorder point value in days.
-
RopDaysPriorType: integer
Type of prior reorder point value in days.
-
RopDaysPriorTypeName: string
Maximum Length:
255Name of the type of prior reorder point policy value. -
RopDaysSuggested: integer
Suggested reorder point value in days.
-
RopQuantity: integer
Reorder point value.
-
RopQuantityAdjusted: integer
Adjusted reorder point value.
-
RopQuantityDeviation: integer
Deviation in reorder point value.
-
RopQuantityPrior: integer
Prior reorder point value.
-
RopQuantityPriorType: integer
Type of prior reorder point value.
-
RopQuantityPriorTypeName: string
Maximum Length:
255Name of the type of prior reorder point value. -
RopQuantitySuggested: integer
Suggested reorder point value.
-
SegmentId: integer
(int64)
Value that uniquely identifies the segment.
-
SegmentName: string
Maximum Length:
255Name of the segment. -
SsDaysPrior: integer
Prior safety stock value in days.
-
SsDaysSuggested: integer
Suggested safety stock value in days.
-
SsQuantityPrior: integer
Prior safety stock value.
-
SsQuantitySuggested: integer
Suggested safety stock value.
-
UpdatePoliciesExecute: array
Run Update Policies Processes
Title:
Run Update Policies ProcessesUpdate of policies for selected item location combinations. -
UpdateStatus: integer
(int32)
Updated status of the policy comparison row.
Nested Schema : Run Accept-All Processes
Type:
arrayTitle:
Run Accept-All ProcessesAcceptance of policies for selected item location combinations.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Run Publish Par Processes
Type:
arrayTitle:
Run Publish Par ProcessesPublishing of par policies for selected item locations.
Show Source
Nested Schema : Run Update Policies Processes
Type:
arrayTitle:
Run Update Policies ProcessesUpdate of policies for selected item location combinations.
Show Source
Nested Schema : replenishmentPolicyComparisons-AcceptAllExecute-item-response
Type:
Show Source
object-
ESSProcessId: integer
(int64)
Value that uniquely identifies the accept-all process.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Message: string
Maximum Length:
4000Name of the message. -
WhereCondition: string
Maximum Length:
4000Value that uniquely identifies the condition.
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.
Nested Schema : replenishmentPolicyComparisons-PublishParExecute-item-response
Type:
Show Source
object-
ESSProcessId: string
Maximum Length:
255Value that uniquely identifies the publish par process. -
ExecutionId: integer
(int64)
Value that uniquely identifies the execution process.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Message: string
Maximum Length:
4000Name of the message. -
PlanId: integer
Value that uniquely identifies the plan.
-
PolicyAssignmentSetId: integer
Value that uniquely identifies the policy assignment set.
-
SegmentGroupId: integer
Value that uniquely identifies the segment group.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : replenishmentPolicyComparisons-UpdatePoliciesExecute-item-response
Type:
Show Source
object-
ESSProcessId: integer
(int64)
Value that uniquely identifies the update policies process.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Message: string
Maximum Length:
4000Name of the message. -
PlanId: integer
Value that uniquely identifies the plan.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- AcceptAllExecute
-
Parameters:
- replenishmentPolicyComparisonsUniqID:
$request.path.replenishmentPolicyComparisonsUniqID
Acceptance of policies for selected item location combinations. - replenishmentPolicyComparisonsUniqID:
- PublishParExecute
-
Parameters:
- replenishmentPolicyComparisonsUniqID:
$request.path.replenishmentPolicyComparisonsUniqID
Publishing of par policies for selected item locations. - replenishmentPolicyComparisonsUniqID:
- UpdatePoliciesExecute
-
Parameters:
- replenishmentPolicyComparisonsUniqID:
$request.path.replenishmentPolicyComparisonsUniqID
Update of policies for selected item location combinations. - replenishmentPolicyComparisonsUniqID: