Get all response lines

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationResponses/{supplierNegotiationResponsesUniqID}/child/allLines

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Supplier Negotiation Responses resource and used to uniquely identify an instance of Supplier Negotiation Responses. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiation Responses collection resource in order to navigate to a specific instance of Supplier Negotiation Responses to get the hash key.
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 response lines according to the primary key.
      Finder Variables
      • LineId; integer; Value that uniquely identifies lines in a response.
  • 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:
    • AlternateLineFlag; boolean; Contains one of the following values: true or false. If true, then the line is an alternate line. If false, then the line is a regular negotiation line. The default value is false.
    • AlternateLineNumber; number; Alternate line number offered by the supplier as an alternative to negotiation lines by the buyer.
    • AuctionHeaderId; integer; Value that uniquely identifies a negotiation.
    • BestResponsePrice; number; Best price quoted for the line item among all supplier responses.
    • CategoryId; integer; Value that uniquely identifies the purchasing category for the negotiation line.
    • CategoryName; string; The purchasing category for the negotiation line.
    • EstimatedQuantity; integer; Estimated quantity for the negotiation line on the blanket purchase agreement.
    • EstimatedTotalAmount; number; Total amount that the buyer estimates to pay for a fixed price type line item in the negotiation.
    • GroupType; string; 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.
    • Item; string; Name of an inventory item.
    • ItemId; number; Value that uniquely identifies the inventory item.
    • ItemRevision; string; Revision of the inventory item on the negotiation line.
    • Line; string; Number that identifies the negotiation line.
    • LineAmount; number; Amount calculated for a line as price times quantity in a bid submitted to a seller auction.
    • LineCloseDate; string; Date and time when the negotiation line closes in a staggered closing or in a negotiation that can extend.
    • LineDescription; string; Description of the line item.
    • LineFilteringNumber; number; Number that identifies the negotiation line.
    • LinePrice; number; Price of the corresponding line item that will be mentioned on the purchasing document. This is displayed in the transactional currency of the purchasing document.
    • LineTrailingStatus; string; Current status of the line item in terms of response price.
    • Location; string; Name of the location to which the line item can be shipped.
    • Manufacturer; string; Name of the manufacturer.
    • MfgPartNumber; string; Number associated with the primary manufacturer part.
    • NewSupplierItemNumber; string; Note that the supplier enters for the buyer when responding to the negotiation.
    • NoteToBuyer; string; Note that the supplier enters for the buyer when responding to the negotiation.
    • PriceBreakTypeCode; string; Value that identifies the type of price break. It specifies whether the application calculates the price break according to a single purchase order or across all purchase orders for the agreement. Valid values are CUMULATIVE and NONCUMULATIVE. A list of accepted values is defined in the lookup type PON_PRICE_BREAK_TYPE.
    • PromisedDeliveryDate; string; Date on which the supplier has promised to deliver the goods to the buying organization.
    • PromisedShipDate; string; 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.
    • ProxyDecrement; number; The minimum price defined by the supplier, below which the response price won't be reduced automatically in a proxy response from the system.
    • ProxyMinimum; number; Value that identifies the minimum price limit by the supplier below which the response price won't be reduced automatically in a proxy response from the application.
    • Rank; string; Value that identifies the rank of the bidder's response compared to other competing responses for a particular line.
    • RequestedDeliveryDate; string; Date by which delivery of goods is requested from suppliers.
    • RequestedShipDate; string; Date by which shipping of goods is requested from suppliers.
    • ResponseMinimumReleaseAmount; number; Minimum release amount that the supplier quotes when responding to a negotiation with an agreement outcome.
    • ResponseNumber; integer; Value that identifies the supplier response.
    • ResponsePrice; number; Price quoted by the supplier for a line item in the negotiation.
    • ResponseQuantity; number; Quantity proposed by the supplier for the negotiation line.
    • StartPrice; number; Highest price that the buyer allows the supplier to enter in response to a negotiation line.
    • SupplierItem; string; Name of the item in the supplier company.
    • TargetMinimumReleaseAmount; number; Minimum release amount the buyer wishes to receive in response to a negotiation line when responding to a negotiation with an agreement outcome.
    • TargetPrice; number; Price that the procurement organization prefers to pay for the cost factor.
    • TrailPercent; integer; Value that indicates the percentage by which the line item is trailing in pricing.
    • UOM; string; Name of the unit of measure for the item in the negotiation.
    • UOMCode; string; Value that identifies 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 : supplierNegotiationResponses-allLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiationResponses-allLines-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the line is an alternate line. If false, then the line is a regular negotiation line. The default value is false.
  • Title: Alternate Line
    Read Only: true
    Alternate line number offered by the supplier as an alternative to negotiation lines by the buyer.
  • Title: Auction Header ID
    Read Only: true
    Value that uniquely identifies a negotiation.
  • Title: Best Response Price
    Read Only: true
    Best price quoted for the line item among all supplier responses.
  • Title: Category ID
    Read Only: true
    Value that uniquely identifies the purchasing category for the negotiation line.
  • Title: Category Name
    Read Only: true
    Maximum Length: 250
    The purchasing category for the negotiation line.
  • Title: Estimated Quantity
    Read Only: true
    Estimated quantity for the negotiation line on the blanket purchase agreement.
  • Title: Estimated Total Amount
    Read Only: true
    Total amount that the buyer estimates to pay for a fixed price type line item in the negotiation.
  • Title: Group Type Code
    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.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Name of an inventory item.
  • Title: Item ID
    Read Only: true
    Value that uniquely identifies the inventory item.
  • Title: Revision
    Read Only: true
    Maximum Length: 18
    Revision of the inventory item on the negotiation line.
  • Title: Line
    Read Only: true
    Maximum Length: 25
    Number that identifies the negotiation line.
  • Title: Line Amount
    Read Only: true
    Amount calculated for a line as price times quantity in a bid submitted to a seller auction.
  • Title: Close Date
    Read Only: true
    Date and time when the negotiation line closes in a staggered closing or in a negotiation that can extend.
  • Title: Description
    Read Only: true
    Maximum Length: 2500
    Description of the line item.
  • Read Only: true
    Number that identifies the negotiation line.
  • Title: Line ID
    Read Only: true
    Value that identifies the negotiation line.
  • Title: Line Price
    Read Only: true
    Price of the corresponding line item that will be mentioned on the purchasing document. This is displayed in the transactional currency of the purchasing document.
  • Read Only: true
    Maximum Length: 255
    Current status of the line item in terms of response price.
  • Links
  • Title: Location
    Read Only: true
    Maximum Length: 60
    Name of the location to which the line item can be shipped.
  • Title: Manufacturer
    Read Only: true
    Maximum Length: 360
    Name of the manufacturer.
  • Title: Manufacturer Part Number
    Read Only: true
    Maximum Length: 150
    Number associated with the primary manufacturer part.
  • Title: New Supplier Item
    Read Only: true
    Maximum Length: 150
    Note that the supplier enters for the buyer when responding to the negotiation.
  • Title: Note to Buyer
    Read Only: true
    Maximum Length: 4000
    Note that the supplier enters for the buyer when responding to the negotiation.
  • Title: Price Break Type Code
    Read Only: true
    Maximum Length: 25
    Value that identifies the type of price break. It specifies whether the application calculates the price break according to a single purchase order or across all purchase orders for the agreement. Valid values are CUMULATIVE and NONCUMULATIVE. A list of accepted values is defined in the lookup type PON_PRICE_BREAK_TYPE.
  • Title: Promised Delivery 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: Proxy Decrement
    Read Only: true
    The minimum price defined by the supplier, below which the response price won't be reduced automatically in a proxy response from the system.
  • Title: Decrement
    Read Only: true
    Value that identifies the minimum price limit by the supplier below which the response price won't be reduced automatically in a proxy response from the application.
  • Read Only: true
    Maximum Length: 255
    Value that identifies the rank of the bidder's response compared to other competing responses for a particular line.
  • Title: Requested Delivery Date
    Read Only: true
    Date by which delivery of goods is requested from suppliers.
  • Title: Requested Ship Date
    Read Only: true
    Date by which shipping of goods is requested from suppliers.
  • Title: Response Minimum Release Amount
    Read Only: true
    Minimum release amount that the supplier quotes when responding to a negotiation with an agreement outcome.
  • Title: Response Number
    Read Only: true
    Value that identifies the supplier response.
  • Title: Response Price
    Read Only: true
    Price quoted by the supplier for a line item in the negotiation.
  • Supplier Negotiation Response Lines
    Title: Supplier Negotiation Response Lines
    Supplier's response price for a line item in a negotiation response over a specified period is retrieved.
  • Title: Response Quantity
    Read Only: true
    Quantity proposed by the supplier for the negotiation line.
  • Title: Start Price
    Read Only: true
    Highest price that the buyer allows the supplier to enter in response to a negotiation line.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 150
    Name of the item in the supplier company.
  • Title: Target Minimum Release Amount
    Read Only: true
    Minimum release amount the buyer wishes to receive in response to a negotiation line when responding to a negotiation with an agreement outcome.
  • Title: Target Price
    Read Only: true
    Price that the procurement organization prefers to pay for the cost factor.
  • Title: Target Quantity
    Read Only: true
    Quantity proposed by the procurement organization for the negotiation line.
  • Title: Trailing By
    Read Only: true
    Value that indicates the percentage by which the line item is trailing in pricing.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the item in the negotiation.
  • Title: UOM Code
    Read Only: true
    Maximum Length: 3
    Value that identifies the unit of measure for the item in the negotiation.
Nested Schema : Supplier Negotiation Response Lines
Type: array
Title: Supplier Negotiation Response Lines
Supplier's response price for a line item in a negotiation response over a specified period is retrieved.
Show Source
Nested Schema : supplierNegotiationResponses-allLines-responsePricesByTime-item-response
Type: object
Show Source
Back to Top