Get one recall line
get
/fscmRestApi/resources/11.13.18.05/captureAndValidateRecallNotices/{HeaderId}/child/captureAndValidateRecallLines/{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 : captureAndValidateRecallNotices-captureAndValidateRecallLines-item-response
Type:
Show Source
object-
BrandName: string
Maximum Length:
60Brand name of the recalled part provided by the source of recall. -
Comments: string
Maximum Length:
2000Comments in the recall line. -
DeviceIdentifier: string
Maximum Length:
255Device identifier for the recalled part provided by the source of recall. -
GTIN: string
Maximum Length:
255Global Trade Identification Number for the recalled part provided by the source of recall. -
HeaderId: integer
(int64)
Recall header identifier to which the recall lines are associated.
-
InventoryItemId: integer
(int64)
-
InventoryItemId1: integer
(int64)
Title:
Item NumberRead Only:true -
ItemCategory: string
Read Only:
truePurchasing category of the recalled item. -
ItemDescription: string
Read Only:
trueDescription of the recalled item. -
ItemMatchFlag: string
Read Only:
trueIndicates whether an Oracle item number, supplier part number or manufacturer part number is identified for the recalled part. -
ItemNumber: string
Read Only:
trueOracle item number for the part that's captured in the recall notice. -
LineId: integer
(int64)
Recall notice line identifier.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerPartNumber: string
Manufacturer part number derived based on the part details captured in the recall notice.
-
ModelNumber: string
Maximum Length:
255Model number for the recalled part provided by the source of recall. -
PartDescription: string
Maximum Length:
4000Description of the recalled part provided by the source of recall. -
PartNumber: string
Maximum Length:
700Recalled part number provided by the source of recall. -
ProbableMatchesFoundFlag: string
Read Only:
trueIndicates whether an exact item match exists or probable match exists for the recalled parts in the recall notice. -
ProviderLineNumber: string
Maximum Length:
60Unique recall line number passed by the provider. -
recalledLotNumbers: array
Recall Lot Numbers
Title:
Recall Lot NumbersRecalled lot numbers pertaining to the recalled parts on the recall notices. -
recalledSerialNumbers: array
Recall Serial Numbers
Title:
Recall Serial NumbersRecalled serial numbers pertaining to the recalled parts on the recall notices. -
ReceiptExistenceFlag: string
Indicates whether the recalled item was received during the recall period.
-
Status: string
Title:
MeaningRead Only:trueMaximum Length:80Lookup meaning for the status of the recall line. -
StatusCode: string
Read Only:
trueMaximum Length:30Lookup code for the status of the recall line. -
SupplierPartNumber: string
Supplier part number derived based on the part details captured in the recall notice.
-
WithdrawReasonCode: string
Maximum Length:
30Reason code provided by the end user to withdraw a recall line.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Recall Lot Numbers
Type:
arrayTitle:
Recall Lot NumbersRecalled lot numbers pertaining to the recalled parts on the recall notices.
Show Source
Nested Schema : Recall Serial Numbers
Type:
arrayTitle:
Recall Serial NumbersRecalled serial numbers pertaining to the recalled parts on the recall notices.
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 : captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-item-response
Type:
Show Source
object-
ExpirationDate: string
(date)
Expiration date for the recalled lot provided by the source of recall.
-
HeaderId: integer
(int64)
Recall header identifier to which the recalled lots are associated.
-
LineId: integer
(int64)
Recall line identifier to which the recalled lots are associated.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotId: integer
(int64)
Recall notice lot identifier.
-
MfgLotNumber: string
Maximum Length:
80Recalled lot number provided by the source of recall. -
recalledLotSerialNumbers: array
Recall Lot Serial Numbers
Title:
Recall Lot Serial NumbersRecalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Recall Lot Serial Numbers
Type:
arrayTitle:
Recall Lot Serial NumbersRecalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.
Show Source
Nested Schema : captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-item-response
Type:
Show Source
object-
HeaderId: integer
(int64)
Recall header identifier to which the recalled lot serial numbers are associated.
-
LineId: integer
(int64)
Recall line identifier to which the recalled lot serial numbers are associated.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotId: integer
(int64)
Recall lot identifier to which the recalled serial numbers are associated.
-
MfgFromSerialNumber: string
Maximum Length:
80Starting serial number pertaining to specific lot that's recalled as provided by the source of recall. -
MfgToSerialNumber: string
Maximum Length:
80Ending serial number pertaining to specific lot that's recalled as provided by the source of recall. -
Quantity: number
Quantity of serial numbers that are recalled for a given recalled lot.
-
SerialId: integer
(int64)
Recall notice lot serial identifier.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledSerialNumbers-item-response
Type:
Show Source
object-
HeaderId: integer
(int64)
Recall header identifier to which the recalled serial numbers are associated.
-
LineId: integer
(int64)
Recall line identifier to which the recalled serial numbers are associated.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MfgFromSerialNumber: string
Maximum Length:
80Starting serial number that's recalled as provided by the source of recall. -
MfgToSerialNumber: string
Maximum Length:
80Ending serial number that's recalled as provided by the source of recall. -
Quantity: number
Quantity of serial numbers that are recalled for a given part.
-
SerialId: integer
(int64)
Recall notice serial identifier.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- recalledLotNumbers
-
Parameters:
- HeaderId:
$request.path.HeaderId - LineId:
$request.path.LineId
Recalled lot numbers pertaining to the recalled parts on the recall notices. - HeaderId:
- recalledSerialNumbers
-
Parameters:
- HeaderId:
$request.path.HeaderId - LineId:
$request.path.LineId
Recalled serial numbers pertaining to the recalled parts on the recall notices. - HeaderId: