Jump to

• Request
• Response
• Examples

PATCH action not supported

patch

/fscmRestApi/resources/11.13.18.05/replenishmentPolicyAssignmentSets/{PolicySetId}/child/ItemLocationLevelPolicyOverrides/{ItemLocationLevelPolicyOverridesUniqID}

Request

Path Parameters

• ItemLocationLevelPolicyOverridesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Location Level Policy Overrides resource and used to uniquely identify an instance of Item Location Level Policy Overrides. The client should not generate the hash key value. Instead, the client should query on the Item Location Level Policy Overrides collection resource in order to navigate to a specific instance of Item Location Level Policy Overrides to get the hash key.
• 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=

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

• EOQOverride: integer (int32)
  Manual override value defined for the economic order quantity.
• FixedOrderCycleCalendar: string
  Maximum Length: 240

  Calendar used for the fixed order cycle policy type.
• FixedOrderCycleCalendarCode: number
  Value that uniquely identifies the fixed order cycle calendar.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• Item: string
  Maximum Length: 300

  Name of the item.
• Location: string
  Maximum Length: 49

  Name of the location.
• LocationId: integer (int64)
  Value that uniquely identifies the location.
• MaximumOverride: integer (int32)
  Manual override value defined for the maximum quantity or maximum days depending on the policy unit of measure.
• 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.
• ParLevelOverride: integer (int32)
  Manual override value defined for the par level.
• ParMaximumQuantityOverride: integer (int32)
  Manual override value defined for the par maximum quantity.
• PolicySetId: integer (int64)
  Value that uniquely identifies the policy assignment set.
• PolicyType: string
  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
  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.
• SafetyStockOverride: integer (int32)
  Manual override value defined for the safety stock.

{
    "type":"object",
    "properties":{
        "ROPOverride":{
            "type":"integer",
            "description":"Manual override value defined for the reorder point quantity or reorder point days depending on the policy unit of measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "PolicyType":{
            "maxLength":4000,
            "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
        },
        "ParLevelOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par level.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "PolicySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SafetyStockOverride":{
            "type":"integer",
            "description":"Manual override value defined for the safety stock.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrderQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the order quantity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "FixedOrderCycleCalendarCode":{
            "type":"number",
            "description":"Value that uniquely identifies the fixed order cycle calendar.",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "FixedOrderCycleCalendar":{
            "maxLength":240,
            "type":"string",
            "description":"Calendar used for the fixed order cycle policy type.",
            "nullable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true
        },
        "EOQOverride":{
            "type":"integer",
            "description":"Manual override value defined for the economic order quantity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ParMaximumQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par maximum quantity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "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
            }
        },
        "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
        },
        "MaximumOverride":{
            "type":"integer",
            "description":"Manual override value defined for the maximum quantity or maximum days depending on the policy unit of measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "Location":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true
        },
        "PolicyUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Type of policy unit of measure. Valid values are Units and Days. The default value is Units.",
            "nullable":true
        },
        "MinimumOverride":{
            "type":"integer",
            "description":"Manual override value defined for the minimum quantity or minimum days depending on the policy unit of measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : replenishmentPolicyAssignmentSets-ItemLocationLevelPolicyOverrides-item-response

Type: object

Show Source

• 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 (int32)
  Manual override value defined for the economic order quantity.
• FixedOrderCycleCalendar: string
  Maximum Length: 240

  Calendar used for the fixed order cycle policy type.
• FixedOrderCycleCalendarCode: number
  Value that uniquely identifies the fixed order cycle calendar.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• Item: string
  Maximum Length: 300

  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: 49

  Name of the location.
• LocationId: integer (int64)
  Value that uniquely identifies the location.
• MaximumOverride: integer (int32)
  Manual override value defined for the maximum quantity or maximum days depending on the policy unit of measure.
• 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.
• ParLevelOverride: integer (int32)
  Manual override value defined for the par level.
• ParMaximumQuantityOverride: integer (int32)
  Manual override value defined for the par maximum quantity.
• PolicySetId: integer (int64)
  Value that uniquely identifies the policy assignment set.
• PolicyType: string
  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
  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.
• SafetyStockOverride: integer (int32)
  Manual override value defined for the safety stock.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the policy overrides.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParLevelOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par level.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item.",
            "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"
            }
        },
        "PolicyUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Type of policy unit of measure. Valid values are Units and Days. The default value is Units.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the policy overrides.",
            "nullable":false,
            "readOnly":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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PolicyType":{
            "maxLength":4000,
            "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,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the policy overrides.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PolicySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SafetyStockOverride":{
            "type":"integer",
            "description":"Manual override value defined for the safety stock.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the order quantity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FixedOrderCycleCalendarCode":{
            "type":"number",
            "description":"Value that uniquely identifies the fixed order cycle calendar.",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "FixedOrderCycleCalendar":{
            "maxLength":240,
            "type":"string",
            "description":"Calendar used for the fixed order cycle policy type.",
            "nullable":true,
            "x-queryable":true
        },
        "EOQOverride":{
            "type":"integer",
            "description":"Manual override value defined for the economic order quantity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ParMaximumQuantityOverride":{
            "type":"integer",
            "description":"Manual override value defined for the par maximum quantity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "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 the policy unit of measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the policy overrides.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the policy overrides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the location.",
            "nullable":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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "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 one item-location.

Example 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/replenishmentPolicyAssignmentSets/PolicySetId/child/ItemLocationLevelPolicyOverrides/ItemLocationLevelPolicyOverridesUniqID"

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/replenishmentPolicyAssignmentSets/300100580499376/child/ItemLocationLevelPolicyOverrides/00040000000EACED00057708000110F09C7F5FB00000000EACED0005770800000000000C83D10000000EACED0005770800000000000027110000000EACED00057708FFFFFFFFFFFFFFFF"

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

{
"ParLevelOverride": 100,
"ParMaximumQuantityOverride": 200
}

Example Response Body

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

{
    "PolicySetId": 300100580499376,
    "InventoryItemId": 820177,
    "Item": "YM-QLED-1080P-55",
    "LocationId": 10001,
    "Location": "M1",
    "PolicyTypeCode": 12,
    "PolicyType": "Periodic automatic replenishment",
    "PolicyUOMCode": 12,
    "PolicyUOM": "Units",
    "SafetyStockOverride": null,
    "MinimumOverride": null,
    "MaximumOverride": null,
    "ROPOverride": null,
    "OrderQuantityOverride": null,
    "EOQOverride": null,
    "FixedOrderCycleCalendarCode": null,
    "FixedOrderCycleCalendar": null,
    "ObjectVersionNumber": 2,
    "CreationDate": "2023-07-26T10:43:12+00:00",
    "CreatedBy": "REPL_USER",
    "LastUpdateDate": "2023-07-26T10:52:57+00:00",
    "LastUpdateLogin": "015F722ACD3F063CE063B06515AC6AC4",
    "LastUpdatedBy": "REPL_USER",
    "ParLevelOverride": 100,
    "ParMaximumQuantityOverride": 200,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100580499376/child/ItemLocationLevelPolicyOverrides/00040000000EACED00057708000110F09C7F5FB00000000EACED0005770800000000000C83D10000000EACED0005770800000000000027110000000EACED00057708FFFFFFFFFFFFFFFF",
            "name": "ItemLocationLevelPolicyOverrides",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100580499376/child/ItemLocationLevelPolicyOverrides/00040000000EACED00057708000110F09C7F5FB00000000EACED0005770800000000000C83D10000000EACED0005770800000000000027110000000EACED00057708FFFFFFFFFFFFFFFF",
            "name": "ItemLocationLevelPolicyOverrides",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100580499376",
            "name": "replenishmentPolicyAssignmentSets",
            "kind": "item"
        }
    ]
}

Back to Top