Update one serial number
patch
/fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions/{TransactionInterfaceId}/child/serials/{serialsUniqID}
Request
Path Parameters
-
TransactionInterfaceId(required): integer(int64)
Value that uniquely identifies the transaction.
-
serialsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TransactionInterfaceId and FmSerialNumber ---for the Serials resource and used to uniquely identify an instance of Serials. The client should not generate the hash key value. Instead, the client should query on the Serials collection resource with a filter on the primary key values in order to navigate to a specific instance of Serials.
For example: serials?q=TransactionInterfaceId=<value1>;FmSerialNumber=<value2>
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-
ErrorCode: string
Maximum Length:
240Abbreviation that identifies the error. -
FmSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. -
OriginationDate: string
(date)
Date when this lot serial originated.
-
serialAttributeDFFs: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item. -
serialStandardDFFs: array
Flexfields for Serials
Title:
Flexfields for SerialsThe Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item. -
SourceCode: string
Maximum Length:
30Abbreviation that identifies the source. -
SourceLineId: integer
(int64)
Value that uniquely identifies the source line.
-
StatusCode: string
Maximum Length:
80Abbreviation that identifies the status. -
StatusId: integer
(int64)
Value that uniquely identifies the status.
-
StatusName: string
Maximum Length:
30Description of the status. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the transaction.
-
VendorSerialNumber: string
Maximum Length:
80Vendor serial number corresponding to a serial number for an item.
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type:
arrayTitle:
Flexfields for SerialsThe Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-serials-serialAttributeDFFs-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial attributes. -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
Nested Schema : inventoryStagedTransactions-serials-serialStandardDFFs-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial standards. -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
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 : inventoryStagedTransactions-serials-item-response
Type:
Show Source
object-
ErrorCode: string
Maximum Length:
240Abbreviation that identifies the error. -
FmSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginationDate: string
(date)
Date when this lot serial originated.
-
serialAttributeDFFs: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item. -
serialStandardDFFs: array
Flexfields for Serials
Title:
Flexfields for SerialsThe Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item. -
SourceCode: string
Maximum Length:
30Abbreviation that identifies the source. -
SourceLineId: integer
(int64)
Value that uniquely identifies the source line.
-
StatusCode: string
Maximum Length:
80Abbreviation that identifies the status. -
StatusId: integer
(int64)
Value that uniquely identifies the status.
-
StatusName: string
Maximum Length:
30Description of the status. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the transaction.
-
VendorSerialNumber: string
Maximum Length:
80Vendor serial number corresponding to a serial number for an item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type:
arrayTitle:
Flexfields for SerialsThe Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
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 : inventoryStagedTransactions-serials-serialAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial attributes. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryStagedTransactions-serials-serialStandardDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial standards. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- serialAttributeDFFs
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId - serialsUniqID:
$request.path.serialsUniqID
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item. - TransactionInterfaceId:
- serialStandardDFFs
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId - serialsUniqID:
$request.path.serialsUniqID
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item. - TransactionInterfaceId:
Examples
This example describes how to update one serial 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/inventoryStagedTransactions/TransactionInterfaceId/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.
{
"FmSerialNumber":"Ser-100",
"ToSerialNumber":"Ser-110"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"TransactionInterfaceId": 300100152720875,
"FmSerialNumber": "Ser-100",
"ToSerialNumber": "Ser-110",
"SourceCode": null,
...
}