Create numbers
post
/fscmRestApi/resources/11.13.18.05/inventoryItemSerialNumbers
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory Attributes
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. -
InventoryItemId(required): integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemNumber(required): string
Maximum Length:
300
Name of the inventory item. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
OrganizationId(required): integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName(required): string
Maximum Length:
240
Name of the organization. -
serialAttributeDFF: array
Flexfields for Serial Number Attributes
Title:
Flexfields for Serial Number Attributes
The Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes. -
SerialNumber(required): string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item. -
serialStandardDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers. -
StatusCode: string
Title:
Material Status
Maximum Length:80
Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material Status
Value that uniquely identifies the material status. -
Supplier: string
Name of the supplier.
-
SupplierLot: string
Title:
Supplier Lot
Maximum Length:30
Number that identifies the supplier lot. -
SupplierSerialNumber: string
Title:
Supplier Serial Number
Maximum Length:80
Serial number assigned to the item by its supplier. -
UniqueDeviceIdentifier: string
Maximum Length:
150
Value that uniquely identifies the device.
Nested Schema : Flexfields for Inventory Attributes
Type:
array
Title:
Flexfields for Inventory Attributes
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.
Show Source
Nested Schema : Flexfields for Serial Number Attributes
Type:
array
Title:
Flexfields for Serial Number Attributes
The Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers.
Show Source
Nested Schema : inventoryItemSerialNumbers-inventoryAttributesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name 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.
-
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Name of the inventory project. This attribute is associated with a feature that requires opt in. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Name of the inventory task. This attribute is associated with a feature that requires opt in.
Nested Schema : inventoryItemSerialNumbers-serialAttributeDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial number attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item.
Nested Schema : inventoryItemSerialNumbers-serialStandardDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial numbers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item.
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:
true
Value 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. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory Attributes
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. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the inventory item. -
ItemNumber: string
Maximum Length:
300
Name of the inventory item. -
ItemPrimaryImageURL: string
Title:
Primary Image URL
Read Only:true
Maximum Length:4000
URL for the primary image of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Read Only:
true
Name of the locator. -
LocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the locator. -
LotNumber: string
Title:
Lot
Read Only:true
Maximum Length:80
Number that identifies the lot. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName: string
Maximum Length:
240
Name of the organization. -
ReceiptDate: string
(date-time)
Title:
Receipt Date
Read Only:true
Date when the warehouse completed or received the item. -
Reserved: string
Read Only:
true
Value 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:
true
Maximum Length:18
Revision of the item. -
serialAttributeDFF: array
Flexfields for Serial Number Attributes
Title:
Flexfields for Serial Number Attributes
The Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item. -
serialStandardDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers. -
ShippedDate: string
(date-time)
Title:
Shipped Date
Read Only:true
Date when the warehouse shipped the item. -
StatusCode: string
Title:
Material Status
Maximum Length:80
Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material Status
Value that uniquely identifies the material status. -
SubinventoryCode: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the subinventory. -
Supplier: string
Name of the supplier.
-
SupplierLot: string
Title:
Supplier Lot
Maximum Length:30
Number that identifies the supplier lot. -
SupplierSerialNumber: string
Title:
Supplier Serial Number
Maximum Length:80
Serial number assigned to the item by its supplier. -
UniqueDeviceIdentifier: string
Maximum Length:
150
Value that uniquely identifies the device. -
Usage: string
Read Only:
true
Value 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:
Usage
Read Only:true
Maximum Length:30
Default Value:1
Abbreviation 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:
array
Title:
Flexfields for Inventory Attributes
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.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Number Attributes
Type:
array
Title:
Flexfields for Serial Number Attributes
The Flexfields for Serial Number Attributes resource manages the descriptive flexfield information for serial number attributes.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The 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 Segment
Maximum Length:40
Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name 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:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Name of the inventory project. This attribute is associated with a feature that requires opt in. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Name of the inventory task. This attribute is associated with a feature that requires opt in.
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.
Nested Schema : inventoryItemSerialNumbers-serialAttributeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial number attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryItemSerialNumbers-serialStandardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial numbers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number that identifies the inventory item.
Nested Schema : Links
Type:
array
Title:
Links
The 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 create numbers.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers"
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.
{ "OrganizationId":207, "InventoryItemId":663915, "SerialNumber":"SS20181206_1" }
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": null, "StatusCode": null, "UsageCode": "1", "Usage": "Defined but not used", "ShippedDate": null, "ReceiptDate": null, "Allocated": "No", "Reserved": "No", "Supplier": null, "SupplierLot": null, "SupplierSerialNumber": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F31", "name": "inventoryItemSerialNumbers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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" } ], }