1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Negotiations
  4. Lines

Get one negotiation line

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}

Request

Path Parameters
  • Value that uniquely identifies the negotiation line.
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-lines-item-response
Type: object
Show Source
  • 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
    Title: Attachments
    The Attachments resource manages details about attachments for a negotiation line.
  • Read Only: true
    Value that uniquely identifies the negotiation.
  • Value that identifies the purchasing category for the negotiation line.
  • Maximum Length: 2400
    Name of the purchasing category for the negotiation line.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the line.
  • Read Only: true
    Date and time when the user created the line.
  • Title: Current Price
    Price that the procurement organization pays for the item or service.
  • Flexfields
    Title: Flexfields
    The Flexfields resource contains details about negotiation lines.
  • 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.
  • 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.
  • Title: Estimated Quantity
    Estimated quantity of the item in the negotiation.
  • Title: Estimated Total Amount
    Estimated total amount of the service in the negotiation.
  • 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.
  • 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.
  • Title: Item
    Maximum Length: 300
    Name of the inventory item.
  • Value that identifies the inventory item.
  • Title: Revision
    Maximum Length: 18
    Revision of the inventory item on the negotiation line.
  • Read Only: true
    Date and time when the user most recently updated the line.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the line.
  • Title: Line
    Maximum Length: 25
    Number that identifies the negotiation line.
  • Attribute Groups
    Title: Attribute Groups
    The Attribute Groups resource manages details about groups of attributes on the supplier negotiation line.
  • Title: Close Date
    Date and time when the negotiation line closes in a staggered closing or in a negotiation that can extend.
  • Title: Description
    Maximum Length: 2500
    Description of the negotiation line.
  • Read Only: true
    Value that uniquely identifies the negotiation line.
  • 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.
  • Title: Line Type ID
    Value that identifies the line type that indicates whether the line is for items or services.
  • Links
  • Title: Maximum Retainage Amount
    Maximum amount of retainage that can be withheld on a line.
  • Title: Minimum Release Amount
    Minimum amount in any purchase order line that the application can release for the purchase agreement line.
  • Negotiation Line Recommended Suppliers
    Title: Negotiation Line Recommended Suppliers
    The Negotiation Line Recommended Suppliers resource manages details about supplier recommendations for a negotiation line.
  • Title: Note to Suppliers
    Maximum Length: 4000
    Note for the negotiation line for the supplier.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Quantity
    Quantity of the item in the negotiation.
  • Title: Requested Delivery Date
    Date when the application requests to deliver the item that the negotiation line references.
  • Title: Requested Ship Date
    Date when the application requests to ship the item that the negotiation line references.
  • Title: Requisition
    Read Only: true
    Maximum Length: 64
    Requisition number that the negotiation line references.
  • Title: Requisitioning BU
    Maximum Length: 240
    Name of the requisition business unit that is a client of the procurement business unit.
  • Value that uniquely identifies the requisition business unit that is a client of the procurement business unit.
  • Title: Requisition Line
    Read Only: true
    Maximum Length: 255
    Requisition line number that the negotiation line references.
  • Title: Decrement
    Minimum amount or percentage of reduction of the line price in each revised response.
  • Title: Retainage Rate
    Percentage of the amount requested that will be withheld before releasing payments to the contractor.
  • Number that specifies the order in which lines are added to a negotiation using web service.
  • Title: Location
    Maximum Length: 60
    Name of the location where the application ships the negotiated item, or where the provider performs the negotiated service.
  • Title: Ship-to Location ID
    Value that uniquely identifies the location where the supplier ships the item.
  • Title: Source Agreement
    Read Only: true
    Maximum Length: 30
    Purchase agreement that the negotiators are renegotiating.
  • Title: Source Agreement Line
    Read Only: true
    Maximum Length: 20
    Agreement line that the negotiation line references.
  • Title: Start Price
    Highest price that the application allows the supplier to enter in response to a negotiation line.
  • 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.
  • Title: Target Price
    Price that the procurement organization prefers pay for the negotiation line.
  • Title: Line Target Price
    Price that the procurement organization prefers to pay for the negotiation line, not including cost factors.
  • Title: UOM
    Maximum Length: 25
    Name of the unit of measure for the item in the negotiation.
  • 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 : 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: object
