Get all negotiation lines
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines
Request
Path Parameters
-
supplierNegotiationsUniqID(required): string
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
-
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 -
finder: string
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 single line for the supplier negotiation according to the primary key. The primary key is the combination of AuctionHeaderId and LineId.
Finder Variables:- AuctionHeaderId; integer; Value that uniquely identifies the auction header.
- LineId; number; Value that uniquely identifies the negotiation line.
- PrimaryKeyFinder: Finds the line according to LineId.
Finder Variables:- LineId; integer; Value that uniquely identifies the negotiation line.
- PrimaryKey: Finds the single line for the supplier negotiation according to the primary key. The primary key is the combination of AuctionHeaderId and LineId.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
- CategoryName; string; Name of the purchasing category for the negotiation line.
- Item; string; Name of the inventory item.
- Line; string; Number that identifies the negotiation line.
- LineDescription; string; Description of the negotiation line.
- LineId; number; Value that uniquely identifies the negotiation line.
- ResponseRevisionLineDecrementValue; number; Minimum amount or percentage of reduction of the line price in each revised response.
-
totalResults: boolean
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
-
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.
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(required):
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(required):
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 : supplierNegotiations-lines
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-item-response
Type:
Show Source
object
-
AllowAlternateLinesFlag: boolean
Title:
Allow Alternate Lines
Maximum Length:30
Contains one of the following values: true or false. If true, then allow the supplier to create an alternate response line for each negotiation line. If false, then do not allow. If Allow Alternate Lines is not enabled, then the default value for AllowAlternateLinesFlag is empty. Otherwise, the default value is true. The value for AllowAlternateLinesFlag is empty for a group or lot line. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages details about attachments for a negotiation line. -
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CategoryId: integer
(int64)
Value that identifies the purchasing category for the negotiation line.
-
CategoryName: string
Maximum Length:
2400
Name of the purchasing category for the negotiation line. -
costFactors: array
External Cost Factors
Title:
External Cost Factors
The Cost Factors resource manages details about the cost factors for a negotiation line. For example, freight, setup charges, or switching costs. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the line. -
CurrentPrice: number
Title:
Current Price
Price that the procurement organization pays for the item or service. -
DFF: array
Flexfields
Title:
Flexfields
The Flexfields resource contains details about negotiation lines. -
DisplayTargetPriceFlag: boolean
Title:
Display target price
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to view the target price. If false, then do not allow. If the negotiation is a RFI (request for information), or if the application does not enable Allow Price and enable Quantity, then the default value for DisplayTargetPriceFlag is empty. If the line resides in a group, then the default value is empty, else the default value is false. -
DisplayUnitTargetPriceFlag: boolean
Title:
Display Line Target Price
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to view the unit target price. If false, then do not allow. If the line resides in a group, then the default value is empty, else the default value is false. -
EstimatedQuantity: number
Title:
Estimated Quantity
Estimated quantity of the item in the negotiation. -
EstimatedTotalAmount: number
Title:
Estimated Total Amount
Estimated total amount of the service in the negotiation. -
GroupType: string
Title:
Type
Maximum Length:80
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. -
GroupTypeCode: string
Maximum Length:
25
Abbreviation 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. -
Item: string
Title:
Item
Maximum Length:300
Name of the inventory item. -
ItemId: integer
(int64)
Value that identifies the inventory item.
-
ItemRevision: string
Title:
Revision
Maximum Length:18
Revision of the inventory item on the negotiation line. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the line. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the line. -
Line: string
Title:
Line
Maximum Length:25
Number that identifies the negotiation line. -
lineAttributeGroups: array
Attribute Groups
Title:
Attribute Groups
The Attribute Groups resource manages details about groups of attributes on the supplier negotiation line. -
LineCloseDate: string
(date-time)
Title:
Close Date
Date and time when the negotiation line closes in a staggered closing or in a negotiation that can extend. -
LineDescription: string
Title:
Description
Maximum Length:2500
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
LineType: string
Title:
Line Type
Maximum Length:30
Name of the line type that indicates whether the line is for items or services. A list of accepted values is defined in the lookup type ORDER TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Purchasing Line Types task. -
LineTypeId: integer
(int64)
Title:
Line Type ID
Value that identifies the line type that indicates whether the line is for items or services. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumRetainageAmount: number
Title:
Maximum Retainage Amount
Maximum amount of retainage that can be withheld on a line. -
MinimumReleaseAmount: number
Title:
Minimum Release Amount
Minimum amount in any purchase order line that the application can release for the purchase agreement line. -
negotiationLineRecommendedSuppliers: array
Negotiation Line Recommended Suppliers
Title:
Negotiation Line Recommended Suppliers
The Negotiation Line Recommended Suppliers resource manages details about supplier recommendations for a negotiation line. -
NoteToSuppliers: string
Title:
Note to Suppliers
Maximum Length:4000
Note for the negotiation line for the supplier. -
ParentLine: string
Title:
Parent Line
Maximum Length:25
Number that identifies an existing group or lot as a parent line in a negotiation. It is the value stored in the Line attribute. Group Line can be added as a child of Group, and Lot Line can be added as a child of Lot. -
ParentSequenceNumber: integer
Sequence number of the parent line to which a child line is added. Group Line can be added as a child of Group, and Lot Line can be added as child of Lot.
-
PriceAndQuantityEnabledFlag: boolean
Maximum Length:
255
Contains one of the following values: true or false. If true, then allow each RFI (request for information) line to include price and quantity. If false, then do not allow. If the line resides in a group, then the default value is empty, else the default value is true. -
priceBreaks: array
Price Breaks
Title:
Price Breaks
The Price Breaks resource manages details about price breaks for a negotiation line to solicit pricing from suppliers according to location, volume, or date. -
PriceBreakType: string
Title:
Price Break Type
Maximum Length:80
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. A list of accepted values is defined in the lookup type PON_PRICE_BREAK_TYPE. -
PriceBreakTypeCode: string
Title:
Price Break Type Code
Maximum Length:25
Abbreviation 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 NON-CUMULATIVE. A list of accepted values is defined in the lookup type PON_PRICE_BREAK_TYPE. -
priceTiers: array
Price Tiers
Title:
Price Tiers
The Price Tiers resource manages details about tiers according to quantity for a negotiation line to solicit tiered pricing from each supplier. -
Quantity: number
Title:
Quantity
Quantity of the item in the negotiation. -
RequestedDeliveryDate: string
(date)
Title:
Requested Delivery Date
Date when the application requests to deliver the item that the negotiation line references. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Date when the application requests to ship the item that the negotiation line references. -
Requisition: string
Title:
Requisition
Read Only:true
Maximum Length:64
Requisition number that the negotiation line references. -
RequisitioningBU: string
Title:
Requisitioning BU
Maximum Length:240
Name of the requisition business unit that is a client of the procurement business unit. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisition business unit that is a client of the procurement business unit.
-
RequisitionLine: string
Title:
Requisition Line
Read Only:true
Maximum Length:255
Requisition line number that the negotiation line references. -
ResponseRevisionLineDecrementValue: number
Title:
Decrement
Minimum amount or percentage of reduction of the line price in each revised response. -
RetainageRate: number
Title:
Retainage Rate
Percentage of the amount requested that will be withheld before releasing payments to the contractor. -
SequenceNumber: integer
Number that specifies the order in which lines are added to a negotiation using web service.
-
ShipToLocation: string
Title:
Location
Maximum Length:60
Name of the location where the application ships the negotiated item, or where the provider performs the negotiated service. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location ID
Value that uniquely identifies the location where the supplier ships the item. -
SourceAgreement: string
Title:
Source Agreement
Read Only:true
Maximum Length:20
Purchase agreement that the negotiators are renegotiating. -
SourceAgreementLine: string
Title:
Source Agreement Line
Read Only:true
Maximum Length:20
Agreement line that the negotiation line references. -
StartPrice: number
Title:
Start Price
Highest price that the application allows the supplier to enter in response to a negotiation line. -
SuppliersCanModifyPriceBreaksFlag: boolean
Title:
Suppliers can modify price breaks
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to modify price breaks that the procurement organization set up. If false, then do not allow. If the application does not enable price breaks, then the default value is empty. If the line resides in a group, then the value empty, else the default value is true. -
TargetPrice: number
Title:
Target Price
Price that the procurement organization prefers pay for the negotiation line. -
UnitTargetPrice: number
Title:
Line Target Price
Price that the procurement organization prefers to pay for the negotiation line, not including cost factors. -
UOM: string
Title:
UOM
Maximum Length:25
Name of the unit of measure for the item in the negotiation. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure for the item in the negotiation.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages details about attachments for a negotiation line.
Show Source
Nested Schema : External Cost Factors
Type:
array
Title:
External Cost Factors
The Cost Factors resource manages details about the cost factors for a negotiation line. For example, freight, setup charges, or switching costs.
Show Source
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The Flexfields resource contains details about negotiation lines.
Show Source
Nested Schema : Attribute Groups
Type:
array
Title:
Attribute Groups
The Attribute Groups resource manages details about groups of attributes on the supplier negotiation line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Negotiation Line Recommended Suppliers
Type:
array
Title:
Negotiation Line Recommended Suppliers
The Negotiation Line Recommended Suppliers resource manages details about supplier recommendations for a negotiation line.
Show Source
Nested Schema : Price Breaks
Type:
array
Title:
Price Breaks
The Price Breaks resource manages details about price breaks for a negotiation line to solicit pricing from suppliers according to location, volume, or date.
Show Source
Nested Schema : Price Tiers
Type:
array
Title:
Price Tiers
The Price Tiers resource manages details about tiers according to quantity for a negotiation line to solicit tiered pricing from each supplier.
Show Source
Nested Schema : supplierNegotiations-lines-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment. It is a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the negotiation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The Base64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the negotiation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Sign in details that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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 : supplierNegotiations-lines-costFactors-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CostFactor: string
Title:
Cost Factor
Maximum Length:80
Name of the cost factor. -
CostFactorId: integer
(int64)
Title:
Cost Factor ID
Value that identifies the cost factor. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the cost factor. -
DisplayTargetFlag: boolean
Title:
Display Target
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false. -
Line: number
Read Only:
true
Number that identifies the negotiation line. -
LineCostFactorId: number
Read Only:
true
Value that uniquely identifies the sequence of the cost factor within a negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Title:
Line ID
Read Only:true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingBasis: string
Title:
Pricing Basis
Maximum Length:80
Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS. -
PricingBasisCode: string
Title:
Pricing Basis Code
Maximum Length:30
Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS. -
TargetValue: number
Title:
Target Value
Target value of the cost factor.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Attribute
Maximum Length:30
Descriptive flexfield context name for the details about lines. The supplier cannot view this flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Attribute
Descriptive flexfield context display value for the details about the abstract. The supplier cannot view this flexfield. -
AuctionHeaderId: integer
(int64)
Value that uniquely identifies the negotiation. The supplier cannot view this flexfield.
-
LineNumber: number
Number that identifies the negotiation line. The supplier cannot view this flexfield.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-lineAttributeGroups-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the attribute group. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the attribute group. -
GroupId: integer
(int64)
Read Only:
true
Value that identifies the attribute group. -
GroupName: string
Title:
Group
Maximum Length:240
Name of the attribute group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the attribute group. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the attribute group. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
lineAttributes: array
Line Attributes
Title:
Line Attributes
The Line Attributes resource manages details about attributes on the supplier negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Line Attributes
Type:
array
Title:
Line Attributes
The Line Attributes resource manages details about attributes on the supplier negotiation line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-lineAttributeGroups-lineAttributes-item-response
Type:
Show Source
object
-
acceptableResponseScoreValues: array
Response Values
Title:
Response Values
The Response Values resource manages details about score values for an acceptable response when scoring a line attribute. -
AttributeId: number
Read Only:
true
Value that identifies the attribute. -
AttributeName: string
Title:
Attribute
Maximum Length:4000
Description of the attribute. -
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the line attribute. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the line attribute. -
DisplayTargetFlag: boolean
Title:
Display Target
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to view the value for the attribute target. If false, then do not allow. The default value is false. -
GroupId: integer
(int64)
Read Only:
true
Value that identifies the attribute group. -
GroupName: string
Read Only:
true
Name of the attribute group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the line attribute. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the line attribute. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseType: string
Title:
Response
Maximum Length:80
Specifies whether the response for the line attribute is required. Values include required, optional, or not needed. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE. -
ResponseTypeCode: string
Title:
Response Type Code
Maximum Length:30
Abbreviation that identifies whether the response for the line attribute is required. Valid values are REQUIRED, OPTIONAL, and DISPLAY_ONLY. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE. -
TargetDateValue: string
(date)
Title:
Target Date Value
Target value of the attribute. This value is applicable for dates. -
TargetNumberValue: number
Title:
Target Number Value
Target value for the attribute. This value is applicable for numbers. -
TargetTextValue: string
Title:
Target Text Value
Maximum Length:4000
Target text or URL (Uniform Resource Locator) values of the attribute. -
ValueType: string
Title:
Value Type
Maximum Length:80
Display name of the data type for the attribute response. For example, text, number, date, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type Attribute Value Type. -
ValueTypeCode: string
Title:
Value Type Code
Maximum Length:3
Abbreviation that identifies the type of value for the attribute response. Valid values are TXT, NUM, DAT, and URL. A list of accepted values is defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE. -
Weight: number
Title:
Weight
Importance of the line attribute when compared to other line attributes. The application uses this weight when it calculates the line score.
Nested Schema : Response Values
Type:
array
Title:
Response Values
The Response Values resource manages details about score values for an acceptable response when scoring a line attribute.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-lineAttributeGroups-lineAttributes-acceptableResponseScoreValues-item-response
Type:
Show Source
object
-
AttributeId: number
Read Only:
true
Value that identifies the attribute. -
AttributeName: string
Read Only:
true
Description of the attribute. -
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the acceptable response score value. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the acceptable response score value. -
FromDateResponseValue: string
(date)
Title:
From Date Response Value
Earliest date in a date range that the application uses to score each date attribute. -
FromNumberResponseValue: number
Title:
From Number Response Value
Lowest number in a number range that the application uses to score each number attribute. -
GroupName: string
Read Only:
true
Name of the attribute group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the acceptable response score value. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the acceptable response score value. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Score: number
Title:
Score
Score that the application assigns to each attribute response. -
ScoreId: number
Read Only:
true
Value that uniquely identifies the score. -
TextResponseValue: string
Title:
Text Response Value
Maximum Length:240
Value that the application accepts for the attribute. Applies for text values. -
ToDateResponseValue: string
(date)
Title:
To Date Response Value
Most recent date in the date range that the application uses to score the attribute. This value is applicable for date values. -
ToNumberResponseValue: number
Title:
To Number Response Value
Highest number in the number range that the application uses to score the attribute. This value is applicable for numeric values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-negotiationLineRecommendedSuppliers-item-response
Type:
Show Source
object
-
AiScore: number
Score assigned to a recommended supplier by the artificial-intelligence model. A supplier with close matching transactions, and frequent purchasing and sourcing transactions is assigned a higher score.
-
AuctionHeaderId: integer
(int64)
Value that uniquely identifies the negotiation.
-
LineNumber: number
Number that identifies the negotiation line.
-
LineSuppRecommId: integer
(int64)
Value that uniquely identifies the recommended supplier for a negotiation line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierId: integer
(int64)
Value that identifies the supplier company that the application invited to respond to the negotiation.
-
SupplierName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the supplier company that the application invited to respond to the negotiation. -
SupplierScenario1Count: integer
(int64)
Indicates the total count of transactions for a scenario that match with a new negotiation line for a supplier. For example, supplier scenario 1 captures the number of matching purchase order lines.
-
SupplierScenario2Count: integer
(int64)
Indicates the total count of transactions for a scenario that match with a new negotiation line for a supplier. For example, supplier scenario 2 captures the number of matching purchase agreement lines.
-
SupplierScenario3Count: integer
(int64)
Indicates the total count of transactions for a scenario that match with a new negotiation line for a supplier. For example, supplier scenario 3 captures the number of matching negotiation award lines.
-
SupplierScenario4Count: integer
(int64)
Indicates the total count of transactions for a scenario that match with a new negotiation line for a supplier. For example, supplier scenario 4 captures the number of matching supplier response lines.
-
SupplierScenario5Count: integer
(int64)
Indicates the total count of transactions for a scenario that match with a new negotiation line for a supplier. For example, supplier scenario 5 captures the number of matching negotiation invitation lines.
-
SupplierSiteId: integer
(int64)
Value that identifies the supplier site.
-
SupplierSiteName: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-priceBreaks-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the price break. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the price break. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the price break. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the price break. -
Line: string
Number that identifies the negotiation line.
-
LineDescription: string
Description of the negotiation line.
-
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceBreakEndDate: string
(date)
Title:
End Date
Date when the price break expires. -
PriceBreakId: number
Title:
Price Break ID
Read Only:true
Value that identifies the price break. -
PriceBreakStartDate: string
(date)
Title:
Start Date
Date when the price break goes into effect. -
Quantity: number
Title:
Quantity
Quantity for the price break. -
ShipToLocation: string
Title:
Location
Maximum Length:60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location ID
Value that uniquely identifies the location where the supplier ships the item. -
ShipToOrganization: string
Title:
Ship-to Organization
Maximum Length:240
Name of the inventory organization where the supplier ships the item. -
ShipToOrganizationId: integer
(int64)
Title:
Ship-to Organization ID
Value that uniquely identifies the inventory organization where the supplier ships the item. -
TargetPrice: number
Title:
Target Price
Target price for the price break.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-priceTiers-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the price tier. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the price tier. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the price tier. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the price tier. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumQuantity: number
Title:
Maximum Quantity
Highest quantity limit for the price tier according to quantity. -
MinimumQuantity: number
Title:
Minimum Quantity
Lowest quantity limit for the price tier according to quantity. -
PriceTierId: number
Title:
Price Tier ID
Read Only:true
Value that identifies the price tier. -
TargetPrice: number
Title:
Target Price
Target price for the price tier according to quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all lines.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/lines"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AuctionHeaderId": 300100152357495, "LineId": 1, "GroupTypeCode": "LINE", "GroupType": "Line", "Line": "1", "LineCloseDate": null, "RequisitioningBU": null, "RequisitioningBUId": null, "LineTypeId": 1, "LineType": "Goods", "ItemId": null, "Item": null, "ItemRevision": null, "LineDescription": "Laptop Computer", "CategoryId": 1, "CategoryName": "Miscellaneous_1", "Quantity": null, "EstimatedQuantity": 25, "UOMCode": "Ea", "UOM": "Each", "EstimatedTotalAmount": null, "MinimumReleaseAmount": null, "ShipToLocationId": null, "ShipToLocation": null, "RequestedShipDate": null, "RequestedDeliveryDate": null, "PriceAndQuantityEnabledFlag": true, "CurrentPrice": 1000, "StartPrice": null, "TargetPrice": null, "DisplayTargetPriceFlag": false, "UnitTargetPrice": null, "DisplayUnitTargetPriceFlag": false, "NoteToSuppliers": null, "AllowAlternateLinesFlag": false, "PriceBreakTypeCode": "CUMULATIVE", "PriceBreakType": "Cumulative", "SuppliersCanModifyPriceBreaksFlag": true, "Requisition": null, "RequisitionLine": null, "SourceAgreement": null, "SourceAgreementLine": null, "CreationDate": "2018-06-28T10:46:23+00:00", "CreatedBy": "CVBUYER01", "LastUpdateDate": "2018-06-28T11:42:58.895+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1", "name": "lines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1", "name": "lines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495", "name": "supplierNegotiations", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors", "name": "costFactors", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceBreaks", "name": "priceBreaks", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/lineAttributeGroups", "name": "lineAttributeGroups", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/priceTiers", "name": "priceTiers", "kind": "collection" } ] }, { "AuctionHeaderId": 300100152357495, "LineId": 3, "GroupTypeCode": "LINE", "GroupType": "Line", "Line": "2", "LineCloseDate": null, "RequisitioningBU": null, "RequisitioningBUId": null, "LineTypeId": 6, "LineType": "Fixed Price Services", "ItemId": null, "Item": null, "ItemRevision": null, "LineDescription": "Maintenance of laptops", "CategoryId": 1, "CategoryName": "Miscellaneous_1", "Quantity": null, "EstimatedQuantity": null, "UOMCode": null, "UOM": null, "EstimatedTotalAmount": null, "MinimumReleaseAmount": null, "ShipToLocationId": null, "ShipToLocation": null, "RequestedShipDate": null, "RequestedDeliveryDate": null, "PriceAndQuantityEnabledFlag": true, "CurrentPrice": null, "StartPrice": null, "TargetPrice": null, "DisplayTargetPriceFlag": false, "UnitTargetPrice": null, "DisplayUnitTargetPriceFlag": false, "NoteToSuppliers": null, "AllowAlternateLinesFlag": true, "PriceBreakTypeCode": null, "PriceBreakType": null, "SuppliersCanModifyPriceBreaksFlag": null, "Requisition": null, "RequisitionLine": null, "SourceAgreement": null, "SourceAgreementLine": null, "CreationDate": "2018-06-28T11:34:16.526+00:00", "CreatedBy": "CVBUYER01", "LastUpdateDate": "2018-06-28T11:34:34.376+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3", "name": "lines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3", "name": "lines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495", "name": "supplierNegotiations", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3/child/costFactors", "name": "costFactors", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3/child/priceBreaks", "name": "priceBreaks", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3/child/lineAttributeGroups", "name": "lineAttributeGroups", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/3/child/priceTiers", "name": "priceTiers", "kind": "collection" } ] }, { "AuctionHeaderId": 300100152357495, "LineId": 2, "GroupTypeCode": "LINE", "GroupType": "Line", "Line": "3", "LineCloseDate": null, "RequisitioningBU": null, "RequisitioningBUId": null, "LineTypeId": 1, "LineType": "Goods", "ItemId": null, "Item": null, "ItemRevision": null, "LineDescription": "Laptops with touch screen", "CategoryId": 1, "CategoryName": "Miscellaneous_1", "Quantity": null, "EstimatedQuantity": 25, "UOMCode": "Ea", "UOM": "Each", "EstimatedTotalAmount": null, "MinimumReleaseAmount": null, "ShipToLocationId": null, "ShipToLocation": null, "RequestedShipDate": null, "RequestedDeliveryDate": null, "PriceAndQuantityEnabledFlag": true, "CurrentPrice": null, "StartPrice": null, "TargetPrice": null, "DisplayTargetPriceFlag": false, "UnitTargetPrice": null, "DisplayUnitTargetPriceFlag": false, "NoteToSuppliers": null, "AllowAlternateLinesFlag": true, "PriceBreakTypeCode": "CUMULATIVE", "PriceBreakType": "Cumulative", "SuppliersCanModifyPriceBreaksFlag": true, "Requisition": null, "RequisitionLine": null, "SourceAgreement": null, "SourceAgreementLine": null, "CreationDate": "2018-06-28T11:28:55.882+00:00", "CreatedBy": "CVBUYER01", "LastUpdateDate": "2018-06-28T11:34:34.353+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2", "name": "lines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2", "name": "lines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495", "name": "supplierNegotiations", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/costFactors", "name": "costFactors", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/priceBreaks", "name": "priceBreaks", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/lineAttributeGroups", "name": "lineAttributeGroups", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/priceTiers", "name": "priceTiers", "kind": "collection" } ] } ], "count": 3, "hasMore": false, "limit": 10, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines", "name": "lines", "kind": "collection" } ] }