Jump to

• Request
• Response

Get all awarded lines for a response

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/child/responses/{ResponseNumber}/child/awardedLineDetails

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=
• ResponseNumber(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=

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 negotiation line according to the primary key.
    Finder Variables
    • LineId; number; Value that uniquely identifies the negotiation line.
• 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:
  

  • AgreementQuantity; number; Total quantity of line items recommended for award in a blanket purchase agreement during a supplier negotiation.
  • AlternateLineDescription; string; Description of an alternate line.
  • AlternateLineFlag; boolean; Value that indicates if alternate lines are present in the negotiation.
  • AwardAmount; number; Amount awarded to a supplier response line.
  • AwardQuantity; number; Total quantity of line items awarded in a supplier negotiation.
  • CategoryName; string; The purchasing category for the negotiation line.
  • CurrentPrice; number; Price that the procurement organization pays for the item or service.
  • EstimatedQuantity; number; Estimated quantity for the negotiation line on the blanket purchase agreement.
  • Item; string; Name of the inventory item that the buyer intends to purchase.
  • ItemRevision; string; Revision of the inventory item on the negotiation line.
  • Line; string; Line number of the negotiation line.
  • LineDescription; string; Description of the negotiation line.
  • LineId; number; Unique identifier of the negotiation line.
  • LineType; string; 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.
  • PromisedDeliveryDate; string; Date on which the supplier has promised to deliver the goods to the buying organization.
  • PurchaseDocumentAmount; number; The total amount of the line item based on the awarded quantity.
  • PurchaseDocumentPrice; number; Price of the line item based on the award quantity.
  • Quantity; number; Quantity of the item in the negotiation.
  • Rank; number; The rank value displayed for the line item based on the response price.
  • RequestedDeliveryDate; string; Date by which delivery of goods is requested from suppliers.
  • Requisition; string; Requisition number that the negotiation line references.
  • RequisitionLine; number; Requisition line number that the negotiation line references.
  • RequisitioningBU; string; Name of the requisition purchasing unit that the application uses to set default values for each negotiation line.
  • ResponseNumber; integer; Value that uniquely identifies the response.
  • ResponsePrice; number; Price given by the supplier for a line item in a supplier negotiation.
  • ResponseQuantity; string; Quantity given by the supplier for a line item in a supplier negotiation.
  • SavingsInAmount; number; Value that identifies the amount of savings generated by awarding the lines to one or more supplier responses.
  • SavingsInPercent; number; Value that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation.
  • TargetPrice; number; Target price shared by the category manager for a line item in a supplier negotiation.
  • UOM; string; Name of the unit of measure for the item in the negotiation.
• 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: 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 : supplierNegotiationAwards-responses-awardedLineDetails

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationAwards-responses-awardedLineDetails-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierNegotiationAwards-responses-awardedLineDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationAwards-responses-awardedLineDetails-item-response"
    }
}

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 : supplierNegotiationAwards-responses-awardedLineDetails-item-response

Type: object

Show Source

• AgreementQuantity: number
  Read Only: true

  Total quantity of line items recommended for award in a blanket purchase agreement during a supplier negotiation.
• AlternateLineDescription: string
  Read Only: true

  Maximum Length: 2500

  Description of an alternate line.
• AlternateLineFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates if alternate lines are present in the negotiation.
• AwardAmount: number
  Read Only: true

  Amount awarded to a supplier response line.
• AwardQuantity: number
  Read Only: true

  Total quantity of line items awarded in a supplier negotiation.
• CategoryName: string
  Read Only: true

  Maximum Length: 250

  The purchasing category for the negotiation line.
• CurrentPrice: number
  Read Only: true

  Price that the procurement organization pays for the item or service.
• EstimatedQuantity: number
  Read Only: true

  Estimated quantity for the negotiation line on the blanket purchase agreement.
• Item: string
  Read Only: true

  Maximum Length: 300

  Name of the inventory item that the buyer intends to purchase.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Revision of the inventory item on the negotiation line.
• Line: string
  Read Only: true

  Maximum Length: 25

  Line number of the negotiation line.