Show Source
Nested Schema : supplierNegotiations-lines-costFactors-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the negotiation.
  • Title: Cost Factor
    Maximum Length: 80
    Name of the cost factor.
  • Title: Cost Factor ID
    Value that identifies the cost factor.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the cost factor.
  • 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.
  • Read Only: true
    Number that identifies the negotiation line.
  • Read Only: true
    Value that uniquely identifies the sequence of the cost factor within a negotiation line.
  • Read Only: true
    Description of the negotiation line.
  • Title: Line ID
    Read Only: true
    Value that uniquely identifies the negotiation line.
  • Links
  • 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.
  • 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.
  • Title: Target Value
    Target value of the cost factor.
Nested Schema : supplierNegotiations-lines-DFF-item-response
Type: object
Show Source
Nested Schema : supplierNegotiations-lines-lineAttributeGroups-item-response
Type: object
Show Source
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 : supplierNegotiations-lines-lineAttributeGroups-lineAttributes-item-response
Type: object
Show Source
  • Response Values
    Title: Response Values
    The Response Values resource manages details about score values for an acceptable response when scoring a line attribute.
  • Read Only: true
    Value that identifies the attribute.
  • Title: Attribute
    Maximum Length: 4000
    Description of the attribute.
  • Read Only: true
    Value that uniquely identifies the negotiation.
  • Read Only: true
    Maximum Length: 64
    User who created the line attribute.
  • Read Only: true
    Date and time when the user created the line attribute.
  • 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.
  • Read Only: true
    Value that identifies the attribute group.
  • Read Only: true
    Name of the attribute group.
  • Read Only: true
    Date and time when the user most recently updated the line attribute.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the line attribute.
  • Read Only: true
    Number that identifies the negotiation line.
  • Read Only: true
    Description of the negotiation line.
  • Read Only: true
    Value that uniquely identifies the negotiation line.
  • Links
  • 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.
  • 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.
  • Title: Target Date Value
    Target value of the attribute. This value is applicable for dates.
  • Title: Target Number Value
    Target value for the attribute. This value is applicable for numbers.
  • Title: Target Text Value
    Maximum Length: 4000
    Target text or URL (Uniform Resource Locator) values of the attribute.
  • 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.
  • 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.
  • 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 : supplierNegotiations-lines-lineAttributeGroups-lineAttributes-acceptableResponseScoreValues-item-response
Type: object
Show Source
Nested Schema : supplierNegotiations-lines-negotiationLineRecommendedSuppliers-item-response
Type: object
Show Source
  • 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.
  • Value that uniquely identifies the negotiation.
  • Number that identifies the negotiation line.
  • Value that uniquely identifies the recommended supplier for a negotiation line.
  • Links
  • Value that identifies the supplier company that the application invited to respond to the negotiation.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    Name of the supplier company that the application invited to respond to the negotiation.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Value that identifies the supplier site.
  • Title: Site
    Read Only: true
    Maximum Length: 240
    Name of the supplier site.
Nested Schema : supplierNegotiations-lines-priceBreaks-item-response
Type: object
Show Source
Nested Schema : supplierNegotiations-lines-priceTiers-item-response
Type: object
Show Source
Links
DFF
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Flexfields resource contains details about negotiation lines.
attachments
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Attachments resource manages details about attachments for a negotiation line.
costFactors
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Cost Factors resource manages details about the cost factors for a negotiation line. For example, freight, setup charges, or switching costs.
lineAttributeGroups
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Attribute Groups resource manages details about groups of attributes on the supplier negotiation line.
negotiationLineRecommendedSuppliers
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Negotiation Line Recommended Suppliers resource manages details about supplier recommendations for a negotiation line.
priceBreaks
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Price Breaks resource manages details about price breaks for a negotiation line to solicit pricing from suppliers according to location, volume, or date.
priceTiers
Parameters:
  • LineId: $request.path.LineId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Price Tiers resource manages details about tiers according to quantity for a negotiation line to solicit tiered pricing from each supplier.
Back to Top

Examples

This example describes how to get one line.

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/LineId"

For example, the following command gets one line where the line identifier is 1:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "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"
        }
    ]
}
Back to Top