Get all supplier summary attributes for a negotiation

get

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

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:

    • AllSupplierResponsesFinder: Finds the summary of all supplier responses associated with the specified primary key, AuctionHeaderId.
      Finder Variables:
      • AuctionHeaderId; integer; Value that uniquely identifies the negotiation.
    • AllSupplierResponsesIncludingArchivedFinder: Finds the summary of all supplier responses, including the archived responses associated with the specified primary key, AuctionHeaderId.
      Finder Variables:
      • AuctionHeaderId; integer; Value that uniquely identifies the auction header.
    • PrimaryKey: Finds the summary of all supplier responses associated with the specified primary key, which is the combination of SupplierId, SupplierSiteId, SupplierContactId, and OriginalResponseNumber.
      Finder Variables:
      • OriginalResponseNumber; number; Value that uniquely identifies the original response.
      • SupplierContactId; integer; Value that uniquely identifies the supplier contact.
      • SupplierId; integer; Value that uniquely identifies the supplier.
      • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
  • 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:
    • AuctionHeaderId; integer; Value that uniquely identifies the negotiation.
    • ResponseStatus; string; Status of the response.
    • ResponseStatusCode; string; Abbreviation that identifies the status of the response.
  • 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-suppliersSummaryAttributes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiations-suppliersSummaryAttributes-item-response
Type: object
Show Source
  • 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.
  • Title: Composite Score
    Read Only: true
    Sum of the weighted requirement score and the relative pricing score, calculated based on the total response amount provided by the supplier. The higher the composite score, the better the overall rank.
  • Read Only: true
    Sum of amounts of all the lines in the negotiation.
  • Read Only: true
    Maximum Length: 5
    Contains one of the following values: true or false. If true, the response is either Active or Disqualified; if false, it's not. This attribute has no default value.
  • Read Only: true
    Maximum Length: 6
    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: Last Activity
    Read Only: true
    Maximum Length: 30
    Name of the most recent activity performed by the supplier contact.
  • Title: Last Activity Date
    Read Only: true
    Date and time of the most recent activity performed by the supplier contact.
  • Links
  • Title: Online Status
    Read Only: true
    Maximum Length: 7
    Contains one of the following values: true or false. If true, then the supplier contact is online. If false, then the supplier contact is offline. This attribute doesn't have a default value.
  • Read Only: true
    Value that identifies the first response number in a series of revised responses.
  • Title: Overall Rank Composite
    Read Only: true
    Rank is calculated based on a supplier's composite score; a higher composite score results in a higher overall rank.
  • Title: Overall Rank
    Read Only: true
    Rank of the supplier responses based on the lowest total amount. The lower the transformed amount, the higher the overall rank.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the method used by the application to calculate the overall ranking for supplier responses. Accepted values include RESPONSE_AMOUNT_ONLY, COMPOSITE_SCORE, or NONE, as defined in the lookup type ORA_PON_OVERALL_RANKING_METHOD.
  • Read Only: true
    New score for a given response, replacing the system-computed average score.
  • Read Only: true
    Maximum Length: 9
    Contains one of the following values: true or false. If true, the supplier has submitted a partial response, meaning the supplier hasn't bid on all lines or is offering a lesser quantity than requested in the negotiation line.
  • Title: Response Amount
    Read Only: true
    Total amount calculated for all line items for which the supplier offered a price in response to a negotiation.
  • Title: Response
    Read Only: true
    Maximum Length: 320
    Value that uniquely identifies the response.
  • Read Only: true
    Maximum Length: 20
    Status of the response.
  • Read Only: true
    Maximum Length: 20
    Abbreviation that identifies the status of the response.
  • Title: Response Type
    Read Only: true
    Maximum Length: 80
    Specifies the type of the response as primary or alternate. The list of values is listed in the lookup table TYPE_OF_RESPONSE.
  • Title: Savings
    Read Only: true
    Amount represents the savings for the organization, based on the difference between the supplier's response amount and the current negotiation value.
  • 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 negotiation value.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, the team score has been overridden for a response; if false, the team score hasn't been overridden. The default value is false.
  • 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 employee who represents the supplier in communications with the buying organization.
  • Read Only: true
    Value that identifies the supplier's employee who represents the supplier during communication with the buying organization.
  • Read Only: true
    Maximum Length: 4000
    Indicates the sourcing eligibility for the supplier-purchasing unit association.
  • Read Only: true
    Value that uniquely identifies the supplier invited by the application to respond to 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.
  • Title: Transformed Amount
    Read Only: true
    Sum of the response amount and the internal cost factors applied to a supplier.
  • 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.
Back to Top