1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Negotiation Purchasing Documents
  4. Line Allocations Summary

Get line allocation summary data for multiple lines

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationPurchasingDocuments/{AuctionHeaderId}/child/lineAllocationsSummary

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • 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 Finds the line allocation summary data according to the primary key.
      Finder Variables
      • AuctionHeaderId; integer; Value that finds line allocation summary data using the Auction Header ID as the primary key.
      • LineNumber; number; Value that finds line allocation summary data using the Awarded Line as the primary key.
  • 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:
    • AllocatedAwardQuantity; number; Award quantity allocated to requisition demand.
    • AlternateLinesPresentFlag; boolean; Contains one of the following values: true or false. If true, then the line has an alternate line. If false, then the line doesn't have an alternate line. The default value is false.
    • AuctionHeaderId; integer; Value that uniquely identifies a negotiation.
    • AwardQuantity; number; Total quantity of line items awarded in a supplier negotiation.
    • AwardedLine; number; Get one negotiation detail
    • BuyerManagedTransportationFlag; boolean; Value that indicates whether the buying company is responsible for arranging transportation.
    • Category; string; Name of the purchasing category.
    • Item; string; Name of an inventory item.
    • ItemDescription; string; Item description associated to the purchase order line.
    • LineNumber; number; Identifier of the negotiation response line.
    • NegotiationQuantity; number; Identifies the quantity of the line items.
    • OrderTypeLookupCode; string; Abbreviation that identifies the line type basis. Values include QUANTITY, FIXED PRICE.
    • PODoctypeCode; string; Abbreviation that identifies the type of purchasing document. Values include: STANDARD, BLANKET, or CONTRACT.
    • PartiallyAllocatedAwardedLinesFlag; boolean; Indicates whether an awarded line is partially allocated.
    • Requisition; string; Requisition number that the negotiation line references.
    • RequisitionBusinessUnit; string; Name of the requisition purchasing unit that the application uses to set default values for each negotiation line.
    • RequisitionLine; string; Requisition line number that the negotiation line references.
    • RequisitionQuantity; number; Quantity of the requisition line items.
    • ResponseNumber; string; Unique identifier of the supplier response in a supplier negotiation.
    • Supplier; string; Name of the supplier company that the application invited to response to the negotiation.
    • UnallocatedAwardQuantity; number; Portion of the awarded quantity that hasn't been allocated to any requisition line.
    • UnallocatedAwardedLinesFlag; boolean; Indicates whether an awarded line is unallocated.
    • UnfulfilledRequisitionQuantity; number; Unfulfilled Requisition Quantity
    • UnitOfMeasure; string; Measurement unit for a line item in a supplier negotiation.
  • 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 : supplierNegotiationPurchasingDocuments-lineAllocationsSummary
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiationPurchasingDocuments-lineAllocationsSummary-item-response
Type: object
Show Source
Nested Schema : Awarded Line Supplier Responses
Type: array
Title: Awarded Line Supplier Responses
Details of the supplier responses awarded for a negotiation line.
Show Source
Nested Schema : Line Allocations by Supplier Response
Type: array
Title: Line Allocations by Supplier Response
Summary of the award quantity allocation for a negotiation line by responses.
Show Source
Nested Schema : supplierNegotiationPurchasingDocuments-lineAllocationsSummary-awardedLineResponses-item-response
Type: object
Show Source
Nested Schema : supplierNegotiationPurchasingDocuments-lineAllocationsSummary-lineAllocationsByResponse-item-response
Type: object
Show Source
Back to Top