Get all lines

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/child/lines

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 negotiation line according to the primary key.
      Finder Variables
      • LineId; number; Value that uniquely identifies the negotiation 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:
    • ActiveResponses; number; Number of active responses for the line.
    • AwardDate; string; Date on which the negotiation was awarded.
    • AwardStatusCode; string; Value that identifies whether the response was awarded or rejected.
    • AwardedQuantity; number; Total quantity awarded for auction.
    • BestResponseNumber; number; Number of the best response for the negotiation line among all responses.
    • BestResponsePrice; number; Price of the best response for the negotiation line among all responses.
    • BestResponseScore; number; Total score for the line attributes based on the best response received for the negotiation line, where multiple attribute scoring is enabled.
    • BidRankingCode; string; Abbreviation that identifies the rank for the line item in a negotiation based on the response price.
    • CategoryName; string; The purchasing category for the negotiation line.
    • CurrencyCode; string; Value that identifies the code of the currency used by buyer organization.
    • CurrentPrice; number; Price that the procurement organization is currently paying for the line in the negotiation.
    • DisplayAwardPriceFlag; boolean; Contains one of the following values: true or false. If true, the award price is displayed. If false, the award price isn't displayed.
    • GroupTypeCode; string; Abbreviation that identifies the type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type Negotiation Line Type.
    • IsRFIFlag; boolean; Value that identifies the code of the currency used by buyer organization.
    • IsStageTwoUnlockedFlag; boolean; Value that identifies the code of the currency used by buyer organization.
    • Item; string; Name of the inventory item that the buyer intends to purchase.
    • ItemRevision; string; Revision of the inventory item on the negotiation line.
    • Line; string; Line number of the negotiation line.
    • LineDescription; string; Description of the negotiation line.
    • LineId; number; Unique identifier of the negotiation line.
    • LineType; string; Name of the line type that indicates whether the line is for items or services. A list of accepted values is defined in the lookup code ORDER_TYPE_LOOKUP_CODE, with values including Fixed Price and Quantity. To review and update the value for this attribute, use the Setup and Maintenance work area and the Manage Purchasing Line Types task.
    • LineTypeCode; string; Abbreviation that specifies the line type in a negotiation. Valid values are QUANTITY and FIXED PRICE for Goods, and FIXED PRICE for Services line types.
    • NoAwardFlag; boolean; Contains one of the following values: true or false. If true, then the negotiation line is marked as no award. If false, then the negotiation line is awarded.
    • NoteToAcceptedSuppliers; string; Unique identifier of the negotiation line.
    • NoteToRejectedSuppliers; string; Unique identifier of the negotiation line.
    • NumberOfAlternateLines; number; Unique identifier of the negotiation line.
    • NumberOfAwardedAlternateLines; number; Number of alternate lines that are awarded.
    • NumberOfAwardedResponses; number; Unique identifier of the negotiation line.
    • ParentLineNumber; number; Value that uniquely identifies the parent line.
    • RemainingQuantity; number; Quantity remaining after awarding a negotiation line.
    • Requisition; string; Requisition number that the negotiation line references.
    • RequisitionHeaderId; number; Value that uniquely identifies a requisition.
    • RequisitionLine; string; Requisition line number that the negotiation line references.
    • RequisitioningBU; string; Name of the requisition purchasing unit that the application uses to set default values for each negotiation line.
    • RequisitioningBUId; integer; Value that uniquely identifies the requisition purchasing unit.
    • SavingsInAmount; number; Value that identifies the amount of savings generated by awarding the lines to one or more supplier responses.
    • SavingsInPercent; number; Value that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation.
    • ShortlistedResponses; number; Number of shortlisted responses for a negotiation line.
    • TargetQuantity; number; Quantity proposed by the procurement organization for the negotiation line.
    • TotalAwardAmount; number; Quantity proposed by the procurement organization for the negotiation line.
    • TransformedBestResponseNumber; number; Number of the response with the best transformed price.
    • TransformedBestResponsePrice; number; Price of the response with the best transformed price.
    • UOM; string; Name of the unit of measure for the item in the 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 : supplierNegotiationAwards-lines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiationAwards-lines-item-response
