Get one line
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/child/lines/{LineId}
Request
Path Parameters
-
AuctionHeaderId(required): integer(int64)
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=
-
LineId(required): number
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
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
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".
-
REST-Framework-Version: string
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : supplierNegotiationAwards-lines-item-response
Type:
Show Source
object-
ActiveResponses: number
Read Only:
trueNumber of active responses for the line. -
AwardDate: string
(date)
Read Only:
trueDate on which the negotiation was awarded. -
AwardedQuantity: number
Read Only:
trueTotal quantity awarded for auction. -
awardedResponseDetails: array
Awarded Response Details
Title:
Awarded Response DetailsDetails of the awarded responses for a negotiation line. -
AwardStatusCode: string
Title:
Award StatusRead Only:trueMaximum Length:25Value that identifies whether the response was awarded or rejected. -
BestResponseNumber: number
Title:
Best ResponseRead Only:trueNumber of the best response for the negotiation line among all responses. -
BestResponsePrice: number
Title:
Best Response PriceRead Only:truePrice of the best response for the negotiation line among all responses. -
BestResponseScore: number
Read Only:
trueTotal score for the line attributes based on the best response received for the negotiation line, where multiple attribute scoring is enabled. -
BidRankingCode: string
Read Only:
trueMaximum Length:25Abbreviation that identifies the rank for the line item in a negotiation based on the response price. -
CategoryName: string
Title:
Category NameRead Only:trueMaximum Length:250The purchasing category for the negotiation line. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Value that identifies the code of the currency used by buyer organization. -
CurrentPrice: number
Title:
Current PriceRead Only:truePrice that the procurement organization is currently paying for the line in the negotiation. -
DisplayAwardPriceFlag: boolean
Read Only:
trueMaximum Length:1Contains 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
Read Only:
trueMaximum Length:25Abbreviation 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
Read Only:
trueMaximum Length:1Value that identifies the code of the currency used by buyer organization. -
IsStageTwoUnlockedFlag: boolean
Read Only:
trueMaximum Length:1Value that identifies the code of the currency used by buyer organization. -
Item: string
Title:
ItemRead Only:trueMaximum Length:300Name of the inventory item that the buyer intends to purchase. -
ItemRevision: string
Title:
RevisionRead Only:trueMaximum Length:18Revision of the inventory item on the negotiation line. -
Line: string
Read Only:
trueMaximum Length:25Line number of the negotiation line. -
LineDescription: string
Title:
Line DescriptionRead Only:trueMaximum Length:2500Description of the negotiation line. -
LineId: number
Read Only:
trueUnique identifier of the negotiation line. -
LineType: string
Title:
Line TypeRead Only:trueMaximum Length:30Name 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
Read Only:
trueMaximum Length:25Abbreviation 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: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoAwardFlag: boolean
Read Only:
trueMaximum Length:1Contains 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
Read Only:
trueMaximum Length:255Unique identifier of the negotiation line. -
NoteToRejectedSuppliers: string
Read Only:
trueMaximum Length:255Unique identifier of the negotiation line. -
NumberOfAlternateLines: number
Read Only:
trueUnique identifier of the negotiation line. -
NumberOfAwardedAlternateLines: number
Read Only:
trueNumber of alternate lines that are awarded. -
NumberOfAwardedResponses: number
Title:
Awarded ResponsesRead Only:trueUnique identifier of the negotiation line. -
ParentLineNumber: number
Read Only:
trueValue that uniquely identifies the parent line. -
RemainingQuantity: number
Title:
Remaining QuantityRead Only:trueQuantity remaining after awarding a negotiation line. -
Requisition: string
Read Only:
trueMaximum Length:64Requisition number that the negotiation line references. -
RequisitionHeaderId: number
Read Only:
trueValue that uniquely identifies a requisition. -
RequisitioningBU: string
Title:
Requisitioning BURead Only:trueMaximum Length:240Name of the requisition purchasing unit that the application uses to set default values for each negotiation line. -
RequisitioningBUId: integer
(int64)
Read Only:
trueValue that uniquely identifies the requisition purchasing unit. -
RequisitionLine: string
Title:
Requisition LineRead Only:trueMaximum Length:40Requisition line number that the negotiation line references. -
responsesLines: array
All Bids
Title:
All BidsLines that have been awarded in a supplier negotiation. -
SavingsInAmount: number
Read Only:
trueValue that identifies the amount of savings generated by awarding the lines to one or more supplier responses. -
SavingsInPercent: number
Read Only:
trueValue that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation. -
ShortlistedResponses: number
Title:
Shortlisted ResponsesRead Only:trueNumber of shortlisted responses for a negotiation line. -
TargetQuantity: number
Title:
Target QuantityRead Only:trueQuantity proposed by the procurement organization for the negotiation line. -
TotalAwardAmount: number
Title:
AwardRead Only:trueQuantity proposed by the procurement organization for the negotiation line. -
TransformedBestResponseNumber: number
Read Only:
trueNumber of the response with the best transformed price. -
TransformedBestResponsePrice: number
Read Only:
truePrice of the response with the best transformed price. -
UOM: string
Title:
UOMRead Only:trueMaximum Length:25Name of the unit of measure for the item in the negotiation.
Nested Schema : Awarded Response Details
Type:
arrayTitle:
Awarded Response DetailsDetails of the awarded responses for a negotiation line.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : All Bids
Type:
arrayTitle:
All BidsLines that have been awarded in a supplier negotiation.
Show Source
Nested Schema : supplierNegotiationAwards-lines-awardedResponseDetails-item-response
Type:
Show Source
object-
AlternateLineDescription: string
Title:
Alternate Line DescriptionRead Only:trueMaximum Length:2500Description of an alternate line. -
AuctionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the negotiation. -
AwardAmount: number
Title:
Award AmountRead Only:trueAmount awarded to a supplier response line. -
AwardedQuantity: number
Read Only:
trueTotal quantity awarded for auction. -
AwardPrice: number
Title:
Award PriceRead Only:trueFinal price of the awarded line items. -
AwardStatusCode: string
Read Only:
trueMaximum Length:25Value that identifies whether the response was awarded or rejected. -
BestResponseNumber: integer
(int64)
Read Only:
trueNumber of the best response for the negotiation line among all responses. -
BusinessRelationshipCode: string
Read Only:
trueMaximum Length:30Abbreviation 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. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Value that identifies the code of the currency used by buyer organization. -
GroupType: string
Read Only:
trueMaximum Length:25Type 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. -
Line: string
Read Only:
trueMaximum Length:25Line number of the negotiation line. -
LineId: number
Read Only:
trueUnique identifier of the negotiation line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartialResponseFlag: boolean
Read Only:
trueMaximum Length:1Contains 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. -
Price: number
Read Only:
trueAll Bids -
PromisedDeliveryDate: string
(date)
Title:
Promised DateRead Only:trueDate on which the supplier has promised to deliver the goods to the buying organization. -
PromisedShipDate: string
(date)
Title:
Promised Ship DateRead Only:trueDate on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms. -
PurchaseDocumentAmount: number
Title:
Purchasing Document AmountRead Only:trueThe total amount of the line item based on the awarded quantity. -
PurchaseDocumentPrice: number
Title:
Purchasing Document PriceRead Only:truePrice of the line item based on the award quantity. -
Quantity: number
Title:
QuantityRead Only:trueQuantity of the item in the negotiation. -
Rank: string
Title:
RankRead Only:trueMaximum Length:255The rank value displayed for the line item based on the response price. -
ResponseAmount: number
Read Only:
trueTotal amount calculated for all line items that the supplier offered a price for when responding to a negotiation. -
ResponseNumber: integer
(int64)
Read Only:
trueValue that uniquely identifies the response. -
ResponseStatusCode: string
Read Only:
trueMaximum Length:25Value that uniquely identifies the response status. -
SavingsInAmount: number
Title:
SavingsRead Only:trueValue that identifies the amount of savings generated by awarding the lines to one or more supplier responses. -
SavingsInPercent: number
Title:
SavingsRead Only:trueValue that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation. -
SpendAuthorizationReviewStatusCode: string
Read Only:
trueMaximum Length:30Status code of the supplier's spend authorization review. Accepted values include PENDING_APPROVAL and REJECTED. -
Supplier: string
Read Only:
trueMaximum Length:360Name of the supplier who responds to the negotiation. -
SupplierContact: string
Title:
Supplier ContactRead Only:trueMaximum Length:255Name of the supplier contact at the supplier that responds to the negotiation. -
SupplierContactId: integer
(int64)
Read Only:
trueValue that identifies the contact of the supplier who responds to the negotiation. -
SupplierId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier. -
SupplierSite: string
Read Only:
trueMaximum Length:240Name of the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
trueValue that identifies the supplier site. -
TechnicalEvaluationStatusCode: string
Read Only:
trueMaximum Length:30Value that identifies the technical evaluation completion status. -
UOM: string
Read Only:
trueMaximum Length:25Name of the unit of measure for the item in the negotiation. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure for the item in the negotiation. -
VendorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bidder.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : supplierNegotiationAwards-lines-responsesLines-item-response
Type:
Show Source
object-
AlternateLineDescription: string
Read Only:
trueMaximum Length:2500All Bids -
AlternateLineFlag: boolean
Read Only:
trueMaximum Length:1All Bids -
AuctionHeaderId: integer
Read Only:
trueAll Bids -
AwardAmount: number
Read Only:
trueAll Bids -
AwardInternalNote: string
Read Only:
trueMaximum Length:4000All Bids -
AwardNoteToSupplier: string
Read Only:
trueMaximum Length:4000All Bids -
AwardPrice: number
Read Only:
truePrice of the awarded line item. -
AwardQuantity: number
Read Only:
trueAll Bids -
AwardStatus: string
Read Only:
trueMaximum Length:255All Bids -
AwardUOM: string
Read Only:
trueMaximum Length:25All Bids -
BusinessRelationship: string
Read Only:
trueMaximum Length:255All Bids -
CompositeScore: number
Read Only:
trueAll Bids -
GroupAmount: number
Read Only:
trueAll Bids -
GroupType: string
Read Only:
trueMaximum Length:25All Bids -
HasQuantityTiersFlag: boolean
Read Only:
trueMaximum Length:1All Bids -
HasScoringTeamsFlag: boolean
Read Only:
trueMaximum Length:1Value that indicates whether the supplier negotiation has enabled scoring teams to evaluate the requirements. -
HasShipmentsFlag: boolean
Read Only:
trueMaximum Length:255Value that indicates whether the supplier negotiation has shipment enabled for the line items. -
Line: string
Read Only:
trueMaximum Length:255All Bids -
LineAmount: number
Read Only:
trueTotal amount of the line item, calculated based on the quantity. -
LineDescription: string
Read Only:
trueMaximum Length:2500All Bids -
LineId: integer
Read Only:
trueAll Bids -
LinePrice: number
Read Only:
trueAll Bids -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumRetainageAmount: number
Read Only:
trueAll Bids -
MinimumReleaseAmount: number
Read Only:
trueAll Bids -
NoteToBuyer: string
Read Only:
trueMaximum Length:4000All Bids -
OverriddenScore: number
Read Only:
trueAll Bids -
PartialResponseFlag: boolean
Read Only:
trueMaximum Length:1All Bids -
PreviousRoundBidAndScore: string
Read Only:
trueMaximum Length:255All Bids -
Price: number
Read Only:
trueAll Bids -
PromisedDeliveryDate: string
(date)
Read Only:
trueAll Bids -
PromisedShipDate: string
(date)
Read Only:
trueAll Bids -
Quantity: number
Read Only:
trueAll Bids -
Rank: integer
Read Only:
trueAll Bids -
Response: integer
Read Only:
trueAll Bids -
ResponseAmount: number
Read Only:
trueAll Bids -
ResponseStatusCode: string
Read Only:
trueMaximum Length:25All Bids -
ResponseType: string
Read Only:
trueMaximum Length:25All Bids -
RetainageRatePercent: number
Read Only:
trueAll Bids -
Score: number
Read Only:
trueAll Bids -
ScoreOverriddenFlag: boolean
Read Only:
trueMaximum Length:255All Bids -
ShortlistFlag: boolean
Read Only:
trueMaximum Length:1All Bids -
Supplier: string
Read Only:
trueMaximum Length:360All Bids -
SupplierContact: string
Read Only:
trueMaximum Length:255All Bids -
SupplierId: integer
Read Only:
trueAll Bids -
SupplierNumber: string
Read Only:
trueMaximum Length:30Unique identifier for the supplier bidder. -
SupplierSite: string
Read Only:
trueMaximum Length:240All Bids -
SupplierSiteId: integer
Read Only:
trueAll Bids -
TransformedAmount: number
Read Only:
trueAll Bids -
TransformedGroupAmount: number
Read Only:
trueAll Bids -
TransformedLineAmount: number
Read Only:
trueTotal amount calculated as the quantity multiplied by the transformed price. -
TransformedLineRank: integer
Read Only:
trueAll Bids -
TransformedPrice: number
Read Only:
trueThe sum of the line price and internal cost factors applied to a supplier for that line item. -
TransformedRank: integer
Read Only:
trueAll Bids -
UnitPriceSavings: number
Read Only:
trueThe savings realized from one unit of the awarded line. -
UnitPriceSavingsPercent: number
Read Only:
trueThe percentage savings realized from one unit of the awarded line. -
VendorId: integer
Read Only:
trueAll Bids
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- awardedResponseDetails
-
Parameters:
- AuctionHeaderId:
$request.path.AuctionHeaderId - LineId:
$request.path.LineId
Details of the awarded responses for a negotiation line. - AuctionHeaderId:
- responsesLines
-
Parameters:
- AuctionHeaderId:
$request.path.AuctionHeaderId - LineId:
$request.path.LineId
Lines that have been awarded in a supplier negotiation. - AuctionHeaderId: