Update a serial
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/unpackedLines/{DeliveryDetailInterfaceId10}/child/serials/{serialsUniqID}
Request
-
DeliveryDetailInterfaceId10(required): string
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=
-
DeliveryInterfaceId(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=
-
TransactionId(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=
-
serialsUniqID(required): string
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=
-
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.
- application/json
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
Response
- application/json
Default Response
-
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.
object-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
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.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinks- attributeDFF
-
Parameters:
- DeliveryDetailInterfaceId10:
$request.path.DeliveryDetailInterfaceId10 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - TransactionId:
$request.path.TransactionId - serialsUniqID8:
$request.path.serialsUniqID8
- DeliveryDetailInterfaceId10:
- errors
-
Parameters:
- DeliveryDetailInterfaceId10:
$request.path.DeliveryDetailInterfaceId10 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - TransactionId:
$request.path.TransactionId - serialsUniqID8:
$request.path.serialsUniqID8
The Errors resource manages errors that occur when processing a transaction request. - DeliveryDetailInterfaceId10:
- standardDFF
-
Parameters:
- DeliveryDetailInterfaceId10:
$request.path.DeliveryDetailInterfaceId10 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - TransactionId:
$request.path.TransactionId - serialsUniqID8:
$request.path.serialsUniqID8
- DeliveryDetailInterfaceId10:
- wshSerialInvDFF
-
Parameters:
- DeliveryDetailInterfaceId10:
$request.path.DeliveryDetailInterfaceId10 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - TransactionId:
$request.path.TransactionId - serialsUniqID8:
$request.path.serialsUniqID8
- DeliveryDetailInterfaceId10:
Examples
This example describes how to update a serial.
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/shipmentTransactionRequests/TransactionId/child/shipments/DeliveryInterfaceId/child/unpackedLines/DeliveryDetailInterfaceId/child/serials/serialsUniqID"
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.
{
"ToSerialNumber": "YP-S032"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"TransactionInterfaceId": 300100169702072,
"FromSerialNumber": "YP-S030",
"ToSerialNumber": "YP-S032",
"Subinventory": "DSR-LOC-1",
"Locator": "DL1.1.1",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T20:26:26.418+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T20:28:41+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169702069/child/shipments/300100169702070/child/unpackedLines/300100169702071/child/serials/00020000000EACED00057708000110F084031AB80000000759502D53303330",
"name": "serials",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169702069/child/shipments/300100169702070/child/unpackedLines/300100169702071/child/serials/00020000000EACED00057708000110F084031AB80000000759502D53303330",
"name": "serials",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169702069/child/shipments/300100169702070/child/unpackedLines/300100169702071",
"name": "unpackedLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169702069/child/shipments/300100169702070/child/unpackedLines/300100169702071/child/serials/00020000000EACED00057708000110F084031AB80000000759502D53303330/child/attributeDFF",
"name": "attributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169702069/child/shipments/300100169702070/child/unpackedLines/300100169702071/child/serials/00020000000EACED00057708000110F084031AB80000000759502D53303330/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169702069/child/shipments/300100169702070/child/unpackedLines/300100169702071/child/serials/00020000000EACED00057708000110F084031AB80000000759502D53303330/child/standardDFF",
"name": "standardDFF",
"kind": "collection"
}
]
}