Get one header
get
/fscmRestApi/resources/11.13.18.05/recallNotices/{HeaderId}
Request
Path Parameters
-
HeaderId(required): integer(int64)
Value that uniquely identifies the recall notice header.
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:
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.
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 : recallNotices-item-response
Type:
Show Source
object
-
BpaManufacturerLineId: integer
(int64)
Value that uniquely identifies the blanket purchase order line defined in the recall notice header.
-
BusinessUnitId: integer
(int64)
Title:
Business Unit
Value that uniquely identifies the business unit in which the recall notice is created. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
Comments: string
Maximum Length:
2000
Comments on withdrawal of a recall notice. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the record. -
DupValidationFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then duplication validation has happened. If false, then duplication validation has not happened. The default value is false. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
IsWithdrawEligibleFlag: boolean
Read Only:
true
Maximum Length:255
Contains one of the following values: true or false. If true, then the recall notice is eligible for withdrawal. If false, then the recall notice is not eligible for withdrawal. The value is derived, so does not have a default value. -
ItemsNotFoundFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then locate could not trace the part. If false, then locate traced the part. The default value is true. -
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 record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocateRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the locate request. This attribute is application generated when the locate parts job is submitted. -
LocateStatus: string
Maximum Length:
30
Contains one of the following values: true or false. If true, then locate action has been taken on the recall notice. If false, then locate action has not been taken on the recall notice. The default value is false. -
ManufacturerId: integer
(int64)
Title:
Manufacturer
Value that uniquely identifies the trading partner. -
ManufacturerName: string
Title:
Manufacturer
Maximum Length:255
Name of the business partner. -
ManufacturerNumber: string
Title:
Registry ID
Maximum Length:30
Number that uniquely identifies the manufacturer. -
ManufacturerURL: string
Title:
URL
Maximum Length:2000
URL (Uniform Resource Locator) of the manufacturing firm. -
NumberOfLinesClosed: string
Read Only:
true
Maximum Length:255
Number of line items in the closed status for a recall notice. -
NumberOfLinesFound: string
Read Only:
true
Maximum Length:255
Number of line items located in a recall notice. -
NumberOfLinesInProgress: string
Read Only:
true
Maximum Length:255
Number of line items in the in-progress status for a recall notice. -
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.
-
OriginalHeaderId: integer
(int64)
Value that uniquely identifies the original recall notice header that gets updated for a recall notice marked as duplicate.
-
PotentialRisk: string
Title:
Potential Risk
Maximum Length:2000
Text that provides details about the risk factors of the recalled product. -
recallBusinessUnits: array
Business Units
Title:
Business Units
The Business Units resource manages the business units assigned to the recall notice. -
RecallClassificationType: string
Title:
Classification
Maximum Length:80
Classification of recall notice based on the severity of impact it has on consumers. A list of accepted values is defined in the lookup type ORA_SCH_CLASSIFICATION. It identifies the meaning for FND_LOOKUP. -
RecallClassificationTypeCode: string
Title:
Classification
Maximum Length:30
Abbreviation that identifies the classification of a recall notice based on the severity of impact it has on consumers. A list of accepted values is defined in the lookup type ORA_SCH_CLASSIFICATION. -
RecallClosingDate: string
(date-time)
Title:
Expected Closure Date
Date when the expected recall notice closes. -
recallContacts: array
Recall Contacts
Title:
Recall Contacts
The Recall Contacts resource manages the contact details of person in the recalling organization. The contact information includes name, position, phone, and email. -
RecallHeaderStatus: string
Title:
Meaning
Maximum Length:80
Status of recall notice header. It identifies the meaning for FND_LOOKUP. It identifies the meaning for FND_LOOKUP. -
RecallHeaderStatusCode: string
Maximum Length:
30
Abbreviation that identifies the status of recall notice header. -
RecallInitiationDate: string
(date-time)
Title:
Initiation Date
Date when the recall notice is initiated by the source. -
RecallInstruction: string
Title:
Recall Instructions
Maximum Length:2000
Text that provides special instructions on taking disposition actions for recalled parts. -
recallLines: array
Recall Lines
Title:
Recall Lines
The Recall Lines resource manages the information about a recall notice line, which includes details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category. The line identifier is a unique application-generated primary key and is invisible to the user. -
RecallNoticeNumber: string
Title:
Notice Number
Maximum Length:60
Number that identifies the recall notice. This attribute is used for internal tracking within the enterprise that gets generated based on the document sequencing setup. -
RecallNoticeType: string
Title:
Notice Type
Maximum Length:80
Classification of recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE. It identifies the meaning for FND_LOOKUP. -
RecallNoticeTypeCode: string
Title:
Notice Type
Maximum Length:30
Abbreviation that identifies the classification of a recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE. -
RecallReason: string
Title:
Recall Reason
Maximum Length:2000
Text that provides details about the recall reasons. -
RecallReferenceNumber: string
Title:
Source Document Reference
Maximum Length:60
Number that references the recall. This value is provided by the source that initiated the recall. -
RecallSourceId: integer
(int64)
Title:
Source
Value that uniquely identifies the recall source. -
RecallSourceName: string
Title:
Source
Maximum Length:255
Name of the recall source that initiated the recall notice. When the recall source type is supplier, this attribute displays the supplier defined in the supplier master with the Spend Authorized business relationship type, when the recall source type is regulatory authority, this attribute displays the regulatory authority, when the recall source type is internal, this attribute displays the business unit, and when the recall source type is manufacturer, this attribute displays the party name. -
RecallSourceType: string
Title:
Source Type
Maximum Length:80
Type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on. It identifies the meaning for FND_LOOKUP. -
RecallSourceTypeCode: string
Title:
Source Type
Maximum Length:30
Abbreviation that identifies the type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on. -
RecallTrackEndDate: string
(date)
Title:
Track End Date
Date when the recall track ends. This attribute is used to locate the part that is not associated with batch or serial. -
RecallTrackStartDate: string
(date)
Title:
Track Start Date
Date when the recall track starts. This attribute is used to locate the part that is not associated with batch or serial. -
ReplacementType: string
Title:
Replacement Type
Maximum Length:80
Type of method by which the recalled parts can be disposed off. A list of accepted values is defined in the lookup type ORA_SCH_REPLACEMENT_TYPE. It identifies the meaning for FND_LOOKUP. -
ReplacementTypeCode: string
Title:
Replacement Type
Maximum Length:30
Abbreviation that identifies the type of method by which the recalled parts can be disposed off. A list of accepted values is defined in the lookup type ORA_SCH_REPLACEMENT_TYPE. -
TasksAssigned: number
Read Only:
true
Value that identifies the total number of assigned tasks. -
TasksCompleted: number
Read Only:
true
Value that identifies the percentage of the tasks in completed and withdrawn status to the total number of tasks in a recall notice. -
TotalNoOfLines: string
Read Only:
true
Value that gives number of lines count for the header record. -
TotalTasksCompleted: integer
Read Only:
true
Total number of tasks in completed and withdrawn status in a recall notice. -
TotalTraceabilityStatus: integer
Read Only:
true
Total number of distinct traceability statuses that exist. -
TraceabilityStatusFound: number
Read Only:
true
Value that identifies the number of distinct traceability statuses found. -
TrackEndDate: string
(date)
Read Only:
true
Date when the recall track ends. This attribute is entered by the user when submitting the job for locate parts. -
TrackStartDate: string
(date)
Read Only:
true
Date when the recall track starts. This attribute is entered by the user when submitting the job for locate parts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Business Units
Type:
array
Title:
Business Units
The Business Units resource manages the business units assigned to the recall notice.
Show Source
Nested Schema : Recall Contacts
Type:
array
Title:
Recall Contacts
The Recall Contacts resource manages the contact details of person in the recalling organization. The contact information includes name, position, phone, and email.
Show Source
Nested Schema : Recall Lines
Type:
array
Title:
Recall Lines
The Recall Lines resource manages the information about a recall notice line, which includes details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category. The line identifier is a unique application-generated primary key and is invisible to the user.
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-recallBusinessUnits-item-response
Type:
Show Source
object
-
AssignedBUId: integer
(int64)
Value that uniquely identifies the business unit.
-
AssignedBUName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the business unit assignment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the business unit assignment. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the business unit assignment. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who most recently updated the business unit assignment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Code that uniquely identifies the user who most recently updated the business unit assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number of times the business unit assignment was updated.
-
RecBUAssignmentId: integer
(int64)
Value that uniquely identifies the business unit assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recallNotices-recallContacts-item-response
Type:
Show Source
object
-
ContactId: integer
(int64)
Value that uniquely identifies the contact person in the recalling firm.
-
ContactName: string
Maximum Length:
60
Name of the contact person in the recalling firm. -
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. -
Email: string
Title:
Email
Maximum Length:60
Email of the contact person in the recalling firm. -
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 of the user who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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.
-
Position: string
Title:
Position
Maximum Length:60
Value that indicates the position of the contact person in the recalling firm. -
Telephone: string
Maximum Length:
60
Phone number of the contact person in the recalling firm.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recallNotices-recallLines-item-response
Type:
Show Source
object
-
AttachmentEntityName: string
Default Value:
RECALL_NOTICE_LINE
Name of the attachment entity. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages the attachments for the recall notice line. -
BpaManufacturerPartLineId: integer
(int64)
Value that uniquely identifies the blanket purchase order line defined in the recall line.
-
BrandName: string
Title:
Brand Name
Maximum Length:60
Text that indicates the brand name for the recalled product. -
CategoryName: string
Title:
Item Category
Maximum Length:255
Translatable name of the item category. -
Comments: string
Maximum Length:
2000
Comments on withdrawal of a recall line. -
ControlType: string
Read Only:
true
Maximum Length:255
Value that identifies whether the line is lot, serial, or lot and serial controlled. -
CountQuantity: number
Title:
Count Quantity
Read Only:true
Count of the recalled item quantities for a given line. -
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. -
DisposedQuantity: number
Read Only:
true
Quantity of recalled items disposed for a given line. -
ExpectedQuantity: number
Title:
Estimated Quantity
Read Only:true
Quantity of recalled items expected in the PAR, EXPENSE, and IN_STOCK status for a given line. -
ExpenseCountedQuantity: number
Read Only:
true
Count of the recalled item quantities in the EXPENSE status for a given line. -
ExpenseExpectedQuantity: number
Read Only:
true
Quantity of recalled items expected in the EXPENSE status for a given line. -
HeaderId: integer
(int64)
Value that uniquely identifies the recall notice header.
-
InBoundEstimatedQuantity: number
Read Only:
true
Quantity of recalled items expected in the IN BOUND status for a given line. -
InboundQuantity: number
Title:
Inbound Quantity
Read Only:true
Quantity of recalled items in the INBOUND status for a given line. -
InStockCountedQuantity: number
Read Only:
true
Count of the recalled item quantities in the IN STOCK status for a given line. -
InStockEstimatedQuantity: number
Read Only:
true
Quantity 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:
255
Value that uniquely identifies the purchasing item category. -
ItemDescription: string
Maximum Length:
255
Description of the item as a statement, picture description, or an account description. -
ItemNumber: string
Title:
Item
Maximum Length:300
Number that identifies the item. -
ItemValidationOrgId: integer
(int64)
Value that uniquely identifies the item validation organization.
-
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 record. -
LineId: integer
(int64)
Value that uniquely identifies the recall notice line.
-
LineNumber: integer
(int64)
Title:
Line
Number that identifies the recall notice line entered by the user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerPartId: integer
(int64)
Title:
Manufacturer Part
Value that uniquely identifies the trading partner item. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Maximum Length:700
Number that identifies the manufacturer part. -
ModelName: string
Title:
Model Name
Maximum Length:60
Model name of the recalled product. -
NdcCode: string
Title:
National Drug Code
Maximum Length:60
Abbreviation 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:
true
Count of the recalled item quantities in the PAR status for a given line. -
ParExpectedQuantity: number
Read Only:
true
Quantity of recalled items expected in the PAR status for a given line. -
PrimaryUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Primary unit of measure for the recalled part. -
ProductType: string
Title:
Product Type
Maximum Length:600
Type of product of the manufactured part. -
RecallClosingDate: string
(date-time)
Title:
Expected Closure Date
Date when the expected recall notice closes. -
RecallLineStatus: string
Title:
Status
Maximum Length:80
Status of recall notice line. -
RecallLineStatusCode: string
Maximum Length:
30
Abbreviation that identifies the status of recall line. It identifies the code for FND_LOOKUP. -
recallLotNumbers: array
Recall Lot Numbers
Title:
Recall Lot Numbers
The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life. -
recallSerialNumbers: array
Recall Serial Numbers
Title:
Recall Serial Numbers
The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, 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 line has a serial controlled item. -
TasksCompleted: integer
Read Only:
true
Value 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:
true
Total number of attachments for a line. -
TotalNumberOfLots: integer
Read Only:
true
Total number of lots for a line.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages the attachments for the recall notice line.
Show Source
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
The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.
Show Source
Nested Schema : Recall Serial Numbers
Type:
array
Title:
Recall Serial Numbers
The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.
Show Source
Nested Schema : recallNotices-recallLines-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work order. It is a primary key that the application generates when a document is attached to the work order. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique document identification of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
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
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
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
Date and time when the user most recently updated the document that is attached to the work order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the document that is attached to the work order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work order. -
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
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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:
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.
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 : 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
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
Nested Schema : recallNotices-recallLines-recallSerialNumbers-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
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
- recallBusinessUnits
-
Parameters:
- HeaderId:
$request.path.HeaderId
The Business Units resource manages the business units assigned to the recall notice. - HeaderId:
- recallContacts
-
Parameters:
- HeaderId:
$request.path.HeaderId
The Recall Contacts resource manages the contact details of person in the recalling organization. The contact information includes name, position, phone, and email. - HeaderId:
- recallLines
-
Parameters:
- HeaderId:
$request.path.HeaderId
The Recall Lines resource manages the information about a recall notice line, which includes details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category. The line identifier is a unique application-generated primary key and is invisible to the user. - HeaderId: