Get all policy segments
get
/fscmRestApi/resources/11.13.18.05/replenishmentPolicyAssignmentSets/{PolicySetId}/child/PolicySegments
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds segments according to the segment identifier.
Finder Variables- PolicySetId; integer; Value that uniquely identifies the policy assignment set.
- SegmentId; integer; Value that uniquely identifies the segment.
- SegmentIdFinder Finds segments according to the segment identifier.
Finder Variables- SegmentId; integer; Value that uniquely identifies the segment.
- PrimaryKey Finds segments according to the segment identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; User who created the segments.
- CreationDate; string; Date when the user created the segments.
- Description; string; Description of the policy segment.
- LastUpdateDate; string; Date when the user most recently updated the segments.
- LastUpdateLogin; string; Login that the user used when updating the segments.
- LastUpdatedBy; string; User who most recently updated the segments.
- ObjectVersionNumber; integer; Number of times the object has been updated.
- PolicySetId; integer; Value that uniquely identifies the policy assignment set.
- SegmentId; integer; Value that uniquely identifies the segment.
- SegmentName; string; Name of the segment.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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(required):
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(required):
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 : replenishmentPolicyAssignmentSets-PolicySegments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : replenishmentPolicyAssignmentSets-PolicySegments-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the segments. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the segments. -
Description: string
Read Only:
true
Maximum Length:240
Description of the policy segment. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the segments. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the segments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the segments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number of times the object has been updated.
-
PolicySetId: integer
(int64)
Value that uniquely identifies the policy assignment set.
-
SegmentId: integer
(int64)
Value that uniquely identifies the segment.
-
SegmentName: string
Read Only:
true
Maximum Length:120
Name of the segment. -
SegmentParameters: array
Segment Parameters
Title:
Segment Parameters
The Policy Segment Parameters resource manages parameters for the segments like policy type, safety stock, minimum quantity, and so on.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Segment Parameters
Type:
array
Title:
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 : 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 : replenishmentPolicyAssignmentSets-PolicySegments-SegmentParameters-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:4000
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
(int32)
Default value defined for the carrying cost percentage.
-
DefaultDailyDemand: number
Default value defined for the average daily demand.
-
DefaultEOQ: integer
(int32)
Default value defined for the economic order quantity.
-
DefaultOrderingCost: integer
(int32)
Default value defined for the ordering cost.
-
DefaultOrderQuantity: integer
(int32)
Default value defined for the order quantity.
-
DefaultStandardCost: integer
(int32)
Default value defined for the standard cost.
-
EOQOverride: integer
(int32)
Manual override value defined for the economic order quantity.
-
ExtrapolationPercentage: integer
(int32)
Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.
-
FixedOrderCycleCalendar: string
Read Only:
true
Maximum Length:240
Calendar used for the fixed order cycle policy type. -
FixedOrderCycleCalendarCode: number
Code that identifies the calendar.
-
HorizonforAverageDailyDemand: integer
(int32)
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
(int32)
Manual override value defined for the maximum quantity or maximum days depending on policy unit of measure.
-
MaximumQuantityCalculationMethod: string
Read Only:
true
Maximum Length:4000
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
(int32)
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
(int32)
Value that indicates the maximum quantity days of cover.
-
MinimumOverride: integer
(int32)
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
(int32)
Manual override value defined for the order quantity.
-
PolicySetId: integer
(int64)
Value that uniquely identifies the policy assignment set.
-
PolicyType: string
Read Only:
true
Maximum Length:4000
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:4000
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
(int32)
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:4000
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
(int32)
Value that indicates the safety stock days of cover.
-
SafetyStockOverride: integer
(int32)
Manual override value defined for the safety stock.
-
SegmentId: integer
(int64)
Value that uniquely identifies the segment.
-
TargetServiceLevelPercentage: integer
(int32)
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
Examples
This example describes how to get all policy segments.
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/replenishmentPolicyAssignmentSets/PolicySetId/child/PolicySegments"
For example, the following command gets all policy segments:
curl -u username:password "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "SegmentId": 300100182121952, "PolicySetId": 300100182122087, "ObjectVersionNumber": 2, "SegmentName": "HighCostHighVolume", "Description": "High Cost High Volume", "CreatedBy": "REPL_USER", "CreationDate": "2019-09-04T07:20:26.786+00:00", "LastUpdateDate": "2019-09-04T07:25:33.450+00:00", "LastUpdatedBy": "REPL_USER", "LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121952", "name": "PolicySegments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121952", "name": "PolicySegments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087", "name": "replenishmentPolicyAssignmentSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121952/child/SegmentParameters", "name": "SegmentParameters", "kind": "collection" } ] }, { "SegmentId": 300100182121953, "PolicySetId": 300100182122087, "ObjectVersionNumber": 2, "SegmentName": "HighCostMediumVolume", "Description": "High Cost Medium Volume", "CreatedBy": "REPL_USER", "CreationDate": "2019-09-04T07:21:15.522+00:00", "LastUpdateDate": "2019-09-04T07:26:13.105+00:00", "LastUpdatedBy": "REPL_USER", "LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121953", "name": "PolicySegments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121953", "name": "PolicySegments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087", "name": "replenishmentPolicyAssignmentSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121953/child/SegmentParameters", "name": "SegmentParameters", "kind": "collection" } ] }, { "SegmentId": 300100182121954, "PolicySetId": 300100182122087, "ObjectVersionNumber": 2, "SegmentName": "HighCostLowVolume", "Description": "High Cost Low Volume", "CreatedBy": "REPL_USER", "CreationDate": "2019-09-04T07:21:50.075+00:00", "LastUpdateDate": "2019-09-04T07:26:27.983+00:00", "LastUpdatedBy": "REPL_USER", "LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121954", "name": "PolicySegments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121954", "name": "PolicySegments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087", "name": "replenishmentPolicyAssignmentSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121954/child/SegmentParameters", "name": "SegmentParameters", "kind": "collection" } ] }, { "SegmentId": 300100182121955, "PolicySetId": 300100182122087, "ObjectVersionNumber": 2, "SegmentName": "LowCostHighVolume", "Description": "Low Cost High Volume", "CreatedBy": "REPL_USER", "CreationDate": "2019-09-04T07:22:33.480+00:00", "LastUpdateDate": "2019-09-04T07:26:51.212+00:00", "LastUpdatedBy": "REPL_USER", "LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121955", "name": "PolicySegments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121955", "name": "PolicySegments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087", "name": "replenishmentPolicyAssignmentSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121955/child/SegmentParameters", "name": "SegmentParameters", "kind": "collection" } ] }, { "SegmentId": 300100182121956, "PolicySetId": 300100182122087, "ObjectVersionNumber": 2, "SegmentName": "LowCostMediumVolume", "Description": "Low Cost Medium Volume", "CreatedBy": "REPL_USER", "CreationDate": "2019-09-04T07:23:17.265+00:00", "LastUpdateDate": "2019-09-04T07:27:16.943+00:00", "LastUpdatedBy": "REPL_USER", "LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121956", "name": "PolicySegments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121956", "name": "PolicySegments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087", "name": "replenishmentPolicyAssignmentSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121956/child/SegmentParameters", "name": "SegmentParameters", "kind": "collection" } ] }, { "SegmentId": 300100182121957, "PolicySetId": 300100182122087, "ObjectVersionNumber": 2, "SegmentName": "LowCostLowVolume", "Description": "LowCostLowVolume", "CreatedBy": "REPL_USER", "CreationDate": "2019-09-04T07:23:52.243+00:00", "LastUpdateDate": "2019-09-04T07:27:37.928+00:00", "LastUpdatedBy": "REPL_USER", "LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121957", "name": "PolicySegments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121957", "name": "PolicySegments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087", "name": "replenishmentPolicyAssignmentSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments/300100182121957/child/SegmentParameters", "name": "SegmentParameters", "kind": "collection" } ] } ], "count": 6, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments", "name": "PolicySegments", "kind": "collection" } ] }