Update a lot number
patch
/fscmRestApi/resources/11.13.18.05/recallNotices/{HeaderId}/child/recallLines/{LineId}/child/recallLotNumbers/{LotId}
Request
Path Parameters
-
HeaderId(required): integer(int64)
Value that uniquely identifies the recall notice header.
-
LineId(required): integer(int64)
Value that uniquely identifies the recall notice line.
-
LotId(required): integer(int64)
Value that uniquely identifies the recalled lot.
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
-
ExpirationDate: string
(date-time)
Title:
Expiry Date
Date when the recalled lot expires. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
MfgDate: string
(date-time)
Title:
Manufacturing Date
Date when the recalled lot is manufactured. -
MfgLotNumber: string
Title:
Manufacturer Lot Number
Maximum Length:80
Number that identifies the manufacturer lot of the recalled part. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
-
recallLotSerialNumbers: array
Recall Lot Serial Numbers
Title:
Recall Lot Serial Numbers
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials. -
ShelfLifeDays: number
Title:
Days to Expiration
Number of days that indicate the shelf life for the recalled lot.
Nested Schema : Recall Lot Serial Numbers
Type:
array
Title:
Recall Lot Serial Numbers
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.
Show Source
Nested Schema : recallNotices-recallLines-recallLotNumbers-recallLotSerialNumbers-item-patch-request
Type:
Show Source
object
-
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LotId: integer
(int64)
Value that uniquely identifies the recalled lot.
-
MfgFromSerialNumber: string
Title:
From Serial Number
Maximum Length:80
Starting serial number as specified by the manufacturer in the recall notice. -
MfgToSerialNumber: string
Title:
To Serial Number
Maximum Length:80
Ending serial number as specified by the manufacturer in the recall notice. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
-
Quantity: number
Title:
Quantity
Quantity of the recalled serial number. This is an optional value that is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber. -
SerialEntryMode: string
Title:
Serial Entry Mode
Maximum Length:60
Default Value:ByRange
Mode whether or not to enter an individual serial or a serial in range.
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 : recallNotices-recallLines-recallLotNumbers-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
ExpirationDate: string
(date-time)
Title:
Expiry Date
Date when the recalled lot expires. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
Line Number
Read Only:true
Number that identifies the recall notice line entered by the user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotId: integer
(int64)
Value that uniquely identifies the recalled lot.
-
MfgDate: string
(date-time)
Title:
Manufacturing Date
Date when the recalled lot is manufactured. -
MfgLotNumber: string
Title:
Manufacturer Lot Number
Maximum Length:80
Number that identifies the manufacturer lot of the recalled part. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
-
recallLotSerialNumbers: array
Recall Lot Serial Numbers
Title:
Recall Lot Serial Numbers
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials. -
SerialEntryMode: string
Read Only:
true
Maximum Length:255
Value that identifies whether the lot has a serial controlled item. -
ShelfLifeDays: number
Title:
Days to Expiration
Number of days that indicate the shelf life for the recalled lot. -
TotalSerialsForLot: integer
Read Only:
true
Total quantity of recalled serials for a lot.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recall Lot Serial Numbers
Type:
array
Title:
Recall Lot Serial Numbers
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.
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 : recallNotices-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
Line Number
Read Only:true
Number that identifies the recall notice line entered by the user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotId: integer
(int64)
Value that uniquely identifies the recalled lot.
-
MfgFromSerialNumber: string
Title:
From Serial Number
Maximum Length:80
Starting serial number as specified by the manufacturer in the recall notice. -
MfgToSerialNumber: string
Title:
To Serial Number
Maximum Length:80
Ending serial number as specified by the manufacturer in the recall notice. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
-
Quantity: number
Title:
Quantity
Quantity of the recalled serial number. This is an optional value that is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber. -
SerialEntryMode: string
Title:
Serial Entry Mode
Maximum Length:60
Default Value:ByRange
Mode whether or not to enter an individual serial or a serial in range. -
SerialId: integer
(int64)
Value that uniquely identifies the recalled serial number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- recallLotSerialNumbers
-
Parameters:
- HeaderId:
$request.path.HeaderId
- LineId:
$request.path.LineId
- LotId:
$request.path.LotId
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials. - HeaderId: