Jump to

• Request
• Response

Get one awarded response for a negotiation line

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/child/lines/{LineId}/child/awardedResponseDetails/{ResponseNumber}

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=
• LineId(required): number
  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
• 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 : supplierNegotiationAwards-lines-awardedResponseDetails-item-response

Type: object

Show Source

• AlternateLineDescription: string
  Title: Alternate Line Description

  Read Only: true

  Maximum Length: 2500

  Description of an alternate line.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the negotiation.
• AwardAmount: number
  Title: Award Amount

  Read Only: true

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

  Total quantity awarded for auction.
• AwardPrice: number
  Title: Award Price

  Read Only: true

  Final price of the awarded line items.
• AwardStatusCode: string
  Read Only: true

  Maximum Length: 25

  Value that identifies whether the response was awarded or rejected.
• BestResponseNumber: integer (int64)
  Read Only: true

  Number of the best response for the negotiation line among all responses.
• BusinessRelationshipCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the business relationship of the supplier's enterprise. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Value that identifies the code of the currency used by buyer organization.
• 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.
• Line: string
  Read Only: true

  Maximum Length: 25

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

  Unique identifier of the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartialResponseFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the supplier has submitted a partial response. A partial response means the supplier hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line.
• Price: number
  Read Only: true

  All Bids
• PromisedDeliveryDate: string (date)
  Title: Promised Date

  Read Only: true

  Date on which the supplier has promised to deliver the goods to the buying organization.
• PromisedShipDate: string (date)
  Title: Promised Ship Date

  Read Only: true

  Date on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms.
• PurchaseDocumentAmount: number
  Title: Purchasing Document Amount

  Read Only: true

  The total amount of the line item based on the awarded quantity.
• PurchaseDocumentPrice: number
  Title: Purchasing Document Price

  Read Only: true

  Price of the line item based on the award quantity.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity of the item in the negotiation.
• Rank: string
  Title: Rank

  Read Only: true

  Maximum Length: 255

  The rank value displayed for the line item based on the response price.
• ResponseAmount: number
  Read Only: true

  Total amount calculated for all line items that the supplier offered a price for when responding to a negotiation.
• ResponseNumber: integer (int64)
  Read Only: true

  Value that uniquely identifies the response.
• ResponseStatusCode: string
  Read Only: true

  Maximum Length: 25

  Value that uniquely identifies the response status.
• SavingsInAmount: number
  Title: Savings

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Status code of the supplier's spend authorization review. Accepted values include PENDING_APPROVAL and REJECTED.
• Supplier: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier who responds to the negotiation.
• SupplierContact: string
  Title: Supplier Contact

  Read Only: true

  Maximum Length: 255

  Name of the supplier contact at the supplier that responds to the negotiation.
• SupplierContactId: integer (int64)
  Read Only: true

  Value that identifies the contact of the supplier who responds to the negotiation.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.
• SupplierSite: string
  Read Only: true

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that identifies the supplier site.
• TechnicalEvaluationStatusCode: string
  Read Only: true

  Maximum Length: 30

  Value that identifies the technical evaluation completion status.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure for the item in the negotiation.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item in the negotiation.
• VendorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bidder.

{
    "type":"object",
    "properties":{
        "AlternateLineDescription":{
            "title":"Alternate Line Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of an alternate line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AwardAmount":{
            "title":"Award Amount",
            "type":"number",
            "description":"Amount awarded to a supplier response line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardPrice":{
            "title":"Award Price",
            "type":"number",
            "description":"Final price of the awarded line items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Value that identifies whether the response was awarded or rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardedQuantity":{
            "type":"number",
            "description":"Total quantity awarded for auction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BestResponseNumber":{
            "type":"integer",
            "description":"Number of the best response for the negotiation line among all responses.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessRelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the business relationship of the supplier's enterprise. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the code of the currency used by buyer organization.",
            "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
        },
        "Line":{
            "maxLength":25,
            "type":"string",
            "description":"Line number 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
        },
        "PartialResponseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the supplier has submitted a partial response. A partial response means the supplier hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"All Bids",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedDeliveryDate":{
            "title":"Promised Date",
            "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
        },
        "PromisedShipDate":{
            "title":"Promised Ship Date",
            "type":"string",
            "description":"Date on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseDocumentAmount":{
            "title":"Purchasing Document Amount",
            "type":"number",
            "description":"The total amount of the line item based on the awarded quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseDocumentPrice":{
            "title":"Purchasing Document Price",
            "type":"number",
            "description":"Price of the line item based on the award quantity.",
            "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
        },
        "Rank":{
            "title":"Rank",
            "maxLength":255,
            "type":"string",
            "description":"The rank value displayed for the line item based on the response price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseAmount":{
            "type":"number",
            "description":"Total amount calculated for all line items that the supplier offered a price for when responding to a negotiation.",
            "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
        },
        "ResponseStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Value that uniquely identifies the response status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SavingsInAmount":{
            "title":"Savings",
            "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":{
            "title":"Savings",
            "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
        },
        "SpendAuthorizationReviewStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the supplier's spend authorization review. Accepted values include PENDING_APPROVAL and REJECTED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier who responds to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierContact":{
            "title":"Supplier Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier contact at the supplier that responds to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the contact of the supplier who responds to the negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TechnicalEvaluationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the technical evaluation completion status.",
            "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
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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