Get one award line
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/child/lines/{LineId}/child/responsesLines/{responsesLinesUniqID}
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=
-
responsesLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LineId and Response ---for the All Bids resource and used to uniquely identify an instance of All Bids. The client should not generate the hash key value. Instead, the client should query on the All Bids collection resource with a filter on the primary key values in order to navigate to a specific instance of All Bids.
For example: responsesLines?q=LineId=<value1>;Response=<value2>
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-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
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.