Jump to

• Request
• Response

Get allocation data for a given line and all awarded responses

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationPurchasingDocuments/{AuctionHeaderId}/child/lineAllocationsSummary/{lineAllocationsSummaryUniqID}/child/lineAllocationsByResponse

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=
• lineAllocationsSummaryUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AuctionHeaderId and LineNumber ---for the Line Allocations Summary resource and used to uniquely identify an instance of Line Allocations Summary. The client should not generate the hash key value. Instead, the client should query on the Line Allocations Summary collection resource with a filter on the primary key values in order to navigate to a specific instance of Line Allocations Summary.
  
  For example: lineAllocationsSummary?q=AuctionHeaderId=<value1>;LineNumber=<value2>

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 line allocation detail for a given response, response line number, and requisition line number using the primary key.
    Finder Variables
    • BidLineNumber; number; Finds line allocation details using the BidLineNumber; number; as the primary key.
    • BidNumber; integer; Finds line allocation details using the BidNumber; integer; as the primary key.
    • RequisitionLineId; integer; Finds line allocation details using the RequisitionLineId; integer; as the primary key.
• 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:
  

  • AllocatedAwardQuantity; number; Award quantity allocated to requisition demand.
  • AlternateLineDescription; string; Description of the alternate line item that the supplier is offering to provide in response to a negotiation line.
  • AlternateLineFlag; boolean; Contains one of the following values: true or false. If true, the alternate lines are displayed. If false, the alternate lines aren't displayed.
  • AuctionHeaderId; integer; Value that uniquely identifies a negotiation.
  • AvailableAwardQuantity; number; Award quantity that isn't yet allocated to requisition demand.
  • AwardQuantity; number; Total quantity of line items awarded in a supplier negotiation.
  • BidLineNumber; number; Bid line item number.
  • BidNumber; integer; Value that uniquely identifies a negotiation response.
  • NegotiationDisplayLineNumber; string; Value that identifies the line number of the negotiation line. For an alternate line, the value refers to the line number of the original negotiation line for which the alternate was created.
  • PartyName; string; Name of the supplier company that the application invited in response to the negotiation.
  • PromisedDeliveryDate; string; Date on which the supplier has promised to deliver the goods to the buying organization.
  • PromisedShipDate; string; 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.
  • RequestedDeliveryDate; string; Date when the application requests to deliver the item that the negotiation line references.
  • RequestedShipDate; string; Date when the application requests to ship the item that the negotiation line references.
  • RequisitionHeaderId; integer; Value that uniquely identifies a requisition.
  • RequisitionLineId; integer; Get one negotiation detail
  • RequisitionLineNumber; number; Requisition line number that the negotiation line references.
  • RequisitionNumber; string; Requisition number that the negotiation line references.
  • RequisitionQuantity; number; Quantity of the requisition line items.
  • SupplierContact; string; Name of the supplier's employee who represents the supplier in communication with the buying organization.
  • SupplierSiteCode; string; Unique identifier of the supplier site.
  • UnitOfMeasure; string; Abbreviation that identifies the unit of measure for the item in the negotiation.
  • UnitOfMeasureCode; string; Code for 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 : supplierNegotiationPurchasingDocuments-lineAllocationsSummary-lineAllocationsByResponse

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/supplierNegotiationPurchasingDocuments-lineAllocationsSummary-lineAllocationsByResponse-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 supplierNegotiationPurchasingDocuments-lineAllocationsSummary-lineAllocationsByResponse-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationPurchasingDocuments-lineAllocationsSummary-lineAllocationsByResponse-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 : supplierNegotiationPurchasingDocuments-lineAllocationsSummary-lineAllocationsByResponse-item-response

Type: object

Show Source

• AllocatedAwardQuantity: number
  Title: Allocated Award Quantity

  Award quantity allocated to requisition demand.
• AlternateLineDescription: string
  Title: Alternate Line Description

  Read Only: true

  Maximum Length: 2500

  Description of the alternate line item that the supplier is offering to provide in response to a negotiation line.
• AlternateLineFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, the alternate lines are displayed. If false, the alternate lines aren't displayed.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies a negotiation.
• AvailableAwardQuantity: number
  Title: Available Award Quantity

  Read Only: true

  Award quantity that isn't yet allocated to requisition demand.
