Get one recall line
get
/fscmRestApi/resources/11.13.18.05/recallNoticesV2/{HeaderId}/child/recallLines/{LineId}
Request
Path Parameters
-
HeaderId(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=
-
LineId(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : recallNoticesV2-recallLines-item-response
Type:
Show Source
object-
AdditionalInformation: string
Maximum Length:
4000Additional information related to the recall notice line. -
AttachmentEntityName: string
Default Value:
RECALL_NOTICE_LINEName of the attachment entity. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
BpaManufacturerPartLineId: integer
(int64)
Value that uniquely identifies the blanket purchase order line defined in the recall line.
-
BrandName: string
Title:
Brand NameMaximum Length:60Value that indicates the brand name for the recalled product. -
CategoryName: string
Title:
Item CategoryMaximum Length:255Value that identifies the name of the item category. -
Comments: string
Maximum Length:
2000Comments on withdrawal of a recall line. -
ControlType: string
Read Only:
trueMaximum Length:255Value that identifies whether the line is lot, serial, or lot and serial controlled. -
CountQuantity: number
Title:
Count QuantityRead Only:trueCount of the recalled item quantities for a given line. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
DisposedQuantity: number
Read Only:
trueQuantity of recalled items disposed for a given line. -
ExpectedQuantity: number
Title:
Estimated QuantityRead Only:trueQuantity of recalled items expected in the PAR, EXPENSE, and IN_STOCK status for a given line. -
ExpenseCountedQuantity: number
Read Only:
trueCount of the recalled item quantities in the EXPENSE status for a given line. -
ExpenseExpectedQuantity: number
Read Only:
trueQuantity of recalled items expected in the EXPENSE status for a given line. -
ExternalSourceLineId: integer
(int64)
Value that uniquely identifies the recall line.
-
GTIN: string
Maximum Length:
255Indicates the Global Trade Identification number provided in the recall notification. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
InBoundEstimatedQuantity: number
Read Only:
trueQuantity of recalled items expected in the IN BOUND status for a given line. -
InboundQuantity: number
Title:
Inbound QuantityRead Only:trueQuantity of recalled items in the INBOUND status for a given line. -
InStockCountedQuantity: number
Read Only:
trueCount of the recalled item quantities in the IN STOCK status for a given line. -
InStockEstimatedQuantity: number
Read Only:
trueQuantity of recalled items expected in the IN STOCK status for a given line. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemCategoryId: string
Maximum Length:
255Value that uniquely identifies the purchasing item category. -
ItemDescription: string
Title:
Item DescriptionMaximum Length:255Description of the item as a statement, picture description, or an account description. -
ItemNumber: string
Title:
ItemMaximum Length:300Number that identifies the item. -
ItemValidationOrgId: integer
(int64)
Value that uniquely identifies the item validation organization.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Name of the user who most recently updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32User who most recently updated the record. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
LineNumber that identifies the recall notice line entered by the user. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerPartId: integer
(int64)
Title:
Manufacturer PartValue that uniquely identifies the trading partner item. -
ManufacturerPartNumber: string
Title:
Manufacturer Part NumberMaximum Length:700Number that identifies the manufacturer part in the recall line. -
ModelName: string
Title:
Model NameMaximum Length:60Model name of the recalled product. -
NdcCode: string
Title:
National Drug CodeMaximum Length:60Abbreviation that identifies the national drug for the recalled part. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OriginalLineId: integer
(int64)
Value that uniquely identifies the original recall notice line that gets updated for a recall notice line marked as duplicate.
-
ParCountedQuanity: number
Read Only:
trueCount of the recalled item quantities in the PAR status for a given line. -
ParExpectedQuantity: number
Read Only:
trueCount of the recalled item quantities in the PAR status for a given line. -
PartNumber: string
Maximum Length:
700Part number. -
PrimaryUnitOfMeasure: string
Read Only:
trueMaximum Length:25Value that identifies the primary unit of measure of the item. -
ProbableMatchesFoundFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether an exact item match exists or probable match exists for the recalled parts in the recall notice. -
ProductDescription: string
Maximum Length:
4000Value that identifies the description of the product. -
ProductType: string
Maximum Length:
255Value that identifies the recalled product type. -
ProductTypeCode: string
Maximum Length:
30Value that identifies the recalled product type code. A list of accepted values is defined in the lookup type ORA_SCH_PRM_PRODUCT_TYPES. It identifies the meaning of FND_LOOKUP. -
ProviderLineNumber: string
Read Only:
trueMaximum Length:60Unique recall line number passed by the provider. -
RecallClosingDate: string
(date-time)
Title:
Expected Closure DateDate when the expected recall notice closes. -
RecallLineStatus: string
Title:
StatusMaximum Length:80Status of recall notice line. -
RecallLineStatusCode: string
Maximum Length:
30Abbreviation that identifies the status of recall line. It identifies the code for FND_LOOKUP. -
recallLotNumbers: array
Recall Lot Numbers
Title:
Recall Lot NumbersInformation about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life. -
recallNoticeLineDFFs: array
recallNoticeLineDFFs
-
recallPartSerialNumbers: array
Recall Serial Numbers
Title:
Recall Serial NumbersInformation about the serial number details including range and single serials. -
SerialEntryMode: string
Read Only:
trueMaximum Length:255Value that identifies whether the line has a serial controlled item. -
SupplierPartNumber: string
Title:
Supplier Part NumberMaximum Length:300Supplier part number. -
TasksCompleted: integer
Read Only:
trueValue that identifies the percentage of tasks in completed and withdrawn status to the total number of tasks for a recall line. -
TotalNumberOfAttachments: integer
Read Only:
trueIndicates the total number of attachments. -
TotalNumberOfLots: integer
Read Only:
trueTotal number of lots for a line. -
TotalSerialsQuantity: integer
Read Only:
trueTotal quantity of recalled serial numbers. -
UDI: string
Maximum Length:
255Indicates the Unique Device Identifier provided in the recall notification. -
WithdrawReason: string
Title:
MeaningMaximum Length:80Lookup meaning selected to withdraw a recall line that's in Open status. The lookup codes are user-defined. -
WithdrawReasonCode: string
Maximum Length:
30Lookup code selected to specify the reason for withdrawing a recall line that's in Open status. The lookup codes are user-defined.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Recall Lot Numbers
Type:
arrayTitle:
Recall Lot NumbersInformation about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.
Show Source
Nested Schema : Recall Serial Numbers
Type:
arrayTitle:
Recall Serial NumbersInformation about the serial number details including range and single serials.
Show Source
Nested Schema : recallNoticesV2-recallLines-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
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 : recallNoticesV2-recallLines-recallLotNumbers-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
ExpirationDate: string
(date-time)
Title:
Expiry DateDate when the recalled lot expires. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who most recently updated the document. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
Line NumberRead Only:trueNumber that identifies the recall notice line entered by the user. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotId: integer
(int64)
Value that uniquely identifies the recalled lot.
-
MfgDate: string
(date-time)
Title:
Manufacturing DateDate when the recalled lot is manufactured. -
MfgLotNumber: string
Title:
Manufacturer Lot NumberMaximum Length:80Number 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 Serial Numbers
Title:
Recall Serial NumbersInformation about the serial number details including range and single serials. -
SerialEntryMode: string
Read Only:
trueMaximum Length:255Value that identifies whether the lot has a serial controlled item. -
ShelfLifeDays: number
Title:
Days to ExpirationNumber of days that indicate the shelf life for the recalled lot. -
TotalSerialsForLot: integer
Read Only:
trueTotal quantity of recalled serials for a lot.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Recall Serial Numbers
Type:
arrayTitle:
Recall Serial NumbersInformation about the serial number details including range and single serials.
Show Source
Nested Schema : recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate 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:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Name of the user who most recently updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32User who most recently updated the record. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
Line NumberRead Only:trueNumber that identifies the recall notice line entered by the user. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotId: integer
(int64)
Value that uniquely identifies the recalled lot.
-
MfgFromSerialNumber: string
Title:
From Serial NumberMaximum Length:80Starting serial number as specified by the manufacturer in the recall notice. -
MfgToSerialNumber: string
Title:
To Serial NumberMaximum Length:80Ending 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:
QuantityQuantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number. -
SerialEntryMode: string
Title:
Serial Entry ModeMaximum Length:60Default Value:ByRangeMode whether to enter an individual serial or a serial in a range. -
SerialId: integer
(int64)
Value that uniquely identifies the recalled serial number.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recallNoticesV2-recallLines-recallNoticeLineDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:80Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
LineId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recallNoticesV2-recallLines-recallPartSerialNumbers-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate 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:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Name of the user who most recently updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32User who most recently updated the record. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
Line NumberRead Only:trueNumber that identifies the recall notice line entered by the user. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotId: integer
(int64)
Value that uniquely identifies the recalled lot.
-
MfgFromSerialNumber: string
Title:
From Serial NumberMaximum Length:80Starting serial number as specified by the manufacturer in the recall notice. -
MfgToSerialNumber: string
Title:
To Serial NumberMaximum Length:80Ending 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:
QuantityQuantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number. -
SerialEntryMode: string
Title:
Serial Entry ModeMaximum Length:60Default Value:ByRangeMode whether to enter an individual serial or a serial in a range. -
SerialId: integer
(int64)
Value that uniquely identifies the recalled serial number.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- HeaderId:
$request.path.HeaderId - LineId:
$request.path.LineId
The attachments resource is used to view, create, and update attachments. - HeaderId:
- recallLotNumbers
-
Parameters:
- HeaderId:
$request.path.HeaderId - LineId:
$request.path.LineId
Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life. - HeaderId:
- recallNoticeLineDFFs
-
Parameters:
- HeaderId:
$request.path.HeaderId - LineId:
$request.path.LineId
- HeaderId:
- recallPartSerialNumbers
-
Parameters:
- HeaderId:
$request.path.HeaderId - LineId:
$request.path.LineId
Information about the serial number details including range and single serials. - HeaderId: