Get all line responses summary attributes for a negotiation

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lineResponsesSummaryAttributes

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations 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:

    • LinesFinder: Finds the summary of all lines associated with the specified primary key, which is the combination of AuctionHeaderId and LineId
      Finder Variables:
      • LineId; integer; Value that uniquely identifies the negotiation line.
    • PrimaryKey: Finds the summary of all lines associated with the specified primary key, which is the combination of AuctionHeaderId and LineId
      Finder Variables:
      • LineId; integer; 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:
    • LineId; integer; Value that uniquely identifies the negotiation 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 : supplierNegotiations-lineResponsesSummaryAttributes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiations-lineResponsesSummaryAttributes-item-response
Type: object
Show Source
  • Title: Active Responses
    Read Only: true
    Number of active responses for the line.
  • Read Only: true
    Value that uniquely identifies a negotiation.
  • 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.
  • Title: Best Response Score
    Read Only: true
    Total score for the line attributes based on the best response received for the negotiation line, where multi-attribute scoring is enabled.
  • Title: Current Price
    Read Only: true
    Price that the procurement organization is currently paying for the line in the negotiation.
  • Read Only: true
    Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the 'Negotiation Line Type' lookup.
  • Title: Line
    Read Only: true
    Number that identifies the negotiation line.
  • Title: Close Date
    Read Only: true
    Date and time when the negotiation line closes in a staggered closing or in a negotiation that can be extended.
  • Read Only: true
    Maximum Length: 255
    Contains one of the following values: true or false. If true, the line is closed for bidding. If false, the line is open for bidding.
  • Title: Line Description
    Read Only: true
    Description of the negotiation line.
  • Read Only: true
    Converts the values in the Line column from strings to numbers, allowing the column to be sorted and the values to be used in filters.
  • Read Only: true
    Value that uniquely identifies the negotiation line.
  • Line Suppliers Summary Attributes
    Title: Line Suppliers Summary Attributes
    Summary of supplier responses for a line, highlighting the savings and the overall ranking of each supplier.
  • Links
  • Read Only: true
    Number that identifies an existing group or lot as a parent line in a negotiation. It is the value stored in the Line attribute. A Group Line can be added as a child of a Group, and a Lot Line can be added as a child of a Lot.
  • Title: Savings
    Read Only: true
    Amount represents the savings for the organization, based on the difference between the best response amount and the current amount for the line.
  • Title: Savings
    Read Only: true
    Percent represents the percentage savings for the organization, based on the difference between the best response amount and the current amount for the line.
  • Read Only: true
    Maximum Length: 255
    Name of the supplier site with the best transformed price response.
  • Read Only: true
    Maximum Length: 255
    Name of the supplier with the best response price.
  • Read Only: true
    Maximum Length: 255
    Name of the supplier with the best transformed price response.
  • Read Only: true
    Number of the response with the best transformed price.
  • Title: Best Transformed Price
    Read Only: true
    Price of the response with the best transformed price.
Nested Schema : Line Suppliers Summary Attributes
Type: array
Title: Line Suppliers Summary Attributes
Summary of supplier responses for a line, highlighting the savings and the overall ranking of each supplier.
Show Source
Nested Schema : supplierNegotiations-lineResponsesSummaryAttributes-lineSuppliersSummaryAttributes-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 has an alternate line. If false, then the line doesn't have an alternate line. The default value is false.
  • Read Only: true
    Value that uniquely identifies the negotiation.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the purchasing relationship of the supplier's enterprise. Accepted values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED, as defined in the lookup type ORA_POZ_purchasing_RELATIONSHIP.
  • Read Only: true
    Maximum Length: 8
    Contains one of the following values: true or false. If true, then the supplier is locked. If false, then supplier isn't locked. The default value is false.
  • Title: Rank
    Read Only: true
    Maximum Length: 40
    Abbreviation that identifies the rank value for the line item based on the response price. Values include BEST or TRAILING.
  • Read Only: true
    Value that uniquely identifies the negotiation line.
  • Links
  • Read Only: true
    Value that identifies the first response number in a series of revised responses.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, the supplier has submitted a partial response, meaning the supplier is offering a lesser quantity than requested in the negotiation line.
  • 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: Rank
    Read Only: true
    Value that identifies the rank of the supplier's response compared to other competing responses for a line.
  • Title: Response Line Amount
    Read Only: true
    Total amount of a line item for which the supplier offered a price in the response to a negotiation.
  • Title: Response
    Read Only: true
    Maximum Length: 320
    Value that uniquely identifies the supplier response.
  • Title: Response Price
    Read Only: true
    Price quoted by the supplier for a line item in the negotiation.
  • Title: Response Quantity
    Read Only: true
    Quantity proposed by the supplier for the negotiation line.
  • Title: Response Score
    Read Only: true
    Value that identifies the score assigned to a supplier's response for a line group, attribute group, or line attribute.
  • Read Only: true
    Maximum Length: 320
    Status of the response.
  • Title: Status
    Read Only: true
    Maximum Length: 100
    Abbreviation that identifies the status of the response.
  • Title: Savings
    Read Only: true
    Percent represents the savings for the organization, calculated based on the difference between the supplier's response amount and the current value of the negotiation line.
  • Read Only: true
    Maximum Length: 30
    Status code of the supplier's spend authorization review. Accepted values include PENDING_APPROVAL and REJECTED.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier invited by the application to respond to the negotiation.
  • Read Only: true
    Maximum Length: 360
    Name of the supplier's employee who represents the supplier in communication with the buying organization.
  • Read Only: true
    Value that identifies the supplier employee who represents the supplier during communication with the buying organization.
  • Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the supplier's sourcing eligibility status. Possible values include ALLOWED, NOT_ALLOWED, and WARNING. A list of accepted values is defined in the lookup type ORA_POQ_SOURCING_ELIGIBILITY.
  • Read Only: true
    Value that uniquely identifies the supplier invited by the application to participate in the negotiation.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 240
    Name of the supplier site.
  • Read Only: true
    Value that uniquely identifies the supplier site.
  • Title: Time of Response
    Read Only: true
    Date and time when the response was submitted for the negotiation.
  • Read Only: true
    Maximum Length: 8
    Abbreviation that identifies the rank value for the line item based on the transformed response price. Values include BEST or TRAILING.
  • Read Only: true
    Value that identifies the rank of the supplier's response compared to other competing responses for a line based on the transformed price.
  • Read Only: true
    Sum of the response amount and the internal cost factors applied to a supplier.
  • Read Only: true
    Sum of the response price and the internal cost factors applied to a supplier.
  • Title: Unit Price Savings
    Read Only: true
    Amount represents the savings for the organization, based on the difference between the supplier's response price and the current price of the negotiation line.
  • Title: Variance from Prior Response
    Read Only: true
    Amount represents the difference between the submitted amount in the current response and the supplier's most recent previous response for a negotiation line.
Back to Top