Get one policy assignment set
get
/fscmRestApi/resources/11.13.18.05/replenishmentPolicyAssignmentSetsV2/{PolicySetId}
Request
Path Parameters
-
PolicySetId(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:
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.
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 : replenishmentPolicyAssignmentSetsV2-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the policy assignment set. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the policy assignment set. -
Description: string
Maximum Length:
240
Description of the policy assignment set. -
ItemLocationLevelPolicyOverrides: array
Item Location Level Policy Overrides
Title:
Item Location Level Policy Overrides
The Item Location Level Policy Overrides resource manages policy overrides for the item location combination like minimum quantity, maximum quantity, and so on. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the policy assignment set. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the policy assignment set. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the policy assignment set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number of times the object has been updated.
-
PolicyAssignmentSetDuplicate: array
Duplicate Replenishment Policy Assignment Sets
Title:
Duplicate Replenishment Policy Assignment Sets
Duplication of an existing policy assignment set. -
PolicySegmentParameters: array
Policy Segment Parameters
Title:
Policy Segment Parameters
The Policy Segment Parameters resource manages parameters for the segments like policy type, safety stock, minimum quantity, and so on. -
PolicySetId: integer
(int64)
Value that uniquely identifies the policy assignment set.
-
PolicySetName: string
Maximum Length:
120
Name of the policy assignment set. -
SegmentGroupId: integer
(int64)
Value that uniquely identifies the segment group.
-
SegmentGroupName: string
Maximum Length:
120
Name of the segment group. -
UnassignedSegmentLOV: array
Unassigned Segments List of Values
Title:
Unassigned Segments List of Values
This list of values includes all the segments for which policies aren't assigned. -
UsedInPlansLOV: array
Plans List of Values
Title:
Plans List of Values
This list of values includes all the plan names where the policy assignment set has been used.
Nested Schema : Item Location Level Policy Overrides
Type:
array
Title:
Item Location Level Policy Overrides
The Item Location Level Policy Overrides resource manages policy overrides for the item location combination like minimum quantity, maximum quantity, and so on.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Duplicate Replenishment Policy Assignment Sets
Type:
array
Title:
Duplicate Replenishment Policy Assignment Sets
Duplication of an existing policy assignment set.
Show Source
Nested Schema : Policy Segment Parameters
Type:
array
Title:
Policy Segment Parameters
The Policy Segment Parameters resource manages parameters for the segments like policy type, safety stock, minimum quantity, and so on.
Show Source
Nested Schema : Unassigned Segments List of Values
Type:
array
Title:
Unassigned Segments List of Values
This list of values includes all the segments for which policies aren't assigned.
Show Source
Nested Schema : Plans List of Values
Type:
array
Title:
Plans List of Values
This list of values includes all the plan names where the policy assignment set has been used.
Show Source
Nested Schema : replenishmentPolicyAssignmentSetsV2-ItemLocationLevelPolicyOverrides-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the policy overrides. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the policy overrides. -
EOQOverride: integer
Manual override value defined for the economic order quantity.
-
FixedOrderCycleCalendar: string
Maximum Length:
255
Calendar used for the fixed order cycle policy type. -
FixedOrderCycleCalendarCode: string
Maximum Length:
22
Value that uniquely identifies the fixed order cycle calendar. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
Item: string
Maximum Length:
255
Name of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the policy overrides. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the policy overrides. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the policy overrides. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Maximum Length:
255
Name of the location. -
LocationId: integer
(int64)
Value that uniquely identifies the location.
-
MaximumOverride: integer
Manual override value defined for the maximum quantity or maximum days depending on the policy unit of measure.
-
MinimumOverride: integer
Manual override value defined for the minimum quantity or minimum days depending on the policy unit of measure.
-
ObjectVersionNumber: integer
(int32)
Number of times the object has been updated.
-
OrderQuantityOverride: integer
Manual override value defined for the order quantity.
-
ParLevelOverride: integer
Manual override value defined for the par level.
-
ParMaximumQuantityOverride: integer
Manual override value defined for the par maximum quantity.
-
PolicySetId: integer
(int64)
Value that uniquely identifies the policy assignment set.
-
PolicyType: string
Read Only:
true
Maximum Length:255
Type of policy. Valid values are Min-max planning, Fixed order cycle, ROP and order quantity, and ROP and EOQ. The default value is Min-max planning. -
PolicyTypeCode: integer
Code that identifies the policy type. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_TYPE.
-
PolicyUOM: string
Read Only:
true
Maximum Length:255
Type of policy unit of measure. Valid values are Units and Days. The default value is Units. -
PolicyUOMCode: integer
(int32)
Code that identifies the policy unit of measure. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_UOM.
-
ROPOverride: integer
Manual override value defined for the reorder point quantity or reorder point days depending on the policy unit of measure.
-
SafetyStockOverride: integer
Manual override value defined for the safety stock.
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.
Nested Schema : replenishmentPolicyAssignmentSetsV2-PolicyAssignmentSetDuplicate-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Maximum Length:
255
Text of the error message, if any, encountered when duplicating a policy assignment set. -
NewPolicySetDescription: string
Maximum Length:
255
Description of the new policy assignment set. -
NewPolicySetId: integer
Value that uniquely identifies the new policy assignment set.
-
NewPolicySetName: string
Maximum Length:
255
Name of the new policy assignment set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : replenishmentPolicyAssignmentSetsV2-PolicySegmentParameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the segment parameters. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the segment parameters. -
DaysOfCoverBasis: string
Read Only:
true
Maximum Length:255
Basis to calculate days of cover. Valid values are History and Forecast. The default value is Forecast. -
DaysOfCoverBasisCode: integer
(int32)
Code that identifies the basis to calculate days of cover. A list of accepted values is defined in the lookup type ORA_MSC_REPL_DAYS_OF_COVER.
-
DefaultCarryingCostPercentage: integer
Default value defined for the carrying cost percentage.
-
DefaultDailyDemand: number
Default value defined for the average daily demand.
-
DefaultEOQ: integer
Default value defined for the economic order quantity.
-
DefaultOrderingCost: integer
Default value defined for the ordering cost.
-
DefaultOrderQuantity: integer
Default value defined for the order quantity.
-
DefaultStandardCost: integer
Default value defined for the standard cost.
-
DeliveriesPERTimePeriod: integer
Value that indicates the number of deliveries per time period.
-
EOQOverride: integer
Manual override value defined for the economic order quantity.
-
ExtrapolationPercentage: integer
Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.
-
FixedOrderCycleCalendar: string
Maximum Length:
255
Calendar used for the fixed order cycle policy type. -
FixedOrderCycleCalendarCode: string
Maximum Length:
22
Code that identifies the calendar. -
HorizonforAverageDailyDemand: integer
Number of days defined for considering forecast or history to calculate the average daily demand.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the segment parameters. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the segment parameters. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the segment parameters. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumOverride: integer
Manual override value defined for the maximum quantity or maximum days depending on policy unit of measure.
-
MaximumQuantityCalculationMethod: string
Read Only:
true
Maximum Length:255
Method 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. -
MaximumQuantityCalculationMethodCode: integer
Code that identifies the method used to calculate the maximum quantity. A list of accepted values is defined in the lookup type ORA_MSC_REPL_MAX_CALC_METHOD.
-
MaximumQuantityDaysofCover: integer
Value that indicates the maximum quantity days of cover.
-
MinimumOverride: integer
Manual override value defined for the minimum quantity or minimum days depending on the policy unit of measure.
-
ObjectVersionNumber: integer
(int32)
Number of times the object has been updated.
-
OrderQuantityOverride: integer
Manual override value defined for the order quantity.
-
ParLevelOverride: integer
Manual override value defined for the par level.
-
ParMaximumQuantityOverride: integer
Manual override value defined for the par maximum quantity.
-
ParTimePeriod: integer
Number of days defined for the par replenishment time period.
-
PolicyType: string
Read Only:
true
Maximum Length:255
Type of policy. Valid values are Min-max planning, Fixed order cycle, ROP and order quantity, and ROP and EOQ. The default value is Min-max planning. -
PolicyTypeCode: integer
Code that identifies the policy type. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_TYPE.
-
PolicyUOM: string
Read Only:
true
Maximum Length:255
Type of policy unit of measure. Valid values are Units and Days. The default value is Units. -
PolicyUOMCode: integer
(int32)
Code that identifies the policy unit of measure. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_UOM.
-
ROPOverride: integer
Manual override value defined for the reorder point quantity or reorder point days depending on the policy unit of measure.
-
SafetyStockCalculationMethod: string
Read Only:
true
Maximum Length:255
Method used to calculate the safety stock. Valid values are Days of cover and Service level based. The default value is Days of Cover. -
SafetyStockCalculationMethodCode: integer
(int32)
Code that identifies the method used to calculate the safety stock. A list of accepted values is defined in the lookup type ORA_MSC_REPL_SS_METHOD.
-
SafetyStockDaysofCover: integer
Value that indicates the safety stock days of cover.
-
SafetyStockOverride: integer
Manual override value defined for the safety stock.
-
SegmentDescription: string
Read Only:
true
Maximum Length:255
Description of the segment. -
SegmentId: integer
(int64)
Value that uniquely identifies the segment.
-
SegmentName: string
Maximum Length:
255
Name of the segment. -
TargetServiceLevelPercentage: integer
Percentage value defined for the target service level to calculate the safety stock.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : replenishmentPolicyAssignmentSetsV2-UnassignedSegmentLOV-item-response
Type:
Show Source
object
-
Description: string
Read Only:
true
Maximum Length:240
Description of the segment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the plan. -
PolicySetId: integer
Read Only:
true
Value that uniquely identifies the policy assignment set. -
SegmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the segment. -
SegmentName: string
Read Only:
true
Maximum Length:120
Name of the segment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : replenishmentPolicyAssignmentSetsV2-UsedInPlansLOV-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan. -
PlanType: number
Read Only:
true
Type of plan. -
PolicyAssignmentSetId: integer
(int64)
Read Only:
true
Value that uniquely identifies the policy assignment set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ItemLocationLevelPolicyOverrides
-
Parameters:
- PolicySetId:
$request.path.PolicySetId
The Item Location Level Policy Overrides resource manages policy overrides for the item location combination like minimum quantity, maximum quantity, and so on. - PolicySetId:
- PolicyAssignmentSetDuplicate
-
Parameters:
- PolicySetId:
$request.path.PolicySetId
Duplication of an existing policy assignment set. - PolicySetId:
- PolicySegmentParameters
-
Parameters:
- PolicySetId:
$request.path.PolicySetId
The Policy Segment Parameters resource manages parameters for the segments like policy type, safety stock, minimum quantity, and so on. - PolicySetId:
- UnassignedSegmentLOV
-
Parameters:
- PolicySetId:
$request.path.PolicySetId
This list of values includes all the segments for which policies aren't assigned. - PolicySetId:
- UsedInPlansLOV
-
Parameters:
- PolicySetId:
$request.path.PolicySetId
This list of values includes all the plan names where the policy assignment set has been used. - PolicySetId:
Examples
This example describes how to get one policy assignment set.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/PolicySetId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2?q=PolicySetName='PAS-RPLO'"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "PolicySetId": 300100187642135, "PolicySetName": "PAS-RPLO", "Description": "Assignment Set for Automation - RPLO", "SegmentGroupId": 300100183521769, "SegmentGroupName": "SG-RPLO", "ObjectVersionNumber": 1, "CreatedBy": "REPL_USER", "LastUpdatedBy": "REPL_USER", "LastUpdateDate": "2021-07-22T09:58:51+00:00", "LastUpdateLogin": null, "CreationDate": "2021-07-22T09:58:51+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135", "name": "replenishmentPolicyAssignmentSetsV2", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135", "name": "replenishmentPolicyAssignmentSetsV2", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135/child/ItemLocationLevelPolicyOverrides", "name": "ItemLocationLevelPolicyOverrides", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135/child/PolicyAssignmentSetDuplicate", "name": "PolicyAssignmentSetDuplicate", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135/child/PolicySegmentParameters", "name": "PolicySegmentParameters", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135/child/UnassignedSegmentLOV", "name": "UnassignedSegmentLOV", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100187642135/child/UsedInPlansLOV", "name": "UsedInPlansLOV", "kind": "collection" } ] }, { "PolicySetId": 300100206744734, "PolicySetName": "PAS-SI-EXT", "Description": "Assignment Set for Automation SubInv", "SegmentGroupId": 300100206691295, "SegmentGroupName": "SG-SI-EXT", "ObjectVersionNumber": 1, "CreatedBy": "REPL_USER", "LastUpdatedBy": "REPL_USER", "LastUpdateDate": "2021-04-12T12:54:12+00:00", "LastUpdateLogin": null, "CreationDate": "2021-04-12T12:54:12+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734", "name": "replenishmentPolicyAssignmentSetsV2", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734", "name": "replenishmentPolicyAssignmentSetsV2", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734/child/ItemLocationLevelPolicyOverrides", "name": "ItemLocationLevelPolicyOverrides", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734/child/PolicyAssignmentSetDuplicate", "name": "PolicyAssignmentSetDuplicate", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734/child/PolicySegmentParameters", "name": "PolicySegmentParameters", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734/child/UnassignedSegmentLOV", "name": "UnassignedSegmentLOV", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100206744734/child/UsedInPlansLOV", "name": "UsedInPlansLOV", "kind": "collection" } ] }], "count": 2, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2", "name": "replenishmentPolicyAssignmentSetsV2", "kind": "collection" } ] }