Jump to

• Request
• Response

Get one line

get

/fscmRestApi/resources/11.13.18.05/recallNotices/{HeaderId}/child/recallLines/{LineId}

Request

Path Parameters

• HeaderId(required): integer(int64)
  Value that uniquely identifies the recall notice header.
• LineId(required): integer(int64)
  Value that uniquely identifies the recall notice line.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to 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 : recallNotices-recallLines-item-response

Type: object

Show Source

• AttachmentEntityName: string
  Default Value: RECALL_NOTICE_LINE

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

  The Attachments resource manages the attachments for the recall notice line.
• BpaManufacturerPartLineId: integer (int64)
  Value that uniquely identifies the blanket purchase order line defined in the recall line.
• BrandName: string
  Title: Brand Name

  Maximum Length: 60

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

  Maximum Length: 255

  Translatable name of the item category.
• Comments: string
  Maximum Length: 2000

  Comments on withdrawal of a recall line.
• ControlType: string
  Read Only: true

  Maximum Length: 255

  Value that identifies whether the line is lot, serial, or lot and serial controlled.
• CountQuantity: number
  Title: Count Quantity

  Read Only: true

  Count of the recalled item quantities for a given line.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• DisposedQuantity: number
  Read Only: true

  Quantity of recalled items disposed for a given line.
• ExpectedQuantity: number
  Title: Estimated Quantity

  Read Only: true

  Quantity of recalled items expected in the PAR, EXPENSE, and IN_STOCK status for a given line.
• ExpenseCountedQuantity: number
  Read Only: true

  Count of the recalled item quantities in the EXPENSE status for a given line.
• ExpenseExpectedQuantity: number
  Read Only: true

  Quantity of recalled items expected in the EXPENSE status for a given line.
• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• InBoundEstimatedQuantity: number
  Read Only: true

  Quantity of recalled items expected in the IN BOUND status for a given line.
• InboundQuantity: number
  Title: Inbound Quantity

  Read Only: true

  Quantity of recalled items in the INBOUND status for a given line.
• InStockCountedQuantity: number
  Read Only: true

  Count of the recalled item quantities in the IN STOCK status for a given line.
• InStockEstimatedQuantity: number
  Read Only: true

  Quantity of recalled items expected in the IN STOCK status for a given line.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemCategoryId: string
  Maximum Length: 255

  Value that uniquely identifies the purchasing item category.
• ItemDescription: string
  Maximum Length: 255

  Description of the item as a statement, picture description, or an account description.
• ItemNumber: string
  Title: Item

  Maximum Length: 300

  Number that identifies the item.
• ItemValidationOrgId: integer (int64)
  Value that uniquely identifies the item validation organization.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the record.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LineNumber: integer (int64)
  Title: Line

  Number that identifies the recall notice line entered by the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerPartId: integer (int64)
  Title: Manufacturer Part

  Value that uniquely identifies the trading partner item.
• ManufacturerPartNumber: string
  Title: Manufacturer Part Number

  Maximum Length: 700

  Number that identifies the manufacturer part.
• ModelName: string
  Title: Model Name

  Maximum Length: 60

  Model name of the recalled product.
• NdcCode: string
  Title: National Drug Code

  Maximum Length: 60

  Abbreviation that identifies the national drug for the recalled part.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OriginalLineId: integer (int64)
  Value that uniquely identifies the original recall notice line that gets updated for a recall notice line marked as duplicate.
• ParCountedQuanity: number
  Read Only: true

  Count of the recalled item quantities in the PAR status for a given line.
• ParExpectedQuantity: number
  Read Only: true

  Quantity of recalled items expected in the PAR status for a given line.
• PrimaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Primary unit of measure for the recalled part.
• ProductType: string
  Title: Product Type

  Maximum Length: 600

  Type of product of the manufactured part.
• RecallClosingDate: string (date-time)
  Title: Expected Closure Date

  Date when the expected recall notice closes.
• RecallLineStatus: string
  Title: Status

  Maximum Length: 80

  Status of recall notice line.
• RecallLineStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the status of recall line. It identifies the code for FND_LOOKUP.
• recallLotNumbers: array Recall Lot Numbers
  Title: Recall Lot Numbers

  The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.
• recallSerialNumbers: array Recall Serial Numbers
  Title: Recall Serial Numbers

  The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.
• SerialEntryMode: string
  Read Only: true

  Maximum Length: 255

  Value that identifies whether the line has a serial controlled item.
• TasksCompleted: integer
  Read Only: true

  Value that identifies the percentage of tasks in completed and withdrawn status to the total number of tasks for a recall line.
• TotalNumberOfAttachments: integer
  Read Only: true

  Total number of attachments for a line.
• TotalNumberOfLots: integer
  Read Only: true

  Total number of lots for a line.

{
    "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
        },
        "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":"Text 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"
            }
        },
        "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
        },
        "DisposedQuantity":{
            "type":"number",
            "description":"Quantity of recalled items disposed for a given line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":"600",
            "type":"string",
            "description":"Type of product of the manufactured part.",
            "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":"Login that the user used when updating the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments for the recall notice line.",
            "items":{
                "$ref":"#/components/schemas/recallNotices-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
        },
        "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":"Total number of attachments for a line.",
            "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
        },
        "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
        },
        "recallSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.",
            "items":{
                "$ref":"#/components/schemas/recallNotices-recallLines-recallSerialNumbers-item-response"
            }
        },
        "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":"Quantity of recalled items expected in the PAR status for a given line.",
            "nullable":true,
            "readOnly":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":"Primary unit of measure for the recalled part.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "recallLotNumbers":{
            "title":"Recall Lot Numbers",
            "type":"array",
            "description":"The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.",
            "items":{
                "$ref":"#/components/schemas/recallNotices-recallLines-recallLotNumbers-item-response"
            }
        },
        "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":"Translatable name of the item category.",
            "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":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
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments for the recall notice line.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments for the recall notice line.",
    "items":{
        "$ref":"#/components/schemas/recallNotices-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

The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.

Show Source

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

{
    "title":"Recall Lot Numbers",
    "type":"array",
    "description":"The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.",
    "items":{
        "$ref":"#/components/schemas/recallNotices-recallLines-recallLotNumbers-item-response"
    }
}

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.

Show Source

• Array of: object recallNotices-recallLines-recallSerialNumbers-item-response

{
    "title":"Recall Serial Numbers",
    "type":"array",
    "description":"The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.",
    "items":{
        "$ref":"#/components/schemas/recallNotices-recallLines-recallSerialNumbers-item-response"
    }
}

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

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment of a work order. It is a primary key that the application generates when a document is attached to the work order.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false. This attribute is not currently used.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique document identification of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the current version of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the document that is attached to the work order.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who most recently updated the document that is attached to the work order.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document that is attached to the work order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"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":"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":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique document identification of the attachment.",
            "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":"Value that uniquely identifies the attachment of a work order. It is a primary key that the application generates when a document is attached to the work order.",
            "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":"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":"Login that the user used when creating the attachment.",
            "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":"Length 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":"Number that identifies the current version of the attachment.",
            "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":"Login of the user who most recently updated the document that is attached to the work order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of 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":"Login that the user used when adding or modifying 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":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies 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":"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":"Login that the user used when updating the document that is attached to the work order.",
            "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":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies 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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"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":"Date and time when the user most recently updated the document that is attached to the work order.",
            "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":"An identifier used for tracking the uploaded 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 : recallNotices-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

  Login that the user used when updating the document.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  Number that identifies the recall notice line entered by the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgDate: string (date-time)
  Title: Manufacturing Date

  Date when the recalled lot is manufactured.
• MfgLotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Number that identifies the manufacturer lot of the recalled part.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• recallLotSerialNumbers: array Recall Lot Serial Numbers
  Title: Recall Lot Serial Numbers

  The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.
• SerialEntryMode: string
  Read Only: true

  Maximum Length: 255

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

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

{
    "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 Lot Serial Numbers",
            "type":"array",
            "description":"The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.",
            "items":{
                "$ref":"#/components/schemas/recallNotices-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"
            }
        },
        "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":"Login that the user used when updating 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 Lot Serial Numbers

Type: array

Title: Recall Lot Serial Numbers

The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.

Show Source

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

{
    "title":"Recall Lot Serial Numbers",
    "type":"array",
    "description":"The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.",
    "items":{
        "$ref":"#/components/schemas/recallNotices-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response"
    }
}

Nested Schema : recallNotices-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

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  Number that identifies the recall notice line entered by the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgFromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

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

  Maximum Length: 80

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

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

  Default Value: ByRange

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

{
    "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
        },
        "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 is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber.",
            "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 or not to enter an individual serial or a serial in 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":"Login that the user used when updating 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 : recallNotices-recallLines-recallSerialNumbers-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

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  Number that identifies the recall notice line entered by the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgFromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

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

  Maximum Length: 80

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

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

  Default Value: ByRange

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

{
    "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
        },
        "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 is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber.",
            "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 or not to enter an individual serial or a serial in 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":"Login that the user used when updating 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"
    }
}

Links

attachments

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

Parameters:

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

The Attachments resource manages the attachments for the recall notice line.

recallLotNumbers

Operation: /fscmRestApi/resources/11.13.18.05/recallNotices/{HeaderId}/child/recallLines/{LineId}/child/recallLotNumbers

Parameters:

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

The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.

recallSerialNumbers

Operation: /fscmRestApi/resources/11.13.18.05/recallNotices/{HeaderId}/child/recallLines/{LineId}/child/recallSerialNumbers

Parameters:

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

The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.

Back to Top