• AwardQuantity: number
  Title: Award Quantity per Response

  Read Only: true

  Total quantity of line items awarded in a supplier negotiation.
• BidLineNumber: number
  Title: Line

  Read Only: true

  Bid line item number.
• BidNumber: integer (int64)
  Title: Response

  Read Only: true

  Value that uniquely identifies a negotiation response.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiationDisplayLineNumber: string
  Title: Alternate Line

  Read Only: true

  Maximum Length: 25

  Value that identifies the line number of the negotiation line. For an alternate line, the value refers to the line number of the original negotiation line for which the alternate was created.
• PartyName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the supplier company that the application invited in response to the negotiation.
• PromisedDeliveryDate: string (date)
  Title: Promised Delivery 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.
• RequestedDeliveryDate: string (date)
  Title: Requested Delivery Date

  Read Only: true

  Date when the application requests to deliver the item that the negotiation line references.
• RequestedShipDate: string (date)
  Title: Requested Ship Date

  Read Only: true

  Date when the application requests to ship the item that the negotiation line references.
• RequisitionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies a requisition.
• RequisitionLineId: integer (int64)
  Read Only: true

  Get one negotiation detail
• RequisitionLineNumber: number
  Title: Requisition Line

  Read Only: true

  Requisition line number that the negotiation line references.
• RequisitionNumber: string
  Title: Requisition

  Read Only: true

  Maximum Length: 64

  Requisition number that the negotiation line references.
• RequisitionQuantity: number
  Title: Requisition Line Quantity

  Read Only: true

  Quantity of the requisition line items.
• SupplierContact: string
  Title: Supplier Contact

  Read Only: true

  Maximum Length: 255

  Name of the supplier's employee who represents the supplier in communication with the buying organization.
• SupplierSiteCode: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Unique identifier of the supplier site.
• UnitOfMeasure: string
  Title: UOM

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the unit of measure for the item in the negotiation.
• UnitOfMeasureCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

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

{
    "type":"object",
    "properties":{
        "AllocatedAwardQuantity":{
            "title":"Allocated Award Quantity",
            "type":"number",
            "description":"Award quantity allocated to requisition demand.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateLineDescription":{
            "title":"Alternate Line Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the alternate line item that the supplier is offering to provide in response to a negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateLineFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the alternate lines are displayed. If false, the alternate lines aren't displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies a negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AvailableAwardQuantity":{
            "title":"Available Award Quantity",
            "type":"number",
            "description":"Award quantity that isn't yet allocated to requisition demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardQuantity":{
            "title":"Award Quantity per Response",
            "type":"number",
            "description":"Total quantity of line items awarded in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BidLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Bid line item number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BidNumber":{
            "title":"Response",
            "type":"integer",
            "description":"Value that uniquely identifies a negotiation response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NegotiationDisplayLineNumber":{
            "title":"Alternate Line",
            "maxLength":25,
            "type":"string",
            "description":"Value that identifies the line number of the negotiation line. For an alternate line, the value refers to the line number of the original negotiation line for which the alternate was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier company that the application invited in response to the negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedDeliveryDate":{
            "title":"Promised Delivery 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
        },
        "RequestedDeliveryDate":{
            "title":"Requested Delivery Date",
            "type":"string",
            "description":"Date when the application requests to deliver the item that the negotiation line references.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedShipDate":{
            "title":"Requested Ship Date",
            "type":"string",
            "description":"Date when the application requests to ship the item that the negotiation line references.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies a requisition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionLineId":{
            "type":"integer",
            "description":"Get one negotiation detail",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionLineNumber":{
            "title":"Requisition Line",
            "type":"number",
            "description":"Requisition line number that the negotiation line references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition",
            "maxLength":64,
            "type":"string",
            "description":"Requisition number that the negotiation line references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionQuantity":{
            "title":"Requisition Line Quantity",
            "type":"number",
            "description":"Quantity of the requisition line items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierContact":{
            "title":"Supplier Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier's employee who represents the supplier in communication with the buying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Unique identifier of the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item in the negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Code for the unit of measure for the item in the negotiation.",
            "nullable":false,
            "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