Jump to

• Request
• Response
• Examples

Update parameters for one segment

patch

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

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=
• SegmentId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• MaximumOverride: integer
  Manual override value defined for the maximum quantity or maximum days depending on policy unit of measure.
• 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.
• PolicyTypeCode: integer
  Code that identifies the policy type. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_TYPE.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ParLevelOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par level.",
            "nullable":true
        },
        "SafetyStockCalculationMethodCode":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            }
        },
        "DefaultDailyDemand":{
            "type":"number",
            "description":"Default value defined for the average daily demand.",
            "nullable":true
        },
        "SafetyStockDaysofCover":{
            "type":"integer",
            "description":"Value that indicates the safety stock days of cover.",
            "nullable":true
        },
        "DefaultOrderingCost":{
            "type":"integer",
            "description":"Default value defined for the ordering cost.",
            "nullable":true
        },
        "DaysOfCoverBasisCode":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            }
        },
        "ParTimePeriod":{
            "type":"integer",
            "description":"Number of days defined for the par replenishment time period.",
            "nullable":true
        },
        "DeliveriesPERTimePeriod":{
            "type":"integer",
            "description":"Value that indicates the number of deliveries per time period.",
            "nullable":true
        },
        "MaximumQuantityDaysofCover":{
            "type":"integer",
            "description":"Value that indicates the maximum quantity days of cover.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "PolicyTypeCode":{
            "type":"integer",
            "description":"Code that identifies the policy type. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_TYPE.",
            "nullable":false
        },
        "DefaultOrderQuantity":{
            "type":"integer",
            "description":"Default value defined for the order quantity.",
            "nullable":true
        },
        "HorizonforAverageDailyDemand":{
            "type":"integer",
            "description":"Number of days defined for considering forecast or history to calculate the average daily demand.",
            "nullable":true
        },
        "DefaultCarryingCostPercentage":{
            "type":"integer",
            "description":"Default value defined for the carrying cost percentage.",
            "nullable":true
        },
        "ROPOverride":{
            "type":"integer",
            "description":"Manual override value defined for the reorder point quantity or reorder point days depending on the policy unit of measure.",
            "nullable":true
        },
        "DefaultEOQ":{
            "type":"integer",
            "description":"Default value defined for the economic order quantity.",
            "nullable":true
        },
        "SegmentName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true
        },
        "SafetyStockOverride":{
            "type":"integer",
            "description":"Manual override value defined for the safety stock.",
            "nullable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DefaultStandardCost":{
            "type":"integer",
            "description":"Default value defined for the standard cost.",
            "nullable":true
        },
        "MaximumQuantityCalculationMethodCode":{
            "type":"integer",
            "description":"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.",
            "nullable":true
        },
        "TargetServiceLevelPercentage":{
            "type":"integer",
            "description":"Percentage value defined for the target service level to calculate the safety stock.",
            "nullable":true
        },
        "FixedOrderCycleCalendarCode":{
            "maxLength":"22",
            "type":"string",
            "description":"Code that identifies the calendar.",
            "nullable":true
        },
        "OrderQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the order quantity.",
            "nullable":true
        },
        "FixedOrderCycleCalendar":{
            "maxLength":"255",
            "type":"string",
            "description":"Calendar used for the fixed order cycle policy type.",
            "nullable":true
        },
        "EOQOverride":{
            "type":"integer",
            "description":"Manual override value defined for the economic order quantity.",
            "nullable":true
        },
        "ParMaximumQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par maximum quantity.",
            "nullable":true
        },
        "PolicyUOMCode":{
            "type":"integer",
            "description":"Code that identifies the policy unit of measure. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_UOM.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            }
        },
        "MaximumOverride":{
            "type":"integer",
            "description":"Manual override value defined for the maximum quantity or maximum days depending on policy unit of measure.",
            "nullable":true
        },
        "ExtrapolationPercentage":{
            "type":"integer",
            "description":"Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.",
            "nullable":true
        },
        "MinimumOverride":{
            "type":"integer",
            "description":"Manual override value defined for the minimum quantity or minimum days depending on the policy unit of measure.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : replenishmentPolicyAssignmentSetsV2-PolicySegmentParameters-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment parameters.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParLevelOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par level.",
            "nullable":true,
            "x-queryable":true
        },
        "SafetyStockCalculationMethodCode":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "DefaultDailyDemand":{
            "type":"number",
            "description":"Default value defined for the average daily demand.",
            "nullable":true,
            "x-queryable":true
        },
        "SafetyStockDaysofCover":{
            "type":"integer",
            "description":"Value that indicates the safety stock days of cover.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultOrderingCost":{
            "type":"integer",
            "description":"Default value defined for the ordering cost.",
            "nullable":true,
            "x-queryable":true
        },
        "DaysOfCoverBasisCode":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ParTimePeriod":{
            "type":"integer",
            "description":"Number of days defined for the par replenishment time period.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveriesPERTimePeriod":{
            "type":"integer",
            "description":"Value that indicates the number of deliveries per time period.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityDaysofCover":{
            "type":"integer",
            "description":"Value that indicates the maximum quantity days of cover.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PolicyTypeCode":{
            "type":"integer",
            "description":"Code that identifies the policy type. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultOrderQuantity":{
            "type":"integer",
            "description":"Default value defined for the order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "HorizonforAverageDailyDemand":{
            "type":"integer",
            "description":"Number of days defined for considering forecast or history to calculate the average daily demand.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyUOM":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of policy unit of measure. Valid values are Units and Days. The default value is Units.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the segment parameters.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultCarryingCostPercentage":{
            "type":"integer",
            "description":"Default value defined for the carrying cost percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "ROPOverride":{
            "type":"integer",
            "description":"Manual override value defined for the reorder point quantity or reorder point days depending on the policy unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyType":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultEOQ":{
            "type":"integer",
            "description":"Default value defined for the economic order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the segment parameters.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "x-queryable":true
        },
        "SafetyStockOverride":{
            "type":"integer",
            "description":"Manual override value defined for the safety stock.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumQuantityCalculationMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultStandardCost":{
            "type":"integer",
            "description":"Default value defined for the standard cost.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityCalculationMethodCode":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetServiceLevelPercentage":{
            "type":"integer",
            "description":"Percentage value defined for the target service level to calculate the safety stock.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedOrderCycleCalendarCode":{
            "maxLength":"22",
            "type":"string",
            "description":"Code that identifies the calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedOrderCycleCalendar":{
            "maxLength":"255",
            "type":"string",
            "description":"Calendar used for the fixed order cycle policy type.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysOfCoverBasis":{
            "maxLength":"255",
            "type":"string",
            "description":"Basis to calculate days of cover. Valid values are History and Forecast. The default value is Forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EOQOverride":{
            "type":"integer",
            "description":"Manual override value defined for the economic order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par maximum quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyUOMCode":{
            "type":"integer",
            "description":"Code that identifies the policy unit of measure. A list of accepted values is defined in the lookup type ORA_MSC_REPL_POLICY_UOM.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "MaximumOverride":{
            "type":"integer",
            "description":"Manual override value defined for the maximum quantity or maximum days depending on policy unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SafetyStockCalculationMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"Method used to calculate the safety stock. Valid values are Days of cover and Service level based. The default value is Days of Cover.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtrapolationPercentage":{
            "type":"integer",
            "description":"Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment parameters.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the segment parameters.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumOverride":{
            "type":"integer",
            "description":"Manual override value defined for the minimum quantity or minimum days depending on the policy unit of measure.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to update parameters for segments.

Example 1

This example describes how to update parameters for one segment.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/PolicySetId/child/PolicySegmentParameters/SegmentId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "PolicyTypeCode": 11,
    "PolicyUOMCode": 12,
    "SafetyStockCalculationMethodCode": 1,
    "SafetyStockDaysofCover": 3,
    "TargetServiceLevelPercentage": null,
    "HorizonforAverageDailyDemand": 15,
    "DaysOfCoverBasisCode": 2,
    "ExtrapolationPercentage": null,
    "FixedOrderCycleCalendarCode": null,
    "MaximumQuantityCalculationMethodCode": 1,
    "MaximumQuantityDaysofCover": null,
    "DefaultDailyDemand": 300,
    "DefaultOrderQuantity": null,
    "DefaultEOQ": null,
    "DefaultCarryingCostPercentage": 60,
    "DefaultOrderingCost": 120,
    "DefaultStandardCost": 150,
    "SafetyStockOverride": 60,
    "MinimumOverride": null,
    "MaximumOverride": null,
    "ROPOverride": 100,
    "OrderQuantityOverride": null,
    "EOQOverride": 250,
    "ParLevelOverride": null,
    "ParMaximumQuantityOverride": null,
    "ParTimePeriod": null,
    "DeliveriesPERTimePeriod": null,
    "SegmentName": "Segment1"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "PolicyTypeCode": 11,
    "PolicyType": "ROP and EOQ",
    "PolicyUOMCode": 12,
    "PolicyUOM": "Units",
    "SafetyStockCalculationMethodCode": 1,
    "SafetyStockCalculationMethod": "Days of cover",
    "SafetyStockDaysofCover": 3,
    "TargetServiceLevelPercentage": null,
    "HorizonforAverageDailyDemand": 15,
    "DaysOfCoverBasisCode": 2,
    "DaysOfCoverBasis": "Forecast",
    "ExtrapolationPercentage": null,
    "MaximumQuantityCalculationMethodCode": null,
    "MaximumQuantityCalculationMethod": null,
    "MaximumQuantityDaysofCover": null,
    "FixedOrderCycleCalendarCode": null,
    "FixedOrderCycleCalendar": null,
    "DefaultDailyDemand": 300,
    "DefaultOrderQuantity": null,
    "DefaultEOQ": null,
    "DefaultCarryingCostPercentage": 60,
    "DefaultOrderingCost": 120,
    "DefaultStandardCost": 150,
    "SafetyStockOverride": 60,
    "MinimumOverride": null,
    "MaximumOverride": null,
    "ROPOverride": 100,
    "OrderQuantityOverride": null,
    "EOQOverride": 250,
    "SegmentId": 300100206691298,
    "SegmentName": "Segment1",
    "SegmentDescription": null,
    "ObjectVersionNumber": 2,
    "CreatedBy": "REPL_USER",
    "CreationDate": "2024-07-31T04:59:33+00:00",
    "LastUpdateDate": "2024-07-31T05:09:45+00:00",
    "LastUpdateLogin": "1D693F29DDC3A611E0633837060A48DB",
    "LastUpdatedBy": "REPL_USER",
    "ParLevelOverride": null,
    "ParMaximumQuantityOverride": null,
    "ParTimePeriod": null,
    "DeliveriesPERTimePeriod": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298",
            "name": "PolicySegmentParameters",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298",
            "name": "PolicySegmentParameters",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011",
            "name": "replenishmentPolicyAssignmentSetsV2",
            "kind": "item"
        }
    ]
}

Example 2

This example describes how to update parameters for all segments.

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/PolicySetId/child/PolicySegmentParameters/"

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
"parts": [{

"id": "1",

"path": "/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298",

"operation": "update",

"payload": 

{
    "PolicyTypeCode": 11,
    "PolicyUOMCode": 12,
    "SafetyStockCalculationMethodCode": 1,
    "SafetyStockDaysofCover": 3,
    "TargetServiceLevelPercentage": null,
    "HorizonforAverageDailyDemand": 15,
    "DaysOfCoverBasisCode": 2,
    "ExtrapolationPercentage": null,
    "FixedOrderCycleCalendarCode": null,
    "MaximumQuantityCalculationMethodCode": 1,
    "MaximumQuantityDaysofCover": null,
    "DefaultDailyDemand": 300,
    "DefaultOrderQuantity": null,
    "DefaultEOQ": null,
    "DefaultCarryingCostPercentage": 60,
    "DefaultOrderingCost": 120,
    "DefaultStandardCost": 150,
    "SafetyStockOverride": 60,
    "MinimumOverride": null,
    "MaximumOverride": null,
    "ROPOverride": 100,
    "OrderQuantityOverride": null,
    "EOQOverride": 250,
    "ParLevelOverride": null,
    "ParMaximumQuantityOverride": null,
    "ParTimePeriod": null,
    "DeliveriesPERTimePeriod": null,
    "SegmentName": "Segment1"

    
}},{
    
   
"id": "2",

"path": "/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691305",

"operation": "update",

"payload": {
    "PolicyTypeCode": 10,
    "PolicyUOMCode": 13,
    "SafetyStockCalculationMethodCode": 1,
    "SafetyStockDaysofCover": 3,
    "TargetServiceLevelPercentage": null,
    "HorizonforAverageDailyDemand": 20,
    "DaysOfCoverBasisCode": 1,
    "ExtrapolationPercentage": null,
    "MaximumQuantityCalculationMethodCode": 1,
    "MaximumQuantityDaysofCover": null,
    "FixedOrderCycleCalendarCode": null,
"DefaultDailyDemand": 250,
    "DefaultOrderQuantity": 150,
    "DefaultEOQ": null,
    "DefaultCarryingCostPercentage": null,
    "DefaultOrderingCost": null,
    "DefaultStandardCost": null,
    "SafetyStockOverride": 100,
    "MinimumOverride": null,
    "MaximumOverride": null,
    "ROPOverride": 200,
    "OrderQuantityOverride": 80,
    "EOQOverride": null,
    "ParLevelOverride": null,
    "ParMaximumQuantityOverride": null,
    "ParTimePeriod": null,
    "DeliveriesPERTimePeriod": null,
    "SegmentName": "Segment2"

}}]}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "parts": [
        {
            "id": "1",
            "path": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298",
            "operation": "update",
            "payload": {
                "PolicyTypeCode": 11,
                "PolicyType": "ROP and EOQ",
                "PolicyUOMCode": 12,
                "PolicyUOM": "Units",
                "SafetyStockCalculationMethodCode": 1,
                "SafetyStockCalculationMethod": "Days of cover",
                "SafetyStockDaysofCover": 3,
                "TargetServiceLevelPercentage": null,
                "HorizonforAverageDailyDemand": 15,
                "DaysOfCoverBasisCode": 2,
                "DaysOfCoverBasis": "Forecast",
                "ExtrapolationPercentage": null,
                "MaximumQuantityCalculationMethodCode": null,
                "MaximumQuantityCalculationMethod": null,
                "MaximumQuantityDaysofCover": null,
                "FixedOrderCycleCalendarCode": null,
                "FixedOrderCycleCalendar": null,
                "DefaultDailyDemand": 300,
                "DefaultOrderQuantity": null,
                "DefaultEOQ": null,
                "DefaultCarryingCostPercentage": 60,
                "DefaultOrderingCost": 120,
                "DefaultStandardCost": 150,
                "SafetyStockOverride": 60,
                "MinimumOverride": null,
                "MaximumOverride": null,
                "ROPOverride": 100,
                "OrderQuantityOverride": null,
                "EOQOverride": 250,
                "SegmentId": 300100206691298,
                "SegmentName": "Segment1",
                "SegmentDescription": null,
                "ObjectVersionNumber": 3,
                "CreatedBy": "REPL_USER",
                "CreationDate": "2024-07-31T04:59:33+00:00",
                "LastUpdateDate": "2024-07-31T05:12:31+00:00",
                "LastUpdateLogin": "1D67D8BAE02411F7E0635A77060ABCF1",
                "LastUpdatedBy": "REPL_USER",
                "ParLevelOverride": null,
                "ParMaximumQuantityOverride": null,
                "ParTimePeriod": null,
                "DeliveriesPERTimePeriod": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298",
                        "name": "PolicySegmentParameters",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691298",
                        "name": "PolicySegmentParameters",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011",
                        "name": "replenishmentPolicyAssignmentSetsV2",
                        "kind": "item"
                    }
                ]
            }
        },
        {
            "id": "2",
            "path": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691305",
            "operation": "update",
            "payload": {
                "PolicyTypeCode": 10,
                "PolicyType": "ROP and order quantity",
                "PolicyUOMCode": 13,
                "PolicyUOM": "Days",
                "SafetyStockCalculationMethodCode": 1,
                "SafetyStockCalculationMethod": "Days of cover",
                "SafetyStockDaysofCover": 3,
                "TargetServiceLevelPercentage": null,
                "HorizonforAverageDailyDemand": 20,
                "DaysOfCoverBasisCode": 1,
                "DaysOfCoverBasis": "History",
                "ExtrapolationPercentage": null,
                "MaximumQuantityCalculationMethodCode": null,
                "MaximumQuantityCalculationMethod": null,
                "MaximumQuantityDaysofCover": null,
                "FixedOrderCycleCalendarCode": null,
                "FixedOrderCycleCalendar": null,
                "DefaultDailyDemand": 250,
                "DefaultOrderQuantity": 150,
                "DefaultEOQ": null,
                "DefaultCarryingCostPercentage": null,
                "DefaultOrderingCost": null,
                "DefaultStandardCost": null,
                "SafetyStockOverride": 100,
                "MinimumOverride": null,
                "MaximumOverride": null,
                "ROPOverride": 200,
                "OrderQuantityOverride": 80,
                "EOQOverride": null,
                "SegmentId": 300100206691305,
                "SegmentName": "Segment2",
                "SegmentDescription": null,
                "ObjectVersionNumber": 2,
                "CreatedBy": "REPL_USER",
                "CreationDate": "2024-07-31T04:59:33.079+00:00",
                "LastUpdateDate": "2024-07-31T05:12:31.007+00:00",
                "LastUpdateLogin": "1D67D8BAE02411F7E0635A77060ABCF1",
                "LastUpdatedBy": "REPL_USER",
                "ParLevelOverride": null,
                "ParMaximumQuantityOverride": null,
                "ParTimePeriod": null,
                "DeliveriesPERTimePeriod": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691305",
                        "name": "PolicySegmentParameters",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011/child/PolicySegmentParameters/300100206691305",
                        "name": "PolicySegmentParameters",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSetsV2/300100620713011",
                        "name": "replenishmentPolicyAssignmentSetsV2",
                        "kind": "item"
                    }
                ]
            }
        }
    ]
}

Back to Top