Get one version

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/negotiationVersions/{AuctionHeaderId}

Request

Path Parameters
  • 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=
  • 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-negotiationVersions-item-response
Type: object
Show Source
Nested Schema : Business Terms Changes
Type: array
Title: Business Terms Changes
Details of all the business term changes in a negotiation version.
Show Source
Nested Schema : Line Changes
Type: array
Title: Line Changes
Details of all the line changes in a negotiation version.
Show Source
Nested Schema : Negotiation Control Changes
Type: array
Title: Negotiation Control Changes
Details of all the negotiation control changes in a negotiation version.
Show Source
Nested Schema : Overview Changes
Type: array
Title: Overview Changes
Details of all the changes in the overview of a negotiation version.
Show Source
Nested Schema : Response Rules
Type: array
Title: Response Rules
Details of all the response rule changes in a negotiation version.
Show Source
Nested Schema : Schedule Changes
Type: array
Title: Schedule Changes
Details of all the schedule changes in a negotiation version.
Show Source
Nested Schema : Section Changes
Type: array
Title: Section Changes
Details of all the section changes in a negotiation version.
Show Source
Nested Schema : supplierNegotiations-negotiationVersions-businessTermsChanges-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 18
    Value that uniquely identifies the attribute name for business terms that was changed in the latest negotiation version.
  • Read Only: true
    Unique ID assigned to the latest negotiation, used to identify changes in the business terms.
  • Read Only: true
    Value that uniquely identifies the business terms attribute with date data type in the current version of the negotiation.
  • Read Only: true
    Value that uniquely identifies the attribute with numeric data type in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the attribute with text data type in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 1
    Value that indicates if the business terms was changed in the current version of the negotiation.
  • Links
  • Read Only: true
    Value that uniquely identifies the business terms attribute with date data type in the previous version of the negotiation.
  • Read Only: true
    Value that uniquely identifies the attribute with numeric data type in the previous version of the negotiation.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the attribute with text data type in the previous version of the negotiation.
Nested Schema : supplierNegotiations-negotiationVersions-linesChanges-item-response
Type: object
Show Source
  • Title: Allow Alternate Lines
    Read Only: true
    Maximum Length: 30
    Value that indicates if negotiation allows the supplier to create an alternate response line for each negotiation line.
  • Read Only: true
    Value that uniquely identifies the number of attachments included in a negotiation line.
  • Read Only: true
    Unique ID assigned to the latest negotiation version and is used to identify the line changes.
  • Title: Category Name
    Read Only: true
    Maximum Length: 250
    Name of the purchasing category to which the negotiation line belongs.
  • Read Only: true
    Maximum Length: 8
    Value that uniquely identifies the changes made to the current version such as the negotiation line and requirements.
  • Title: Current Price
    Read Only: true
    Price of the corresponding line item that will be mentioned on the purchasing document. This is displayed in the transactional currency of the purchasing document.
  • Read Only: true
    Maximum Length: 1
    Value that indicates whether to display target price to suppliers.
  • Title: Estimated Quantity
    Read Only: true
    Estimated quantity of the item in the negotiation.
  • Title: Estimated Total Amount
    Read Only: true
    Total amount that the buyer estimates to pay for a fixed price type line item in the negotiation.
  • Read Only: true
    Maximum Length: 25
    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 PON_GROUP_TYPE.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Name of the inventory item that the buyer intends to purchase.
  • Read Only: true
    Value that uniquely identifies the inventory item.
  • Title: Revision
    Read Only: true
    Maximum Length: 18
    Revision of the inventory item on the negotiation line.
  • Title: Line
    Read Only: true
    Maximum Length: 25
    Number that identifies the negotiation line.
  • Title: Description
    Read Only: true
    Maximum Length: 2500
    Description of the negotiation line.
  • Read Only: true
    Number that identifies the order of negotiation line.
  • Read Only: true
    Value that uniquely identifies the negotiation line.
  • Title: Line Type
    Read Only: true
    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 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.
  • Read Only: true
    Value that identifies the line type that indicates whether the line is for items or services.
  • Links
  • Title: Minimum Release Amount
    Read Only: true
    Minimum amount in any purchase order line that the application can release for the purchase agreement line.
  • Title: Note to Suppliers
    Read Only: true
    Maximum Length: 4000
    Note that the buyer enters for the supplier when responding to the negotiation.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that specifies the line type in a negotiation. Valid values are QUANTITY and FIXED PRICE for Goods and Fixed Price Services line type.
  • Read Only: true
    Value that uniquely identifies the parent line.
  • Title: Quantity
    Read Only: true
    Quantity of the item in the negotiation.
  • Title: Requested Delivery Date
    Read Only: true
    Date by which delivery of goods is requested from suppliers.
  • Title: Requested Ship Date
    Read Only: true
    Date by which shipping of goods is requested from suppliers.
  • Title: Location
    Read Only: true
    Maximum Length: 60
    Name of the location to which the line item can be shipped.
  • Title: Start Price
    Read Only: true
    Highest price that the application allows the supplier to enter in response to a negotiation line.
  • Title: Target Price
    Read Only: true
    Price that the procurement organization prefers to pay for the negotiation line.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the item in the negotiation.
