Get one external cost factor
get
/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/lines/{LineId}/child/costFactors/{LineCostFactorId}
Request
Path Parameters
-
LineCostFactorId(required): integer
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=
-
draftSupplierNegotiationResponsesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Draft Supplier Negotiation Responses resource and used to uniquely identify an instance of Draft Supplier Negotiation Responses. The client should not generate the hash key value. Instead, the client should query on the Draft Supplier Negotiation Responses collection resource in order to navigate to a specific instance of Draft Supplier Negotiation Responses to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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 : draftSupplierNegotiationResponses-lines-costFactors-item-response
Type:
Show Source
object
-
CostFactor: string
Title:
Cost Factor
Read Only:true
Maximum Length:80
Name of the cost factor. -
CostFactorId: integer
(int64)
Title:
Cost Factor ID
Read Only:true
Value that identifies the cost factor. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Identifies the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Timestamp of the creation of the row. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the cost factor. -
DisplayTargetFlag: boolean
Title:
Display Target
Read Only:true
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 don't allow it. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Identifies the user who last updated the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Timestamp of the last update of the row. -
Line: string
Read Only:
true
Maximum Length:25
Number that identifies the negotiation line. -
LineCostFactorId: integer
Title:
Line Cost Factor ID
Read Only:true
Value that uniquely identifies the sequence of the cost factor in a negotiation line. -
LineId: integer
Title:
Line ID
Read Only:true
Value that identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingBasis: string
Title:
Pricing Basis
Read Only:true
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
Read Only:true
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. -
ResponseNumber: integer
(int64)
Title:
Response Number
Read Only:true
Value that uniquely identifies the response. -
ResponseValue: number
Title:
Response Value
Supplier's response to the cost factor. -
TargetValue: number
Title:
Target Value
Read Only:true
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 one external cost factor in a negotiation response line using a response ID, line ID, cost factors, and a line cost factor ID.
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/draftSupplierNegotiationResponses/draftSupplierNegotiationResponsesUniqID/child/lines/LineId/child/costFactors/LineCostFactorId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/costFactors/10"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "ResponseNumber": 188787, "LineId": 1, "Line": "1", "LineCostFactorId": 10, "CostFactorId": 22, "CostFactor": "Assembly Cost", "Description": "Assembly Cost Price Element", "TargetValue": null, "ResponseValue": 5, "PricingBasisCode": "PERCENTAGE", "PricingBasis": "Percentage of line price", "DisplayTargetFlag": false, "CreatedBy": "CVSUPPB01", "CreationDate": "2022-04-08T19:39:30+00:00", "LastUpdatedBy": "CVSUPPB01", "LastUpdateDate": "2022-04-08T19:45:50.415+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/costFactors/10", "name": "costFactors", "kind": "item", "properties": { "changeIndicator": "..." } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1/child/costFactors/10", "name": "costFactors", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/lines/1", "name": "lines", "kind": "item" } ] }