1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Replenishment Policy Assignment Sets Version 2
  5. Policy Segment Parameters

Get parameters for all segments

get

/fscmRestApi/resources/11.13.18.05/replenishmentPolicyAssignmentSetsV2/{PolicySetId}/child/PolicySegmentParameters

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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 segment-level policy parameters according to the specified criteria.
      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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 segment parameters.
    • CreationDate; string; Date when the user created the segment parameters.
    • DaysOfCoverBasis; string; Basis to calculate days of cover. Valid values are History and Forecast. The default value is Forecast.
    • DaysOfCoverBasisCode; integer; 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.
    • DefaultOrderQuantity; integer; Default value defined for the order quantity.
    • DefaultOrderingCost; integer; Default value defined for the ordering cost.
    • 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; Calendar used for the fixed order cycle policy type.
    • FixedOrderCycleCalendarCode; string; 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 when the user most recently updated the segment parameters.
    • LastUpdateLogin; string; Login that the user used when updating the segment parameters.
    • LastUpdatedBy; string; User who most recently updated the segment parameters.
    • MaximumOverride; integer; Manual override value defined for the maximum quantity or maximum days depending on policy unit of measure.
    • MaximumQuantityCalculationMethod; string; 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; 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; number; Number of days defined for the par replenishment time period.
    • PolicySetId; integer; Value that uniquely identifies the policy assignment set.
    • PolicyType; string; 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; Type of policy unit of measure. Valid values are Units and Days. The default value is Units.
    • PolicyUOMCode; integer; 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; 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; 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; Description of the segment.
    • SegmentId; integer; Value that uniquely identifies the segment.
    • SegmentName; string; Name of the segment.
    • TargetServiceLevelPercentage; integer; Percentage value defined for the target service level to calculate the safety stock.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : replenishmentPolicyAssignmentSetsV2-PolicySegmentParameters
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : replenishmentPolicyAssignmentSetsV2-PolicySegmentParameters-item-response
Type: object
Show Source
Back to Top