Get one recall notice
get
/fscmRestApi/resources/11.13.18.05/captureAndValidateRecallNotices/{HeaderId}
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=
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-item-response
Type:
Show Source
object
-
AdditionalInformation: string
Read Only:
true
Maximum Length:4000
Additional information related to the recall notice. -
AttachmentEntityName: string
Attachment entity in the recall notice.
-
captureAndValidateRecallLines: array
Recall Lines
Title:
Recall Lines
Recalled parts on the recall notices. -
Comments: string
Read Only:
true
Maximum Length:2000
Comments in the recall notice. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the user created the recall notice. -
DispositionType: string
Title:
Meaning
Maximum Length:80
Lookup meaning for the disposition type as instructed by the source of recall. -
DispositionTypeCode: string
Maximum Length:
30
Lookup code for the disposition type as instructed by the source of recall. -
DistributionEndDate: string
(date)
Distribution end date provided by the source of recall.
-
DistributionStartDate: string
(date)
Distribution start date provided by the source of recall.
-
HeaderId: integer
(int64)
Recall notice header identifier.
-
InitiationDate: string
(date-time)
Date on which the recall was initiated.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the recall notice was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModeOfCapture: string
Title:
Meaning
Lookup meaning for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service. -
ModeOfCaptureCode: string
Lookup code for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.
-
PotentialRisk: string
Maximum Length:
2000
Potential risk involved on consuming the recalled part as informed by the source of recall. -
ProviderRecallAssociationNumber: string
Maximum Length:
60
Original provider recall number passed by the provider in the subsequent recall notice to make any revision to the existing recall data. -
ProviderRecallNumber: string
Maximum Length:
60
Unique recall number passed by the provider. -
RecallAssociationNumber: string
Original source document reference number passed in the expansion recall notice to indicate that it's an expansion recall.
-
RecallDeviceClass: string
Title:
Meaning
Maximum Length:80
Device classification lookup meaning provided by the source of recall. -
RecallDeviceClassCode: string
Maximum Length:
80
Device classification lookup code provided by the source of recall. -
recallHeaderAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
RecallingFirm: string
Maximum Length:
360
The party who initiated the recall. -
RecallInstruction: string
Maximum Length:
4000
Recall instructions provided by the source of recall. -
recallNoticeAssociationEntities: array
Recall Notice Association Entities
Title:
Recall Notice Association Entities
Entities associated with a recall notice. -
recallNoticeContacts: array
Recall Contacts
Title:
Recall Contacts
Contact information on the recall notices. -
RecallNoticeType: string
Title:
Meaning
Maximum Length:80
Recall notice type lookup meaning provided by the source of recall. -
RecallNoticeTypeCode: string
Maximum Length:
360
Recall notice type lookup code provided by the source of recall. -
RecallReason: string
Maximum Length:
4000
Recall reason provided by the source of recall. -
RecallReceivedFrom: string
Maximum Length:
360
The party who communicated the recall. It can be manufacturer name or distributor name or even the regulatory authority. -
RegAuthClsfType: string
Title:
Meaning
Maximum Length:80
Classification lookup meaning for a recall notice as per regulatory authority. -
RegAuthClsfTypeCode: string
Maximum Length:
80
Classification lookup code for a recall notice as per regulatory authority. -
ReportedDate: string
(date-time)
The date on which the recall was communicated by the manufacturer or distributor.
-
SourceReferenceNumber: string
Maximum Length:
60
Recall number given by the source of recall. -
Status: string
Maximum Length:
255
Lookup meaning for the status of the recall notice. -
StatusCode: string
Maximum Length:
255
Lookup code for the status of the recall notice. -
WithdrawReason: string
Read Only:
true
Maximum Length:255
Lookup meaning for the withdrawal reason code provided by the end user to withdraw a recall notice. -
WithdrawReasonCode: string
Read Only:
true
Maximum Length:255
Reason code provided by the end user to withdraw a recall notice.
Nested Schema : Recall Lines
Type:
array
Title:
Recall Lines
Recalled parts on the recall notices.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Recall Notice Association Entities
Type:
array
Title:
Recall Notice Association Entities
Entities associated with a recall notice.
Show Source
Nested Schema : Recall Contacts
Type:
array
Title:
Recall Contacts
Contact information on the recall notices.
Show Source
Nested Schema : captureAndValidateRecallNotices-captureAndValidateRecallLines-item-response
Type:
Show Source
object
-
BrandName: string
Maximum Length:
60
Brand name of the recalled part provided by the source of recall. -
Comments: string
Maximum Length:
2000
Comments in the recall line. -
DeviceIdentifier: string
Maximum Length:
255
Device identifier for the recalled part provided by the source of recall. -
GTIN: string
Maximum Length:
255
Global 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 Number
Read Only:true
-
ItemCategory: string
Read Only:
true
Purchasing category of the recalled item. -
ItemDescription: string
Read Only:
true
Description of the recalled item. -
ItemMatchFlag: string
Read Only:
true
Indicates whether an Oracle item number, supplier part number or manufacturer part number is identified for the recalled part. -
ItemNumber: string
Read Only:
true
Oracle item number for the part that's captured in the recall notice. -
LineId: integer
(int64)
Recall notice line identifier.
-
links: array
Links
Title:
Links
The 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:
255
Model number for the recalled part provided by the source of recall. -
PartDescription: string
Maximum Length:
4000
Description of the recalled part provided by the source of recall. -
PartNumber: string
Maximum Length:
700
Recalled part number provided by the source of recall. -
ProviderLineNumber: string
Maximum Length:
60
Unique recall line number passed by the provider. -
recalledLotNumbers: array
Recall Lot Numbers
Title:
Recall Lot Numbers
Recalled lot numbers pertaining to the recalled parts on the recall notices. -
recalledSerialNumbers: array
Recall Serial Numbers
Title:
Recall Serial Numbers
Recalled 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:
Meaning
Read Only:true
Maximum Length:80
Lookup meaning for the status of the recall line. -
StatusCode: string
Read Only:
true
Maximum Length:30
Lookup 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:
30
Reason code provided by the end user to withdraw a recall line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recall Lot Numbers
Type:
array
Title:
Recall Lot Numbers
Recalled lot numbers pertaining to the recalled parts on the recall notices.
Show Source
Nested Schema : Recall Serial Numbers
Type:
array
Title:
Recall Serial Numbers
Recalled serial numbers pertaining to the recalled parts on the recall notices.
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 : 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:
Links
The link relations associated with the resource instance. -
LotId: integer
(int64)
Recall notice lot identifier.
-
MfgLotNumber: string
Maximum Length:
80
Recalled lot number provided by the source of recall. -
recalledLotSerialNumbers: array
Recall Lot Serial Numbers
Title:
Recall Lot Serial Numbers
Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.
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
Recalled 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:
Links
The 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:
80
Starting serial number pertaining to specific lot that's recalled as provided by the source of recall. -
MfgToSerialNumber: string
Maximum Length:
80
Ending 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:
array
Title:
Links
The 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:
Links
The link relations associated with the resource instance. -
MfgFromSerialNumber: string
Maximum Length:
80
Starting serial number that's recalled as provided by the source of recall. -
MfgToSerialNumber: string
Maximum Length:
80
Ending 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : captureAndValidateRecallNotices-recallHeaderAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : captureAndValidateRecallNotices-recallNoticeAssociationEntities-item-response
Type:
Show Source
object
-
AssociationEntityId: integer
(int64)
Primary key identifier for the recall notice association entity.
-
AssociationEntityName: string
Title:
Business Unit
Maximum Length:240
Association entity name in the recall notice. -
EntityId: integer
(int64)
Recall notice association entity identifier.
-
HeaderId: integer
(int64)
Recall header identifier to which the association entities belong to.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : captureAndValidateRecallNotices-recallNoticeContacts-item-response
Type:
Show Source
object
-
ContactId: integer
(int64)
Recall notice contact identifier.
-
ContactName: string
Maximum Length:
360
Contact name provided by the source of recall. -
Email: string
Maximum Length:
240
Contact email provided by the source of recall. -
HeaderId: integer
(int64)
Recall header identifier to which the recall contacts are associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Phone: string
Maximum Length:
60
Contact phone number provided by the source of recall.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- captureAndValidateRecallLines
-
Parameters:
- HeaderId:
$request.path.HeaderId
Recalled parts on the recall notices. - HeaderId:
- recallHeaderAttachments
-
Parameters:
- HeaderId:
$request.path.HeaderId
The attachments resource is used to view, create, and update attachments. - HeaderId:
- recallNoticeAssociationEntities
-
Parameters:
- HeaderId:
$request.path.HeaderId
Entities associated with a recall notice. - HeaderId:
- recallNoticeContacts
-
Parameters:
- HeaderId:
$request.path.HeaderId
Contact information on the recall notices. - HeaderId: