Update one line
patch
/fscmRestApi/resources/11.13.18.05/inventoryReplenishRequests/{GroupId}/child/replenishRequestLines/{ReplenishmentIntId}
Request
Path Parameters
-
GroupId(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=
-
ReplenishmentIntId(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: string
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: string
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
Root Schema : schema
Type:
Show Source
object-
FlowSource: string
Maximum Length:
1Indicates the source of the flow from which the replenish request is submitted. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemNumber: string
Title:
ItemMaximum Length:300Number that uniquely identifies the item. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Title:
LocatorMaximum Length:255Name of the locator. -
lots: array
Replenish Inventory Request Error Lot Details
Title:
Replenish Inventory Request Error Lot DetailsLot details associated with the Replenish Inventory Request, applicable when the item is lot-controlled. -
OfflineMode: string
Maximum Length:
1A value that indicates whether the replenish request line is enabled for offline counting. -
OrganizationCode: string
Title:
Organization CodeMaximum Length:18Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OverrideReplenishCountType: string
Type of override replenish count for the request.
-
OverrideReplenishCountTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of override replenish count for the request. -
OwningOrganizationCode: string
Maximum Length:
18Value that uniquely identifies the owning organization code. -
OwningOrganizationId: integer
(int64)
Value that uniquely identifies the owning organization.
-
OwningType: string
Maximum Length:
30Value that uniquely identifies the owning entity. For consigned items, this attribute contains the supplier site identifier. For owned items, it contains the owning organization identifier. -
OwningTypeId: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the item is consigned. If 2, then the item is owned. The default value is 2.
-
Quantity: number
Title:
QuantityQuantity of the replenishment in the request. -
replenishRequestLineDFFs: array
replenishRequestLineDFFs
-
serials: array
Replenish Inventory Request Error Serial Details
Title:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled. -
Subinventory: string
Title:
SubinventoryMaximum Length:10Subinventory to use when sourcing the request. -
SubinventoryGroup: string
Title:
Subinventory GroupMaximum Length:100Name of the subinventory group. -
TaskDuration: integer
(int32)
Indicates the actual duration for completing the task associated with the replenish request.
-
TaskEndTime: string
(date-time)
Indicates the timestamp when the task line associated with the replenish request was ended.
-
TaskStartTime: string
(date-time)
Indicates the timestamp when the task line associated with the replenish request was started.
-
UnitOfMeasure: string
Maximum Length:
25Unit of measure for this item and request. -
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure for this item and request.
Nested Schema : Replenish Inventory Request Error Lot Details
Type:
arrayTitle:
Replenish Inventory Request Error Lot DetailsLot details associated with the Replenish Inventory Request, applicable when the item is lot-controlled.
Show Source
Nested Schema : Replenish Inventory Request Error Serial Details
Type:
arrayTitle:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled.
Show Source
Nested Schema : schema
Type:
Show Source
object-
LotNumber: string
Maximum Length:
80Value that uniquely identifies the lot for a replenishment record. -
lotSerials: array
Replenish Inventory Request Error Serial Details
Title:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled. -
PrimaryQuantity: number
Quantity in the lot of the replenishment in the request in the primary unit of measure that the item uses.
-
PrimaryUnitOfMeasure: string
Maximum Length:
25Primary unit of measure for current lot. -
PrimaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the primary unit of measure.
Nested Schema : Replenish Inventory Request Error Serial Details
Type:
arrayTitle:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled.
Show Source
Nested Schema : schema
Type:
Show Source
object-
SerialNumber: string
Maximum Length:
255Serial number to count.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
ReplenishmentIntId: integer
(int64)
Nested Schema : inventoryReplenishRequests-replenishRequestLines-serials-item-patch-request
Type:
Show Source
object-
SerialNumber: string
Maximum Length:
255Serial number to count.
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.
Root Schema : inventoryReplenishRequests-replenishRequestLines-item-response
Type:
Show Source
object-
ErrorMessageCode: string
Title:
ErrorRead Only:trueMaximum Length:50Abbreviation that identifies the error that occurred when processing the request. -
ErrorMessageText: string
Title:
ErrorRead Only:trueMaximum Length:240Text of the error message that occurred when processing the request. -
FlowSource: string
Maximum Length:
1Indicates the source of the flow from which the replenish request is submitted. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemNumber: string
Title:
ItemMaximum Length:300Number that uniquely identifies the item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Title:
LocatorMaximum Length:255Name of the locator. -
lots: array
Replenish Inventory Request Error Lot Details
Title:
Replenish Inventory Request Error Lot DetailsLot details associated with the Replenish Inventory Request, applicable when the item is lot-controlled. -
NotPlannedRecords: number
Read Only:
trueValue that specifies the number of records that aren't planned in a replenishment request. -
OfflineMode: string
Maximum Length:
1A value that indicates whether the replenish request line is enabled for offline counting. -
OrganizationCode: string
Title:
Organization CodeMaximum Length:18Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OverrideReplenishCountType: string
Type of override replenish count for the request.
-
OverrideReplenishCountTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of override replenish count for the request. -
OwningOrganizationCode: string
Maximum Length:
18Value that uniquely identifies the owning organization code. -
OwningOrganizationId: integer
(int64)
Value that uniquely identifies the owning organization.
-
OwningType: string
Maximum Length:
30Value that uniquely identifies the owning entity. For consigned items, this attribute contains the supplier site identifier. For owned items, it contains the owning organization identifier. -
OwningTypeId: integer
(int32)
Contains one of the following values: 1 or 2. If 1, then the item is consigned. If 2, then the item is owned. The default value is 2.
-
ParentReplenishRequestId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent replenishment record. -
ParUOMQuantity: number
Read Only:
trueReplenish quantity of an item in the PAR Unit of Measure. -
ProcessingStatus: string
Title:
Processing StatusRead Only:trueMaximum Length:18Default Value:PENDINGProcessing status of this request. -
Quantity: number
Title:
QuantityQuantity of the replenishment in the request. -
ReplenishmentIntId: integer
(int64)
Read Only:
trueValue that uniquely identifies replenishment record. -
replenishRequestLineDFFs: array
replenishRequestLineDFFs
-
serials: array
Replenish Inventory Request Error Serial Details
Title:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled. -
Subinventory: string
Title:
SubinventoryMaximum Length:10Subinventory to use when sourcing the request. -
SubinventoryGroup: string
Title:
Subinventory GroupMaximum Length:100Name of the subinventory group. -
TaskDuration: integer
(int32)
Indicates the actual duration for completing the task associated with the replenish request.
-
TaskEndTime: string
(date-time)
Indicates the timestamp when the task line associated with the replenish request was ended.
-
TaskStartTime: string
(date-time)
Indicates the timestamp when the task line associated with the replenish request was started.
-
UnitOfMeasure: string
Maximum Length:
25Unit of measure for this item and request. -
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure for this item and request.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Replenish Inventory Request Error Lot Details
Type:
arrayTitle:
Replenish Inventory Request Error Lot DetailsLot details associated with the Replenish Inventory Request, applicable when the item is lot-controlled.
Show Source
Nested Schema : Replenish Inventory Request Error Serial Details
Type:
arrayTitle:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : inventoryReplenishRequests-replenishRequestLines-lots-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80Value that uniquely identifies the lot for a replenishment record. -
LotReplenishRequestId: integer
(int64)
Read Only:
trueLot number for the item. -
lotSerials: array
Replenish Inventory Request Error Serial Details
Title:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled. -
PrimaryQuantity: number
Quantity in the lot of the replenishment in the request in the primary unit of measure that the item uses.
-
PrimaryUnitOfMeasure: string
Maximum Length:
25Primary unit of measure for current lot. -
PrimaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the primary unit of measure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Replenish Inventory Request Error Serial Details
Type:
arrayTitle:
Replenish Inventory Request Error Serial DetailsSerial details for the Replenish Inventory Request when the item is serial-controlled.
Show Source
Nested Schema : inventoryReplenishRequests-replenishRequestLines-lots-lotSerials-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotReplenishRequestId: integer
(int64)
Value that uniquely identifies the lot for a replenishment record.
-
SerialNumber: string
Maximum Length:
255Serial number to count. -
SerialReplenishRequestId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial in a lot for a replenishment record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReplenishmentIntId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryReplenishRequests-replenishRequestLines-serials-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Maximum Length:
255Serial number to count. -
SerialReplenishRequestId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial for a replenishment record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- lots
-
Parameters:
- GroupId:
$request.path.GroupId - ReplenishmentIntId:
$request.path.ReplenishmentIntId
Lot details associated with the Replenish Inventory Request, applicable when the item is lot-controlled. - GroupId:
- replenishRequestLineDFFs
-
Parameters:
- GroupId:
$request.path.GroupId - ReplenishmentIntId:
$request.path.ReplenishmentIntId
- GroupId:
- serials
-
Parameters:
- GroupId:
$request.path.GroupId - ReplenishmentIntId:
$request.path.ReplenishmentIntId
Serial details for the Replenish Inventory Request when the item is serial-controlled. - GroupId:
Examples
This example describes how to update one line.
Example cURL Command
Use the following cURL command to submit a request on the REST resource to update a specific attribute in a replenish request line.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/GroupId/child/replenishRequestLines/ReplenishmentIntId"
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 creates.
{
"Subinventory": "P123"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"ErrorMessageCode" : null,
"ErrorMessageText" : null,
"InventoryItemId" : null,
"ItemNumber" : "INV-100",
"LocatorId" : null,
"LocatorName" : null,
"OrganizationCode" : "M1",
"OrganizationId" : 207,
"UnitOfMeasure" : null,
"UOMCode" : null,
"Quantity" : 100,
"ReplenishmentIntId" : 1005,
"Subinventory" : "P123",
"ProcessingStatus" : "PENDING",
"SubinventoryGroup" : null,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005/child/replenishRequestLines/1005",
"name" : "replenishRequestLines",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
}, {
"rel" : "canonical",
"href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005/child/replenishRequestLines/1005",
"name" : "replenishRequestLines",
"kind" : "item"
}, {
"rel" : "parent",
"href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005",
"name" : "inventoryReplenishRequests",
"kind" : "item"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1005/child/replenishRequestLines/1005/child/replenishRequestLineDFFs",
"name" : "replenishRequestLineDFFs",
"kind" : "collection"
} ]