Jump to

• Request
• Response

Update one recall line

patch

/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=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdditionalInformation: string
  Maximum Length: 4000

  Additional information related to the recall notice line.
• AttachmentEntityName: string
  Default Value: RECALL_NOTICE_LINE

  Name of the attachment entity.
• attachments: array Attachments
  Title: Attachments

  The 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 Name

  Maximum Length: 60

  Value that indicates the brand name for the recalled product.
• CategoryName: string
  Title: Item Category

  Maximum Length: 255

  Value that identifies the name of the item category.
• Comments: string
  Maximum Length: 2000

  Comments on withdrawal of a recall line.
• GTIN: string
  Maximum Length: 255

  Indicates the Global Trade Identification number provided in the recall notification.
• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• 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.
• LineNumber: integer (int64)
  Title: Line

  Number that identifies the recall notice line entered by the user.
• 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 in the recall line.
• 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.
• PartNumber: string
  Maximum Length: 700

  Part number.
• ProductDescription: string
  Maximum Length: 4000

  Value that identifies the description of the product.
• ProductType: string
  Maximum Length: 255

  Value that identifies the recalled product type.
• ProductTypeCode: string
  Maximum Length: 30

  Value 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.
• 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

  Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.
• recallPartSerialNumbers: array Recall Serial Numbers
  Title: Recall Serial Numbers

  Information about the serial number details including range and single serials.
• SupplierPartNumber: string
  Maximum Length: 300

  Supplier part number.
• UDI: string
  Maximum Length: 255

  Indicates the Unique Device Identifier provided in the recall notification.

{
    "type":"object",
    "properties":{
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-attachments-item-patch-request"
            }
        },
        "PartNumber":{
            "maxLength":"700",
            "type":"string",
            "description":"Part number.",
            "nullable":true
        },
        "NdcCode":{
            "title":"National Drug Code",
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the national drug for the recalled part.",
            "nullable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecallLineStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of recall line. It identifies the code for FND_LOOKUP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RecallLineStatus"
                ]
            }
        },
        "recallPartSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"Information about the serial number details including range and single serials.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallPartSerialNumbers-item-patch-request"
            }
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item as a statement, picture description, or an account description.",
            "nullable":true
        },
        "ProductTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value 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.",
            "nullable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"integer",
            "description":"Number that identifies the recall notice line entered by the user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BrandName":{
            "title":"Brand Name",
            "maxLength":"60",
            "type":"string",
            "description":"Value that indicates the brand name for the recalled product.",
            "nullable":true
        },
        "OriginalLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original recall notice line that gets updated for a recall notice line marked as duplicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SupplierPartNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Supplier part number.",
            "nullable":true
        },
        "UDI":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the Unique Device Identifier provided in the recall notification.",
            "nullable":true
        },
        "RecallLineStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of recall notice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "AdditionalInformation":{
            "maxLength":"4000",
            "type":"string",
            "description":"Additional information related to the recall notice line.",
            "nullable":true
        },
        "ItemCategoryId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the purchasing item category.",
            "nullable":true
        },
        "ModelName":{
            "title":"Model Name",
            "maxLength":"60",
            "type":"string",
            "description":"Model name of the recalled product.",
            "nullable":true
        },
        "BpaManufacturerPartLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the blanket purchase order line defined in the recall line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Comments on withdrawal of a recall line.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ItemNumber"
                ]
            }
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":"700",
            "type":"string",
            "description":"Number that identifies the manufacturer part in the recall line.",
            "nullable":true
        },
        "ProductType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the recalled product type.",
            "nullable":true
        },
        "recallLotNumbers":{
            "title":"Recall Lot Numbers",
            "type":"array",
            "description":"Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-item-patch-request"
            }
        },
        "GTIN":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the Global Trade Identification number provided in the recall notification.",
            "nullable":true
        },
        "RecallClosingDate":{
            "title":"Expected Closure Date",
            "type":"string",
            "description":"Date when the expected recall notice closes.",
            "format":"date-time",
            "nullable":true
        },
        "CategoryName":{
            "title":"Item Category",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the name of the item category.",
            "nullable":true
        },
        "ProductDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the description of the product.",
            "nullable":true
        },
        "ManufacturerPartId":{
            "title":"Manufacturer Part",
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"Name of the attachment entity.",
            "nullable":true,
            "default":"RECALL_NOTICE_LINE",
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object recallNoticesV2-recallLines-attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-attachments-item-patch-request"
    }
}

Nested Schema : Recall Lot Numbers

Type: array

Title: Recall Lot Numbers

Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.

Show Source

• Array of: object schema

{
    "title":"Recall Lot Numbers",
    "type":"array",
    "description":"Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-item-patch-request"
    }
}

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

Information about the serial number details including range and single serials.

Show Source

