Get all lines

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find recall lines according to the line identifier.
      Finder Variables:
      • LineId; integer; Value that uniquely identifies the recall notice line.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AttachmentEntityName; string; Name of the attachment entity.
    • BpaManufacturerPartLineId; integer; Value that uniquely identifies the blanket purchase order line defined in the recall line.
    • BrandName; string; Text that indicates the brand name for the recalled product.
    • CategoryName; string; Translatable name of the item category.
    • Comments; string; Comments on withdrawal of a recall line.
    • ControlType; string; Value that identifies whether the line is lot, serial, or lot and serial controlled.
    • CountQuantity; number; Count of the recalled item quantities for a given line.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DisposedQuantity; number; Quantity of recalled items disposed for a given line.
    • ExpectedQuantity; number; Quantity of recalled items expected in the PAR, EXPENSE, and IN_STOCK status for a given line.
    • ExpenseCountedQuantity; number; Count of the recalled item quantities in the EXPENSE status for a given line.
    • ExpenseExpectedQuantity; number; Quantity of recalled items expected in the EXPENSE status for a given line.
    • HeaderId; integer; Value that uniquely identifies the recall notice header.
    • InBoundEstimatedQuantity; number; Quantity of recalled items expected in the IN BOUND status for a given line.
    • InStockCountedQuantity; number; Count of the recalled item quantities in the IN STOCK status for a given line.
    • InStockEstimatedQuantity; number; Quantity of recalled items expected in the IN STOCK status for a given line.
    • InboundQuantity; number; Quantity of recalled items in the INBOUND status for a given line.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemCategoryId; string; Value that uniquely identifies the purchasing item category.
    • ItemDescription; string; Description of the item as a statement, picture description, or an account description.
    • ItemNumber; string; Number that identifies the item.
    • ItemValidationOrgId; integer; Value that uniquely identifies the item validation organization.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdateLogin; string; Login that the user used when updating the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • LineId; integer; Value that uniquely identifies the recall notice line.
    • LineNumber; integer; Number that identifies the recall notice line entered by the user.
    • ManufacturerPartId; integer; Value that uniquely identifies the trading partner item.
    • ManufacturerPartNumber; string; Number that identifies the manufacturer part.
    • ModelName; string; Model name of the recalled product.
    • NdcCode; string; Abbreviation that identifies the national drug for the recalled part.
    • ObjectVersionNumber; integer; 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; Value that uniquely identifies the original recall notice line that gets updated for a recall notice line marked as duplicate.
    • ParCountedQuanity; number; Count of the recalled item quantities in the PAR status for a given line.
    • ParExpectedQuantity; number; Quantity of recalled items expected in the PAR status for a given line.
    • PrimaryUnitOfMeasure; string; Primary unit of measure for the recalled part.
    • ProductType; string; Type of product of the manufactured part.
    • RecallClosingDate; string; Date when the expected recall notice closes.
    • RecallLineStatus; string; Status of recall notice line.
    • RecallLineStatusCode; string; Abbreviation that identifies the status of recall line. It identifies the code for FND_LOOKUP.
    • SerialEntryMode; string; Value that identifies whether the line has a serial controlled item.
    • TasksCompleted; integer; Value that identifies the percentage of tasks in completed and withdrawn status to the total number of tasks for a recall line.
    • TotalNumberOfAttachments; integer; Total number of attachments for a line.
    • TotalNumberOfLots; integer; Total number of lots for a line.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recallNotices-recallLines-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments for the recall notice line.
Show Source
Nested Schema : Recall Lot Numbers
Type: array
Title: Recall Lot Numbers
The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.
Show Source
Nested Schema : Recall Serial Numbers
Type: array
Title: Recall Serial Numbers
The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.
Show Source
Nested Schema : recallNotices-recallLines-attachments-item-response
Type: object
Show Source
Nested Schema : recallNotices-recallLines-recallLotNumbers-item-response
Type: object
Show Source
Nested Schema : Recall Lot Serial Numbers
Type: array
Title: Recall Lot Serial Numbers
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.
Show Source
Nested Schema : recallNotices-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response
Type: object
Show Source
Nested Schema : recallNotices-recallLines-recallSerialNumbers-item-response
Type: object
Show Source
Back to Top