Get all cost factors
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}/child/costFactors
Request
Path Parameters
-
LineId(required): number
Value that uniquely identifies the negotiation line.
-
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 -
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 single cost factor for the negotiation line according to the primary key. The primary key is the combination of AuctionHeaderId, LineId, and CostFactorId.
Finder Variables:- AuctionHeaderId; integer; Value that uniquely identifies the auction header.
- LineCostFactorId; number; Value that uniquely identifies the sequence of the cost factor within a negotiation line.
- LineId; number; Value that uniquely identifies the negotiation line.
- PrimaryKeyFinder: Finds the cost factor according to the cost factor identifier.
Finder Variables:- LineCostFactorId; number; Value that uniquely identifies the sequence of the cost factor within a negotiation line.
- PrimaryKey: Finds the single cost factor for the negotiation line according to the primary key. The primary key is the combination of AuctionHeaderId, LineId, and CostFactorId.
-
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:- AuctionHeaderId; integer; Value that uniquely identifies the negotiation.
- CostFactor; string; Name of the cost factor.
- CostFactorId; integer; Value that identifies the cost factor.
- DisplayTargetFlag; boolean; Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false.
- LineCostFactorId; number; Value that uniquely identifies the sequence of the cost factor within a negotiation line.
- LineId; number; Value that uniquely identifies the negotiation line.
- PricingBasis; string; Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.
- PricingBasisCode; string; Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.
- TargetValue; number; Target value of the cost factor.
-
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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : supplierNegotiations-lines-costFactors
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-costFactors-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CostFactor: string
Title:
Cost Factor
Maximum Length:80
Name of the cost factor. -
CostFactorId: integer
(int64)
Title:
Cost Factor ID
Value that identifies the cost factor. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the cost factor. -
DisplayTargetFlag: boolean
Title:
Display Target
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false. -
Line: number
Read Only:
true
Number that identifies the negotiation line. -
LineCostFactorId: number
Read Only:
true
Value that uniquely identifies the sequence of the cost factor within a negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Title:
Line ID
Read Only:true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingBasis: string
Title:
Pricing Basis
Maximum Length:80
Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS. -
PricingBasisCode: string
Title:
Pricing Basis Code
Maximum Length:30
Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS. -
TargetValue: number
Title:
Target Value
Target value of the cost factor.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all factors.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/lines/LineId/child/costFactors"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AuctionHeaderId": 300100152357495, "LineId": 1, "CostFactorId": 10, "CostFactor": "Assembly Cost", "CostFactorTypeId": 22, "PricingBasis": "Percentage of line price", "PricingBasisCode": "PERCENTAGE", "TargetValue": 100, "DisplayTargetFlag": false, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors/10", "name": "costFactors", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors/10", "name": "costFactors", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1", "name": "lines", "kind": "item" } ] }, { "AuctionHeaderId": 300100152357495, "LineId": 1, "CostFactorId": 20, "CostFactor": "DUTY", "CostFactorTypeId": 64, "PricingBasis": "Percentage of line price", "PricingBasisCode": "PERCENTAGE", "TargetValue": 0.1, "DisplayTargetFlag": false, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors/20", "name": "costFactors", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors/20", "name": "costFactors", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1", "name": "lines", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 10, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors", "name": "costFactors", "kind": "collection" } ] }