• Array of: object recallNoticesV2-recallLines-recallPartSerialNumbers-item-patch-request

{
    "title":"Recall Serial Numbers",
    "type":"array",
    "description":"Information about the serial number details including range and single serials.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallPartSerialNumbers-item-patch-request"
    }
}

Nested Schema : recallNoticesV2-recallLines-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ExpirationDate: string (date-time)
  Title: Expiry Date

  Date when the recalled lot expires.
• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• MfgDate: string (date-time)
  Title: Manufacturing Date

  Date when the recalled lot is manufactured.
• MfgLotNumber: string
  Title: 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 Serial Numbers
  Title: Recall Serial Numbers

  Information about the serial number details including range and single serials.
• ShelfLifeDays: number
  Title: Days to Expiration

  Number of days that indicate the shelf life for the recalled lot.

{
    "type":"object",
    "properties":{
        "MfgLotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the manufacturer lot of the recalled part.",
            "nullable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpirationDate":{
            "title":"Expiry Date",
            "type":"string",
            "description":"Date when the recalled lot expires.",
            "format":"date-time",
            "nullable":true
        },
        "MfgDate":{
            "title":"Manufacturing Date",
            "type":"string",
            "description":"Date when the recalled lot is manufactured.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "recallLotSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"Information about the serial number details including range and single serials.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-patch-request"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShelfLifeDays":{
            "title":"Days to Expiration",
            "type":"number",
            "description":"Number of days that indicate the shelf life for the recalled lot.",
            "nullable":true
        }
    }
}

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

Information about the serial number details including range and single serials.

Show Source

• Array of: object recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-patch-request

{
    "title":"Recall Serial Numbers",
    "type":"array",
    "description":"Information about the serial number details including range and single serials.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-patch-request"
    }
}

Nested Schema : recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-patch-request

Type: object

Show Source

• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgFromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

  Starting serial number as specified by the manufacturer in the recall notice.
• MfgToSerialNumber: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number as specified by the manufacturer in the recall notice.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• Quantity: number
  Title: Quantity

  Quantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
• SerialEntryMode: string
  Maximum Length: 60

  Default Value: ByRange

  Mode whether to enter an individual serial or a serial in a range.

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MfgFromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number as specified by the manufacturer in the recall notice.",
            "nullable":true
        },
        "SerialEntryMode":{
            "maxLength":"60",
            "type":"string",
            "description":"Mode whether to enter an individual serial or a serial in a range.",
            "nullable":true,
            "default":"ByRange"
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity 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.",
            "nullable":true
        },
        "MfgToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number as specified by the manufacturer in the recall notice.",
            "nullable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : recallNoticesV2-recallLines-recallPartSerialNumbers-item-patch-request

Type: object

Show Source

• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgFromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

  Starting serial number as specified by the manufacturer in the recall notice.
• MfgToSerialNumber: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number as specified by the manufacturer in the recall notice.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• Quantity: number
  Title: Quantity

  Quantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
• SerialEntryMode: string
  Maximum Length: 60

  Default Value: ByRange

  Mode whether to enter an individual serial or a serial in a range.

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MfgFromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number as specified by the manufacturer in the recall notice.",
            "nullable":true
        },
        "SerialEntryMode":{
            "maxLength":"60",
            "type":"string",
            "description":"Mode whether to enter an individual serial or a serial in a range.",
            "nullable":true,
            "default":"ByRange"
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity 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.",
            "nullable":true
        },
        "MfgToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number as specified by the manufacturer in the recall notice.",
            "nullable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : recallNoticesV2-recallLines-item-response

Type: object

Show Source

• AdditionalInformation: string
  Maximum Length: 4000

  Additional information related to the recall notice line.
• AttachmentEntityName: string
  Default Value: RECALL_NOTICE_LINE

  Name of the attachment entity.
• attachments: array Attachments
  Title: Attachments

  The 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 Name

  Maximum Length: 60

  Value that indicates the brand name for the recalled product.
• CategoryName: string
  Title: Item Category

  Maximum Length: 255

  Value that identifies the 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.
• GTIN: string
  Maximum Length: 255

  Indicates 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: 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

  Name of the user who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  User who most recently updated 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 in the recall line.
• 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

  Count of the recalled item quantities in the PAR status for a given line.
• PartNumber: string
  Maximum Length: 700

  Part number.
• PrimaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Value that identifies the primary unit of measure of the item.
• ProductDescription: string
  Maximum Length: 4000

  Value that identifies the description of the product.
• ProductType: string
  Maximum Length: 255

  Value that identifies the recalled product type.
• ProductTypeCode: string
  Maximum Length: 30

  Value 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.
• 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

  Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.
• recallPartSerialNumbers: array Recall Serial Numbers
  Title: Recall Serial Numbers

  Information about the serial number details including range and single serials.
