Get one value
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/sections/{SectionId}/child/requirements/{RequirementId}/child/acceptableResponseScoreValues/{ScoreId}
Request
Path Parameters
-
RequirementId(required): integer(int64)
Value that uniquely identifies the requirement.
-
ScoreId(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=
-
SectionId(required): integer(int64)
Value that uniquely identifies the section.
-
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 -
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(required):
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(required):
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-sections-requirements-acceptableResponseScoreValues-item-response
Type:
Show Source
object
-
AttachmentsFromSuppliers: string
Title:
Attachments from Suppliers
Maximum Length:80
Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. -
AttachmentsFromSuppliersCode: string
Title:
Attachments from Suppliers Code
Maximum Length:30
Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the acceptable response score value. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the acceptable response score value. -
DateFromRange: string
(date)
Title:
Date from Range
Start date in the range of values. Applies for date attributes. -
DateTimeFromRange: string
(date-time)
Title:
Date Time from Range
Start date and time in the range of values. Applies for date and time attributes. -
DateTimeToRange: string
(date-time)
Title:
Date Time to Range
End date and time in the range of values. Applies for date and time attributes. -
DateToRange: string
(date)
Title:
Date to Range
End Date in the range of values. Applies for date attributes. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the acceptable response score value. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the acceptable response score value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoResponseFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the application to assign a score to each supplier who does not respond to an optional requirement. If false, then do not allow. The default value is false. -
NumberFromRange: number
Title:
Number from Range
Lowest number in a range of values. Applies for number attributes. -
NumberToRange: number
Title:
Number to Range
Highest number in a range of values. Applies for number attributes. -
RequirementId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requirement. -
Score: number
Title:
Score
Score that the application assigns to each attribute response. -
ScoreDisplayNumber: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the score display. The application sets this value for each requirement that uses Multiple Choice With Single Selection or Multiple Choice With Multiple Selections. It also sets this value for each response that replies to a number, date, or date time requirement. -
ScoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the score. -
Section: string
Title:
Section
Read Only:true
Name of the requirement section. -
SectionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the section. -
TargetFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then set the value that the application is willing to accept as the target response value for the requirement. If false, then do not set. The default value is false. -
TextValue: string
Title:
Text Response Value
Maximum Length:1000
Value that the user entered. This value is applicable for text values.
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 value.
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/{AuctionHeaderId}/child/sections/{SectionId}/child/requirements/{RequirementId}/child/acceptableResponseScoreValues/ScoreId"
For example, the following command gets one value where the score identifier is 9106:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/acceptableResponseScoreValues/9106"
Example Response Body
The following shows an example of the response body in JSON format.
{ "RequirementId": 24705, "ScoreId": 9106, "ScoreDisplayNumber": "a.", "TextValue": "4 GB", "NumberFromRange": null, "NumberToRange": null, "DateFromRange": null, "DateToRange": null, "DateTimeFromRange": null, "DateTimeToRange": null, "AttachmentsFromSuppliers": "Not allowed", "AttachmentsFromSuppliersCode": "NOT_ALLOWED", "Score": null, "TargetFlag": false, "NoResponseFlag": false, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T10:46:24+00:00", "LastUpdateDate": "2018-06-28T11:27:25.687+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/acceptableResponseScoreValues/9106", "name": "acceptableResponseScoreValues", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/acceptableResponseScoreValues/9106", "name": "acceptableResponseScoreValues", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705", "name": "requirements", "kind": "item" } ] }