Nested Schema : supplierNegotiations-negotiationVersions-negotiationControlsChanges-item-response
Type: object
Show Source
  • Read Only: true
    Unique ID assigned to the latest negotiation version and is used to identify the line changes.
  • Read Only: true
    Unique ID assigned to the previous negotiation version and is used to identify the line changes.
  • Read Only: true
    Maximum Length: 19
    Value that uniquely identifies the negotiation control attribute that's changed in the new round using the primary attribute.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of value for the negotiation controls in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the value of the updated negotiation control attribute in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the latest negotiation.
  • Read Only: true
    Maximum Length: 1
    Value that indicates if the negotiation control was changed in the current version of the negotiation.
  • Links
  • Read Only: true
    Maximum Length: 80
    Value that identifies the type of negotiation. Values include Auction, Request for Quote ( RFQ), or Request For Information (RFI).
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of value for the negotiation controls in the previous version of the negotiation.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the value of the updated negotiation control attribute in the previous version of the negotiation.
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the previous negotiation.
Nested Schema : supplierNegotiations-negotiationVersions-overviewChanges-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 20
    Value that uniquely identifies the attribute that can be changed in an amendment.
  • Read Only: true
    Unique ID assigned to the latest negotiation version.
  • Read Only: true
    Value that uniquely identifies the value differences.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the attribute with text data type in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the latest negotiation.
  • Links
  • Read Only: true
    Maximum Length: 80
    Value that identifies the type of the amendment. Values include Auction, Request for Quote ( RFQ), or Request For Information (RFI).
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the previous negotiation.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the attribute with text data type in the previous version of the negotiation.
Nested Schema : supplierNegotiations-negotiationVersions-responseRulesChanges-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 16
    Value that uniquely identifies attributes that can be changed in the response rules of a negotiation.
  • Read Only: true
    Unique ID assigned to the latest negotiation version.
  • Read Only: true
    Value that indicates the minimum amount or percentage of reduction of the line price in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 25
    Minimum amount in any purchase order line that the application can release for the purchase agreement line for the current negotiation.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the display indicator is enabled for displaying the response rule to suppliers in the current version of the negotiation. If false, then it's not. The default value is false.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of value for the response rule in the current version of the negotiation.
  • Read Only: true
    Maximum Length: 32
    Contains one of the following values: true or false. If true, then the response rule is enabled in the current version of the negotiation. If false, then it's not. The default value is false.
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the latest negotiation.
  • Read Only: true
    Maximum Length: 1
    Value that indicates if the response rule was changed in the current version of the negotiation.
  • Links
  • Read Only: true
    Maximum Length: 80
    Value that identifies the type of negotiation . Values include Auction, Request for Quote ( RFQ), or Request For Information (RFI).
  • Read Only: true
    Value that indicates the minimum amount or percentage of reduction of the line price in the previous version of the negotiation.
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the previous negotiation.
  • Read Only: true
    Maximum Length: 25
    Minimum amount in any purchase order line that the application can release for the purchase agreement line for the previous negotiation.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the display indicator is enabled for displaying the response rule to suppliers in the previous version of the negotiation. If false, then it's not. The default value is false.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of value for the response rule in the previous version of the negotiation.
  • Read Only: true
    Maximum Length: 32
    Contains one of the following values: true or false. If true, then the response rule is enabled in the previous version of the negotiation. If false, then it's not. The default value is false.
Nested Schema : supplierNegotiations-negotiationVersions-scheduleChanges-item-response
Type: object
Show Source
Nested Schema : supplierNegotiations-negotiationVersions-sectionsChanges-item-response
Type: object
Show Source
Nested Schema : Requirement Changes
Type: array
Title: Requirement Changes
Details of all the requirement changes in a negotiation version.
Show Source
Nested Schema : supplierNegotiations-negotiationVersions-sectionsChanges-requirementsChanges-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the number of attachments in a requirement.
  • Read Only: true
    Unique ID assigned to the latest negotiation version.
  • Read Only: true
    Maximum Length: 8
    Value that uniquely captures the changes made to requirements between the latest and previous versions of an amendment, highlighting additions, deletions, or updates.
  • Read Only: true
    Display the sequence of the requirements in a section in a negotiation.
  • Links
  • Read Only: true
    Value that uniquely identifies the requirement associated to the section.
  • Read Only: true
    Maximum Length: 11
    Value that uniquely identifies the requirements entity.
  • Read Only: true
    Maximum Length: 80
    Displays the requirement number within a section in a sequential order such as 1, 2, 3, and so on. If a requirement has branching, its child requirements are numbered hierarchically (e.g., 2.1, 2.2) based on the branching level.
  • Read Only: true
    Value that uniquely identifies the requirement.
  • Read Only: true
    Maximum Length: 80
    Requirement name entered by the buyer.
  • Read Only: true
    Text that describes the requirement.
  • Read Only: true
    Maximum Length: 30
    Type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, and Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
  • Read Only: true
    Value that uniquely identifies the section.
Back to Top