Jump to

• Request
• Response

Get a line change

get

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

Request

Path Parameters

• AuctionHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• linesChangesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LineId and AuctionHeaderId ---for the Line Changes resource and used to uniquely identify an instance of Line Changes. The client should not generate the hash key value. Instead, the client should query on the Line Changes collection resource with a filter on the primary key values in order to navigate to a specific instance of Line Changes.
  
  For example: linesChanges?q=LineId=<value1>;AuctionHeaderId=<value2>
• 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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : supplierNegotiations-negotiationVersions-linesChanges-item-response

Type: object

Show Source

• AllowAlternateLines: string
  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.
• AttachmentsCount: integer
  Read Only: true

  Value that uniquely identifies the number of attachments included in a negotiation line.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Unique ID assigned to the latest negotiation version and is used to identify the line changes.
• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 250

  Name of the purchasing category to which the negotiation line belongs.
• ChangeTracking: string
  Read Only: true

  Maximum Length: 8

  Value that uniquely identifies the changes made to the current version such as the negotiation line and requirements.
• CurrentPrice: number
  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.
• DisplayTargetPriceFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates whether to display target price to suppliers.
• EstimatedQuantity: number
  Title: Estimated Quantity

  Read Only: true

  Estimated quantity of the item in the negotiation.
• EstimatedTotalAmount: number
  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.
• GroupType: string
  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.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Name of the inventory item that the buyer intends to purchase.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item.
• ItemRevision: string
  Title: Revision

  Read Only: true

  Maximum Length: 18

  Revision of the inventory item on the negotiation line.
• Line: string
  Title: Line

  Read Only: true

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 2500

  Description of the negotiation line.
• LineFilteringNumber: number
  Read Only: true

  Number that identifies the order of negotiation line.
• LineId: number
  Read Only: true

  Value that uniquely identifies the negotiation line.
• LineType: string
  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.
• LineTypeId: integer (int64)
  Read Only: true

  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.
• MinimumReleaseAmount: number
  Title: Minimum Release Amount

  Read Only: true

  Minimum amount in any purchase order line that the application can release for the purchase agreement line.
• NoteToSuppliers: string
  Title: Note to Suppliers

  Read Only: true

  Maximum Length: 4000

  Note that the buyer enters for the supplier when responding to the negotiation.
• OrderTypeLookupCode: string
  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.
• ParentLineNumber: number
  Read Only: true

  Value that uniquely identifies the parent line.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity of the item in the negotiation.
• RequestedDeliveryDate: string (date)
  Title: Requested Delivery Date

  Read Only: true

  Date by which delivery of goods is requested from suppliers.
• RequestedShipDate: string (date)
  Title: Requested Ship Date

  Read Only: true

  Date by which shipping of goods is requested from suppliers.
• ShipToLocation: string
  Title: Location

  Read Only: true

  Maximum Length: 60

  Name of the location to which the line item can be shipped.
• StartPrice: number
  Title: Start Price

  Read Only: true

  Highest price that the application allows the supplier to enter in response to a negotiation line.
• TargetPrice: number
  Title: Target Price

  Read Only: true

  Price that the procurement organization prefers to pay for the negotiation line.
• UOM: string
  Title: UOM

  Read Only: true

  Maximum Length: 25

  Name of the unit of measure for the item in the negotiation.

{
    "type":"object",
    "properties":{
        "AllowAlternateLines":{
            "title":"Allow Alternate Lines",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates if negotiation allows the supplier to create an alternate response line for each negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentsCount":{
            "type":"integer",
            "description":"Value that uniquely identifies the number of attachments included in a negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Unique ID assigned to the latest negotiation version and is used to identify the line changes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":250,
            "type":"string",
            "description":"Name of the purchasing category to which the negotiation line belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTracking":{
            "maxLength":8,
            "type":"string",
            "description":"Value that uniquely identifies the changes made to the current version such as the negotiation line and requirements.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPrice":{
            "title":"Current Price",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayTargetPriceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to display target price to suppliers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"Estimated quantity of the item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTotalAmount":{
            "title":"Estimated Total Amount",
            "type":"number",
            "description":"Total amount that the buyer estimates to pay for a fixed price type line item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupType":{
            "maxLength":25,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item that the buyer intends to purchase.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":18,
            "type":"string",
            "description":"Revision of the inventory item on the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineFilteringNumber":{
            "type":"number",
            "description":"Number that identifies the order of negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineTypeId":{
            "type":"integer",
            "description":"Value that identifies the line type that indicates whether the line is for items or services.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumReleaseAmount":{
            "title":"Minimum Release Amount",
            "type":"number",
            "description":"Minimum amount in any purchase order line that the application can release for the purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteToSuppliers":{
            "title":"Note to Suppliers",
            "maxLength":4000,
            "type":"string",
            "description":"Note that the buyer enters for the supplier when responding to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeLookupCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that specifies the line type in a negotiation. Valid values are QUANTITY and FIXED PRICE for Goods and Fixed Price Services line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentLineNumber":{
            "type":"number",
            "description":"Value that uniquely identifies the parent line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedDeliveryDate":{
            "title":"Requested Delivery Date",
            "type":"string",
            "description":"Date by which delivery of goods is requested from suppliers.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedShipDate":{
            "title":"Requested Ship Date",
            "type":"string",
            "description":"Date by which shipping of goods is requested from suppliers.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocation":{
            "title":"Location",
            "maxLength":60,
            "type":"string",
            "description":"Name of the location to which the line item can be shipped.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartPrice":{
            "title":"Start Price",
            "type":"number",
            "description":"Highest price that the application allows the supplier to enter in response to a negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPrice":{
            "title":"Target Price",
            "type":"number",
            "description":"Price that the procurement organization prefers to pay for the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure for the item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top