Update one number
patch
/fscmRestApi/resources/11.13.18.05/inventoryItemSerialNumbers/{inventoryItemSerialNumbersUniqID}
Request
Path Parameters
-
inventoryItemSerialNumbersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrganizationId, InventoryItemId and SerialNumber ---for the Inventory Item Serial Numbers resource and used to uniquely identify an instance of Inventory Item Serial Numbers. The client should not generate the hash key value. Instead, the client should query on the Inventory Item Serial Numbers collection resource with a filter on the primary key values in order to navigate to a specific instance of Inventory Item Serial Numbers.
For example: inventoryItemSerialNumbers?q=OrganizationId=<value1>;InventoryItemId=<value2>;SerialNumber=<value3>
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-
ElectronicRecordApprovalStatus: string
Maximum Length:
80Value that indicates the approval status of the electronic record for the serial number. Valid values are NULL, PENDING APPROVAL, APPROVED, and REJECTED. The default value is NULL. -
ElectronicRecordId: integer
(int64)
Value that uniquely identifies the electronic record.
-
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages the descriptive flexfield information for inventory attributes associated with the serial numbers. This resource is associated with a feature that requires opt in. -
OriginalUnitVendorId: integer
(int64)
Title:
SupplierValue that uniquely identifies the supplier of the original unit. -
serialAttributeDFF: array
Flexfields for Serial Number Attributes
Title:
Flexfields for Serial Number AttributesThe Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes. -
serialStandardDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial NumbersThe Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers. -
StatusCode: string
Title:
Material StatusMaximum Length:80Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material StatusValue that uniquely identifies the material status. -
Supplier: string
Name of the supplier.
-
SupplierLot: string
Title:
Supplier LotMaximum Length:30Number that identifies the supplier lot. -
SupplierSerialNumber: string
Title:
Supplier Serial NumberMaximum Length:80Serial number assigned to the item by its supplier. -
UniqueDeviceIdentifier: string
Maximum Length:
150Value that uniquely identifies the device. -
UpdateSourceCode: string
Value that integrating systems can populate to identify the source of the update serial number request.
Nested Schema : Flexfields for Inventory Attributes
Type:
arrayTitle:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages the descriptive flexfield information for inventory attributes associated with the serial numbers. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Flexfields for Serial Number Attributes
Type:
arrayTitle:
Flexfields for Serial Number AttributesThe Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
arrayTitle:
Flexfields for Serial NumbersThe Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers.
Show Source
Nested Schema : inventoryItemSerialNumbers-inventoryAttributesDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectName of the inventory project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskName of the inventory task. This attribute is associated with a feature that requires opt in.
Nested Schema : inventoryItemSerialNumbers-serialAttributeDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial number attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value
Nested Schema : inventoryItemSerialNumbers-serialStandardDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial numbers. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value
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 : inventoryItemSerialNumbers-item-response
Type:
Show Source
object-
Allocated: string
Read Only:
trueValue that indicates whether or not the serial number is allocated. Contains one of the following values: Yes or No. if Yes, then the serial number is allocated. If No, then the serial number is not allocated. The default value is No. -
AllocatedFlag: boolean
Read Only:
trueMaximum Length:255Value that indicates whether the serial number is allocated. -
ElectronicRecordApprovalStatus: string
Maximum Length:
80Value that indicates the approval status of the electronic record for the serial number. Valid values are NULL, PENDING APPROVAL, APPROVED, and REJECTED. The default value is NULL. -
ElectronicRecordId: integer
(int64)
Value that uniquely identifies the electronic record.
-
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages the descriptive flexfield information for inventory attributes associated with the serial numbers. This resource is associated with a feature that requires opt in. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the inventory item. -
ItemNumber: string
Maximum Length:
300Name of the inventory item. -
ItemPrimaryImageURL: string
Title:
Primary Image URLRead Only:trueMaximum Length:4000URL for the primary image of the inventory item. -
LicensePlateNumber: string
Title:
Packing UnitRead Only:trueMaximum Length:30Name of the license plate number. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Read Only:
trueName of the locator. -
LocatorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the locator. -
LotNumber: string
Title:
LotRead Only:trueMaximum Length:80Number that identifies the lot. -
LPNId: integer
(int64)
Read Only:
trueValue that uniquely identifies the license plate number. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName: string
Maximum Length:
240Name of the organization. -
OriginalUnitVendorId: integer
(int64)
Title:
SupplierValue that uniquely identifies the supplier of the original unit. -
OwningEntityId: integer
(int64)
Read Only:
trueValue that uniquely identifies the owning entity's ID. -
OwningEntityType: integer
Read Only:
trueValue that indicates the ownership of inventory material. -
ReceiptDate: string
(date-time)
Title:
Receipt DateRead Only:trueDate when the warehouse completed or received the item. -
ReservationId: integer
(int64)
Read Only:
trueUnique identifier of the reservation record to which the serial number is assigned. -
Reserved: string
Read Only:
trueValue that indicates whether or not the serial number is reserved. Contains one of the following values: Yes or No. If Yes, then the serial number is reserved. If No, then the serial number is not reserved. The default value is No. -
Revision: string
Read Only:
trueMaximum Length:18Revision of the item. -
serialAttributeDFF: array
Flexfields for Serial Number Attributes
Title:
Flexfields for Serial Number AttributesThe Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number that identifies the inventory item. -
serialStandardDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial NumbersThe Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers. -
ShippedDate: string
(date-time)
Title:
Shipped DateRead Only:trueDate when the warehouse shipped the item. -
StatusCode: string
Title:
Material StatusMaximum Length:80Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material StatusValue that uniquely identifies the material status. -
SubinventoryCode: string
Read Only:
trueMaximum Length:10Abbreviation that identifies the subinventory. -
Supplier: string
Name of the supplier.
-
SupplierLot: string
Title:
Supplier LotMaximum Length:30Number that identifies the supplier lot. -
SupplierSerialNumber: string
Title:
Supplier Serial NumberMaximum Length:80Serial number assigned to the item by its supplier. -
UniqueDeviceIdentifier: string
Maximum Length:
150Value that uniquely identifies the device. -
UpdateSourceCode: string
Value that integrating systems can populate to identify the source of the update serial number request.
-
Usage: string
Read Only:
trueValue that identifies the current usage of the serial number. A list of accepted values is defined in the lookup type INV_SERIAL_NUM_STATUS. The default value is Defined but not used. -
UsageCode: string
Title:
UsageRead Only:trueMaximum Length:30Default Value:1Abbreviation that identifies the current usage of the serial number. A list of accepted values is defined in the lookup type INV_SERIAL_NUM_STATUS. The default value is 1.
Nested Schema : Flexfields for Inventory Attributes
Type:
arrayTitle:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages the descriptive flexfield information for inventory attributes associated with the serial numbers. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Number Attributes
Type:
arrayTitle:
Flexfields for Serial Number AttributesThe Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
arrayTitle:
Flexfields for Serial NumbersThe Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers.
Show Source
Nested Schema : inventoryItemSerialNumbers-inventoryAttributesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization. This attribute is associated with a feature that requires opt in.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item. This attribute is associated with a feature that requires opt in.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectName of the inventory project. This attribute is associated with a feature that requires opt in. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number that identifies the inventory item. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskName of the inventory task. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
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 : inventoryItemSerialNumbers-serialAttributeDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial number attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number that identifies the inventory item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryItemSerialNumbers-serialStandardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial numbers. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number that identifies the inventory item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- inventoryAttributesDFF
-
Parameters:
- inventoryItemSerialNumbersUniqID:
$request.path.inventoryItemSerialNumbersUniqID
The Flexfields for Inventory Attributes resource manages the descriptive flexfield information for inventory attributes associated with the serial numbers. This resource is associated with a feature that requires opt in. - inventoryItemSerialNumbersUniqID:
- serialAttributeDFF
-
Parameters:
- inventoryItemSerialNumbersUniqID:
$request.path.inventoryItemSerialNumbersUniqID
The Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes. - inventoryItemSerialNumbersUniqID:
- serialStandardDFF
-
Parameters:
- inventoryItemSerialNumbersUniqID:
$request.path.inventoryItemSerialNumbersUniqID
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers. - inventoryItemSerialNumbersUniqID:
Examples
This example describes how to update one number.
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/inventoryItemSerialNumbers/inventoryItemSerialNumbersUniqID"
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.
{
"SupplierSerialNumber":"SSN1234"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"OrganizationId": 207,
"OrganizationCode": "M1",
"OrganizationName": "Tall Manufacturing",
"InventoryItemId": 663915,
"ItemNumber": "INV-102",
"ItemDescription": "Serial @ Receipt Item",
"SerialNumber": "SS20181206_1",
"SubinventoryCode": null,
"LocatorId": null,
"Locator": null,
"LotNumber": null,
"Revision": null,
"StatusId": 1,
"StatusCode": "Active",
"UsageCode": "1",
"Usage": "Defined but not used",
"ShippedDate": null,
"ReceiptDate": null,
"Allocated": "No",
"Reserved": "No",
"Supplier": null,
"SupplierLot": null,
"SupplierSerialNumber": "SSN1234",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31",
"name": "inventoryItemSerialNumbers",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31",
"name": "inventoryItemSerialNumbers",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31/lov/SerialSupplierVA",
"name": "SerialSupplierVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31/lov/ItemVA",
"name": "ItemVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31/lov/AccessibleOrganizationVA",
"name": "AccessibleOrganizationVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31/child/serialAttributeDFF",
"name": "serialAttributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31/child/serialStandardDFF",
"name": "serialStandardDFF",
"kind": "collection"
}
],
}