Update one reacall hold transaction
patch
/fscmRestApi/resources/11.13.18.05/recallItemHolds/{TransactionId}
Request
Path Parameters
-
TransactionId(required): integer(int64)
Value that uniquely identifies the hold transaction.
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
Root Schema : schema
Type:
Show Source
object
-
HoldQuantity: number
Held quantity of the item.
-
HoldUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the hold. -
HoldUOMName: string
Maximum Length:
255
Name of the unit of measure for the hold in primary quantity. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Maximum Length:
240
Description of the inventory item. -
ItemNumber: string
Maximum Length:
255
Number that indicates the inventory item. -
Locator: string
Maximum Length:
255
Name of the locator. -
LocatorId: integer
(int64)
Value that uniquely identifies the stock locator.
-
LotNumber: string
Maximum Length:
80
Number that identifies an item or group of items. -
ManufacturerName: string
Maximum Length:
255
Name of the business partner. -
ManufacturingPartNumber: string
Maximum Length:
255
Manufacturer part number. -
MovementRequestHeaderId: integer
(int64)
Value that uniquely identifies the movement request header.
-
MovementRequestLineId: integer
(int64)
Value that uniquely identifies the movement request line.
-
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization of the transaction.
-
OrganizationName: string
Maximum Length:
255
Name of the inventory organization. -
RecallNoticeNumber: string
Maximum Length:
240
Number that identifies the recall notice. This number is generated per the document sequencing setup and is used for tracking by the enterprise. -
RecallReason: string
Maximum Length:
255
Text that provides details about the recall reasons. -
ReleaseHoldQuantity: number
Hold quantity to be released.
-
ReleaseHoldUOM: string
Maximum Length:
80
Abbreviation that identifies the unit of measure for the hold quantity to be released. -
ReleaseHoldUOMName: string
Maximum Length:
255
Name of the unit of measure for the hold quantity to be released. -
Revision: string
Maximum Length:
18
Revision of the inventory item. -
SecondaryHoldQuantity: number
Hold quantity of an item in its secondary unit of measure.
-
SecondaryHoldUOM: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure that doesn't have a fixed conversion from the primary unit of measure. Used in dual unit-of-measure recordkeeping that industries use to maintain and use inventory in both quantity and weight units of measure, or volume and length units of measure. -
SecondaryHoldUOMName: string
Maximum Length:
255
Name of the unit of measure for the hold in secondary quantity. -
SerialNumber: string
Maximum Length:
80
Number that indicates the serial to count. -
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory. -
TransactionId: integer
(int64)
Value that uniquely identifies the hold transaction.
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 : recallItemHolds-item-response
Type:
Show Source
object
-
HoldQuantity: number
Held quantity of the item.
-
HoldUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the hold. -
HoldUOMName: string
Maximum Length:
255
Name of the unit of measure for the hold in primary quantity. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Maximum Length:
240
Description of the inventory item. -
ItemNumber: string
Maximum Length:
255
Number that indicates the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
255
Name of the locator. -
LocatorId: integer
(int64)
Value that uniquely identifies the stock locator.
-
LotNumber: string
Maximum Length:
80
Number that identifies an item or group of items. -
ManufacturerName: string
Maximum Length:
255
Name of the business partner. -
ManufacturingPartNumber: string
Maximum Length:
255
Manufacturer part number. -
MovementRequestHeaderId: integer
(int64)
Value that uniquely identifies the movement request header.
-
MovementRequestLineId: integer
(int64)
Value that uniquely identifies the movement request line.
-
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization of the transaction.
-
OrganizationName: string
Maximum Length:
255
Name of the inventory organization. -
RecallNoticeNumber: string
Maximum Length:
240
Number that identifies the recall notice. This number is generated per the document sequencing setup and is used for tracking by the enterprise. -
RecallReason: string
Maximum Length:
255
Text that provides details about the recall reasons. -
ReleaseHoldQuantity: number
Hold quantity to be released.
-
ReleaseHoldUOM: string
Maximum Length:
80
Abbreviation that identifies the unit of measure for the hold quantity to be released. -
ReleaseHoldUOMName: string
Maximum Length:
255
Name of the unit of measure for the hold quantity to be released. -
Revision: string
Maximum Length:
18
Revision of the inventory item. -
SecondaryHoldQuantity: number
Hold quantity of an item in its secondary unit of measure.
-
SecondaryHoldUOM: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure that doesn't have a fixed conversion from the primary unit of measure. Used in dual unit-of-measure recordkeeping that industries use to maintain and use inventory in both quantity and weight units of measure, or volume and length units of measure. -
SecondaryHoldUOMName: string
Maximum Length:
255
Name of the unit of measure for the hold in secondary quantity. -
SerialNumber: string
Maximum Length:
80
Number that indicates the serial to count. -
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory. -
TransactionId: integer
(int64)
Value that uniquely identifies the hold transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update onespecific record for a hold created for a recall.
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/recallItemHolds/TransactionId"
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/recallItemHolds/22878850"
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.
{ "ReleaseHoldUOM" : "Ea", "ReleaseHoldQuantity" : 1 }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "InventoryItemId" : 300100580917606, "TransactionId" : 22878850, "OrganizationId" : 300100200296143, "SubinventoryCode" : "Staging", "LocatorId" : null, "LotNumber" : null, "SerialNumber" : null, "Revision" : null, "HoldQuantity" : 3, "HoldUOMCode" : "Ea", "SecondaryHoldUOM" : null, "SecondaryHoldQuantity" : null, "ItemDescription" : "plain item.", "MovementRequestHeaderId" : 5583024, "MovementRequestLineId" : 4281095, "RecallNoticeNumber" : "RND1005", "ManufacturerName" : "Aviator Inc", "OrganizationCode" : "HC01", "OrganizationName" : "Vision General Hospital", "ItemNumber" : "RT_1", "ManufacturingPartNumber" : "AI001", "Locator" : null, "RecallReason" : "Defect in manufacturing.", "HoldUOMName" : "Each", "SecondaryHoldUOMName" : null, "ReleaseHoldUOMName" : null, "ReleaseHoldQuantity" : 1, "ReleaseHoldUOM" : "Ea", "links" : [ { "rel" : "self", "href" : "http://servername/fscmRestApi/resources/version/recallItemHolds/22878850", "name" : "recallItemHolds", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel" : "canonical", "href" : "http://servername/fscmRestApi/resources/version/recallItemHolds/22878850", "name" : "recallItemHolds", "kind" : "item" } ] }