• SerialEntryMode: string
  Read Only: true

  Maximum Length: 255

  Value that identifies whether the line has a serial controlled item.
• SupplierPartNumber: string
  Maximum Length: 300

  Supplier part number.
• 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

  Indicates the total number of attachments.
• TotalNumberOfLots: integer
  Read Only: true

  Total number of lots for a line.
• TotalSerialsQuantity: integer
  Read Only: true

  Total quantity of recalled serial numbers.
• UDI: string
  Maximum Length: 255

  Indicates the Unique Device Identifier provided in the recall notification.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartNumber":{
            "maxLength":"700",
            "type":"string",
            "description":"Part number.",
            "nullable":true,
            "x-queryable":true
        },
        "NdcCode":{
            "title":"National Drug Code",
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the national drug for the recalled part.",
            "nullable":true,
            "x-queryable":true
        },
        "RecallLineStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of recall line. It identifies the code for FND_LOOKUP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RecallLineStatus"
                ]
            },
            "x-queryable":true
        },
        "BrandName":{
            "title":"Brand Name",
            "maxLength":"60",
            "type":"string",
            "description":"Value that indicates the brand name for the recalled product.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierPartNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Supplier part number.",
            "nullable":true,
            "x-queryable":true
        },
        "InboundQuantity":{
            "title":"Inbound Quantity",
            "type":"number",
            "description":"Quantity of recalled items in the INBOUND status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UDI":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the Unique Device Identifier provided in the recall notification.",
            "nullable":true,
            "x-queryable":true
        },
        "DisposedQuantity":{
            "type":"number",
            "description":"Quantity of recalled items disposed for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalSerialsQuantity":{
            "type":"integer",
            "description":"Total quantity of recalled serial numbers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemValidationOrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item validation organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelName":{
            "title":"Model Name",
            "maxLength":"60",
            "type":"string",
            "description":"Model name of the recalled product.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ItemNumber"
                ]
            },
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":"700",
            "type":"string",
            "description":"Number that identifies the manufacturer part in the recall line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the recalled product type.",
            "nullable":true,
            "x-queryable":true
        },
        "CountQuantity":{
            "title":"Count Quantity",
            "type":"number",
            "description":"Count of the recalled item quantities for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"Quantity of recalled items expected in the PAR, EXPENSE, and IN_STOCK status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InBoundEstimatedQuantity":{
            "type":"number",
            "description":"Quantity of recalled items expected in the IN BOUND status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallClosingDate":{
            "title":"Expected Closure Date",
            "type":"string",
            "description":"Date when the expected recall notice closes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ControlType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies whether the line is lot, serial, or lot and serial controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerPartId":{
            "title":"Manufacturer Part",
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-attachments-item-response"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "recallPartSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"Information about the serial number details including range and single serials.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallPartSerialNumbers-item-response"
            }
        },
        "InStockEstimatedQuantity":{
            "type":"number",
            "description":"Quantity of recalled items expected in the IN STOCK status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalNumberOfAttachments":{
            "type":"integer",
            "description":"Indicates the total number of attachments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item as a statement, picture description, or an account description.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value 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.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"integer",
            "description":"Number that identifies the recall notice line entered by the user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginalLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original recall notice line that gets updated for a recall notice line marked as duplicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InStockCountedQuantity":{
            "type":"number",
            "description":"Count of the recalled item quantities in the IN STOCK status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SerialEntryMode":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies whether the line has a serial controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TasksCompleted":{
            "type":"integer",
            "description":"Value that identifies the percentage of tasks in completed and withdrawn status to the total number of tasks for a recall line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallLineStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of recall notice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ParExpectedQuantity":{
            "type":"number",
            "description":"Count of the recalled item quantities in the PAR status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformation":{
            "maxLength":"4000",
            "type":"string",
            "description":"Additional information related to the recall notice line.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCategoryId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the purchasing item category.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TotalNumberOfLots":{
            "type":"integer",
            "description":"Total number of lots for a line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BpaManufacturerPartLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the blanket purchase order line defined in the recall line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Comments on withdrawal of a recall line.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Value that identifies the primary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "recallLotNumbers":{
            "title":"Recall Lot Numbers",
            "type":"array",
            "description":"Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-item-response"
            }
        },
        "GTIN":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the Global Trade Identification number provided in the recall notification.",
            "nullable":true,
            "x-queryable":true
        },
        "ParCountedQuanity":{
            "type":"number",
            "description":"Count of the recalled item quantities in the PAR status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenseCountedQuantity":{
            "type":"number",
            "description":"Count of the recalled item quantities in the EXPENSE status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Item Category",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the name of the item category.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the description of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenseExpectedQuantity":{
            "type":"number",
            "description":"Quantity of recalled items expected in the EXPENSE status for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"Name of the attachment entity.",
            "nullable":true,
            "default":"RECALL_NOTICE_LINE",
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object recallNoticesV2-recallLines-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Recall Lot Numbers

Type: array

Title: Recall Lot Numbers

Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.

Show Source

• Array of: object recallNoticesV2-recallLines-recallLotNumbers-item-response

{
    "title":"Recall Lot Numbers",
    "type":"array",
    "description":"Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-item-response"
    }
}

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

Information about the serial number details including range and single serials.

Show Source

• Array of: object recallNoticesV2-recallLines-recallPartSerialNumbers-item-response

{
    "title":"Recall Serial Numbers",
    "type":"array",
    "description":"Information about the serial number details including range and single serials.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallPartSerialNumbers-item-response"
    }
}

Nested Schema : recallNoticesV2-recallLines-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recallNoticesV2-recallLines-recallLotNumbers-item-response

Type: object

Show Source

• 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

  Session 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 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 Serial Numbers
  Title: Recall Serial Numbers

  Information about the serial number details including range and single serials.
• SerialEntryMode: string
  Read Only: true

  Maximum Length: 255

  Value that identifies whether the lot has a serial controlled item.
• ShelfLifeDays: number
  Title: Days to Expiration

  Number of days that indicate the shelf life for the recalled lot.
• TotalSerialsForLot: integer
  Read Only: true

  Total quantity of recalled serials for a lot.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MfgDate":{
            "title":"Manufacturing Date",
            "type":"string",
            "description":"Date when the recalled lot is manufactured.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the recall notice line entered by the user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MfgLotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the manufacturer lot of the recalled part.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiry Date",
            "type":"string",
            "description":"Date when the recalled lot expires.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "recallLotSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"Information about the serial number details including range and single serials.",
            "items":{
                "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response"
            }
        },
        "SerialEntryMode":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies whether the lot has a serial controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalSerialsForLot":{
            "type":"integer",
            "description":"Total quantity of recalled serials for a lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShelfLifeDays":{
            "title":"Days to Expiration",
            "type":"number",
            "description":"Number of days that indicate the shelf life for the recalled lot.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login associated with the user who most recently updated the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

Information about the serial number details including range and single serials.

Show Source

• Array of: object recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response

{
    "title":"Recall Serial Numbers",
    "type":"array",
    "description":"Information about the serial number details including range and single serials.",
    "items":{
        "$ref":"#/components/schemas/recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response"
    }
}

Nested Schema : recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response

Type: object

Show Source

• 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

  Name of the user who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  User who most recently updated the record.
• 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's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
• SerialEntryMode: string
  Maximum Length: 60

  Default Value: ByRange

  Mode whether to enter an individual serial or a serial in a range.
• SerialId: integer (int64)
  Value that uniquely identifies the recalled serial number.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity 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.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the recall notice line entered by the user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MfgFromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number as specified by the manufacturer in the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialEntryMode":{
            "maxLength":"60",
            "type":"string",
            "description":"Mode whether to enter an individual serial or a serial in a range.",
            "nullable":true,
            "default":"ByRange",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled serial number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MfgToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number as specified by the manufacturer in the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recallNoticesV2-recallLines-recallPartSerialNumbers-item-response

Type: object

Show Source

• 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

  Name of the user who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  User who most recently updated the record.
• 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's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
• SerialEntryMode: string
  Maximum Length: 60

  Default Value: ByRange

  Mode whether to enter an individual serial or a serial in a range.
• SerialId: integer (int64)
  Value that uniquely identifies the recalled serial number.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity 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.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the recall notice line entered by the user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MfgFromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number as specified by the manufacturer in the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialEntryMode":{
            "maxLength":"60",
            "type":"string",
            "description":"Mode whether to enter an individual serial or a serial in a range.",
            "nullable":true,
            "default":"ByRange",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled serial number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MfgToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number as specified by the manufacturer in the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

attachments

Operation: /fscmRestApi/resources/11.13.18.05/recallNoticesV2/{HeaderId}/child/recallLines/{LineId}/child/attachments

Parameters:

• HeaderId: $request.path.HeaderId
• LineId: $request.path.LineId

The attachments resource is used to view, create, and update attachments.

recallLotNumbers

Operation: /fscmRestApi/resources/11.13.18.05/recallNoticesV2/{HeaderId}/child/recallLines/{LineId}/child/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.

recallPartSerialNumbers

Operation: /fscmRestApi/resources/11.13.18.05/recallNoticesV2/{HeaderId}/child/recallLines/{LineId}/child/recallPartSerialNumbers

Parameters:

• HeaderId: $request.path.HeaderId
• LineId: $request.path.LineId

Information about the serial number details including range and single serials.

Back to Top