• LineDescription: string
  Read Only: true

  Maximum Length: 2500

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

  Unique identifier of the negotiation line.
• LineType: string
  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PromisedDeliveryDate: string (date)
  Read Only: true

  Date on which the supplier has promised to deliver the goods to the buying organization.
• PurchaseDocumentAmount: number
  Read Only: true

  The total amount of the line item based on the awarded quantity.
• PurchaseDocumentPrice: number
  Read Only: true

  Price of the line item based on the award quantity.
• Quantity: number
  Read Only: true

  Quantity of the item in the negotiation.
• Rank: number
  Read Only: true

  The rank value displayed for the line item based on the response price.
• RequestedDeliveryDate: string (date)
  Read Only: true

  Date by which delivery of goods is requested from suppliers.
• Requisition: string
  Read Only: true

  Maximum Length: 64

  Requisition number that the negotiation line references.
• RequisitioningBU: string
  Read Only: true

  Maximum Length: 240

  Name of the requisition purchasing unit that the application uses to set default values for each negotiation line.
• RequisitionLine: number
  Read Only: true

  Requisition line number that the negotiation line references.
• ResponseNumber: integer (int64)
  Read Only: true

  Value that uniquely identifies the response.
• ResponsePrice: number
  Read Only: true

  Price given by the supplier for a line item in a supplier negotiation.
• ResponseQuantity: string
  Read Only: true

  Maximum Length: 40

  Quantity given by the supplier for a line item in a supplier negotiation.
• SavingsInAmount: number
  Read Only: true

  Value that identifies the amount of savings generated by awarding the lines to one or more supplier responses.
• SavingsInPercent: number
  Read Only: true

  Value that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation.
• TargetPrice: number
  Read Only: true

  Target price shared by the category manager for a line item in a supplier negotiation.
• UOM: string
  Read Only: true

  Maximum Length: 25

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

{
    "type":"object",
    "properties":{
        "AgreementQuantity":{
            "type":"number",
            "description":"Total quantity of line items recommended for award in a blanket purchase agreement during a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateLineDescription":{
            "maxLength":2500,
            "type":"string",
            "description":"Description of an alternate line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateLineFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if alternate lines are present in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardAmount":{
            "type":"number",
            "description":"Amount awarded to a supplier response line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardQuantity":{
            "type":"number",
            "description":"Total quantity of line items awarded in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"The purchasing category for the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPrice":{
            "type":"number",
            "description":"Price that the procurement organization pays for the item or service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "type":"number",
            "description":"Estimated quantity for the negotiation line on the blanket purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item that the buyer intends to purchase.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the inventory item on the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "maxLength":25,
            "type":"string",
            "description":"Line number of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"number",
            "description":"Unique identifier of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineType":{
            "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-queryable":true
        },
        "PromisedDeliveryDate":{
            "type":"string",
            "description":"Date on which the supplier has promised to deliver the goods to the buying organization.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseDocumentAmount":{
            "type":"number",
            "description":"The total amount of the line item based on the awarded quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseDocumentPrice":{
            "type":"number",
            "description":"Price of the line item based on the award quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"number",
            "description":"The rank value displayed for the line item based on the response price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedDeliveryDate":{
            "type":"string",
            "description":"Date by which delivery of goods is requested from suppliers.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Requisition":{
            "maxLength":64,
            "type":"string",
            "description":"Requisition number that the negotiation line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionLine":{
            "type":"number",
            "description":"Requisition line number that the negotiation line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBU":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the requisition purchasing unit that the application uses to set default values for each negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the response.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponsePrice":{
            "type":"number",
            "description":"Price given by the supplier for a line item in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseQuantity":{
            "maxLength":40,
            "type":"string",
            "description":"Quantity given by the supplier for a line item in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SavingsInAmount":{
            "type":"number",
            "description":"Value that identifies the amount of savings generated by awarding the lines to one or more supplier responses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SavingsInPercent":{
            "type":"number",
            "description":"Value that identifies the savings percentage that's generated from the awarded supplier responses to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPrice":{
            "type":"number",
            "description":"Target price shared by the category manager for a line item in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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