Type: object
Show Source
  • Read Only: true
    Number of active responses for the line.
  • Read Only: true
    Date on which the negotiation was awarded.
  • Read Only: true
    Total quantity awarded for auction.
  • Awarded Response Details
    Title: Awarded Response Details
    Details of the awarded responses for a negotiation line.
  • Title: Award Status
    Read Only: true
    Maximum Length: 25
    Value that identifies whether the response was awarded or rejected.
  • Title: Best Response
    Read Only: true
    Number of the best response for the negotiation line among all responses.
  • Title: Best Response Price
    Read Only: true
    Price of the best response for the negotiation line among all responses.
  • Read Only: true
    Total score for the line attributes based on the best response received for the negotiation line, where multiple attribute scoring is enabled.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the rank for the line item in a negotiation based on the response price.
  • Title: Category Name
    Read Only: true
    Maximum Length: 250
    The purchasing category for the negotiation line.
  • Read Only: true
    Maximum Length: 15
    Value that identifies the code of the currency used by buyer organization.
  • Title: Current Price
    Read Only: true
    Price that the procurement organization is currently paying for the line in the negotiation.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, the award price is displayed. If false, the award price isn't displayed.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type Negotiation Line Type.
  • Read Only: true
    Maximum Length: 1
    Value that identifies the code of the currency used by buyer organization.
  • Read Only: true
    Maximum Length: 1
    Value that identifies the code of the currency used by buyer organization.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Name of the inventory item that the buyer intends to purchase.
  • Title: Revision
    Read Only: true
    Maximum Length: 18
    Revision of the inventory item on the negotiation line.
  • Read Only: true
    Maximum Length: 25
    Line number of the negotiation line.
  • Title: Line Description
    Read Only: true
    Maximum Length: 2500
    Description of the negotiation line.
  • Read Only: true
    Unique identifier of the negotiation line.
  • Title: Line Type
    Read Only: true
    Maximum Length: 30
    Name of the line type that indicates whether the line is for items or services. A list of accepted values is defined in the lookup code ORDER_TYPE_LOOKUP_CODE, with values including Fixed Price and Quantity. To review and update the value for this attribute, use the Setup and Maintenance work area and the Manage Purchasing Line Types task.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that specifies the line type in a negotiation. Valid values are QUANTITY and FIXED PRICE for Goods, and FIXED PRICE for Services line types.
  • Links
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the negotiation line is marked as no award. If false, then the negotiation line is awarded.
  • Read Only: true
    Maximum Length: 255
    Unique identifier of the negotiation line.
  • Read Only: true
    Maximum Length: 255
    Unique identifier of the negotiation line.
  • Read Only: true
    Unique identifier of the negotiation line.
  • Read Only: true
    Number of alternate lines that are awarded.
  • Title: Awarded Responses
    Read Only: true
    Unique identifier of the negotiation line.
  • Read Only: true
    Value that uniquely identifies the parent line.
  • Title: Remaining Quantity
    Read Only: true
    Quantity remaining after awarding a negotiation line.
  • Read Only: true
    Maximum Length: 64
    Requisition number that the negotiation line references.
  • Read Only: true
    Value that uniquely identifies a requisition.
  • Title: Requisitioning BU
    Read Only: true
    Maximum Length: 240
    Name of the requisition purchasing unit that the application uses to set default values for each negotiation line.
  • Read Only: true
    Value that uniquely identifies the requisition purchasing unit.
  • Title: Requisition Line
    Read Only: true
    Maximum Length: 40
    Requisition line number that the negotiation line references.
  • All Bids
    Title: All Bids
    Lines that have been awarded in a supplier negotiation.
  • Read Only: true
    Value that identifies the amount of savings generated by awarding the lines to one or more supplier responses.
  • Read Only: true
    Value that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation.
  • Title: Shortlisted Responses
    Read Only: true
    Number of shortlisted responses for a negotiation line.
  • Title: Target Quantity
    Read Only: true
    Quantity proposed by the procurement organization for the negotiation line.
  • Title: Award
    Read Only: true
    Quantity proposed by the procurement organization for the negotiation line.
  • Read Only: true
    Number of the response with the best transformed price.
  • Read Only: true
    Price of the response with the best transformed price.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the item in the negotiation.
Nested Schema : Awarded Response Details
Type: array
Title: Awarded Response Details
Details of the awarded responses for a negotiation line.
Show Source
Nested Schema : All Bids
Type: array
Title: All Bids
Lines that have been awarded in a supplier negotiation.
Show Source
Nested Schema : supplierNegotiationAwards-lines-awardedResponseDetails-item-response
Type: object
Show Source
  • Title: Alternate Line Description
    Read Only: true
    Maximum Length: 2500
    Description of an alternate line.
  • Read Only: true
    Value that uniquely identifies the negotiation.
  • Title: Award Amount
    Read Only: true
    Amount awarded to a supplier response line.
  • Read Only: true
    Total quantity awarded for auction.
  • Title: Award Price
    Read Only: true
    Final price of the awarded line items.
  • Read Only: true
    Maximum Length: 25
    Value that identifies whether the response was awarded or rejected.
  • Read Only: true
    Number of the best response for the negotiation line among all responses.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the business relationship of the supplier's enterprise. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP.
  • Read Only: true
    Maximum Length: 15
    Value that identifies the code of the currency used by buyer organization.
  • Read Only: true
    Maximum Length: 25
    Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.
  • Read Only: true
    Maximum Length: 25
    Line number of the negotiation line.
  • Read Only: true
    Unique identifier of the negotiation line.
  • Links
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the supplier has submitted a partial response. A partial response means the supplier hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line.
  • Read Only: true
    All Bids
  • Title: Promised Date
    Read Only: true
    Date on which the supplier has promised to deliver the goods to the buying organization.
  • Title: Promised Ship Date
    Read Only: true
    Date on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms.
  • Title: Purchasing Document Amount
    Read Only: true
    The total amount of the line item based on the awarded quantity.
  • Title: Purchasing Document Price
    Read Only: true
    Price of the line item based on the award quantity.
  • Title: Quantity
    Read Only: true
    Quantity of the item in the negotiation.
  • Title: Rank
    Read Only: true
    Maximum Length: 255
    The rank value displayed for the line item based on the response price.
  • Read Only: true
    Total amount calculated for all line items that the supplier offered a price for when responding to a negotiation.
  • Read Only: true
    Value that uniquely identifies the response.
  • Read Only: true
    Maximum Length: 25
    Value that uniquely identifies the response status.
  • Title: Savings
    Read Only: true
    Value that identifies the amount of savings generated by awarding the lines to one or more supplier responses.
  • Title: Savings
    Read Only: true
    Value that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation.
  • Read Only: true
    Maximum Length: 30
    Status code of the supplier's spend authorization review. Accepted values include PENDING_APPROVAL and REJECTED.
  • Read Only: true
    Maximum Length: 360
    Name of the supplier who responds to the negotiation.
  • Title: Supplier Contact
    Read Only: true
    Maximum Length: 255
    Name of the supplier contact at the supplier that responds to the negotiation.
  • Read Only: true
    Value that identifies the contact of the supplier who responds to the negotiation.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Read Only: true
    Maximum Length: 240
    Name of the supplier site.
  • Read Only: true
    Value that identifies the supplier site.
  • Read Only: true
    Maximum Length: 30
    Value that identifies the technical evaluation completion status.
  • Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the item in the negotiation.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure for the item in the negotiation.
  • Read Only: true
    Value that uniquely identifies the bidder.
Nested Schema : supplierNegotiationAwards-lines-responsesLines-item-response
Type: object
Show Source
Back to Top