Get one group
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}/child/lineAttributeGroups/{GroupId}
Request
Path Parameters
-
GroupId(required): integer(int64)
Value that identifies the attribute group.
-
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 -
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 : supplierNegotiations-lines-lineAttributeGroups-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the attribute group. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the attribute group. -
GroupId: integer
(int64)
Read Only:
true
Value that identifies the attribute group. -
GroupName: string
Title:
Group
Maximum Length:240
Name of the attribute group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the attribute group. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the attribute group. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
lineAttributes: array
Line Attributes
Title:
Line Attributes
The Line Attributes resource manages details about attributes on the supplier negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Line Attributes
Type:
array
Title:
Line Attributes
The Line Attributes resource manages details about attributes on the supplier negotiation line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-lineAttributeGroups-lineAttributes-item-response
Type:
Show Source
object
-
acceptableResponseScoreValues: array
Response Values
Title:
Response Values
The Response Values resource manages details about score values for an acceptable response when scoring a line attribute. -
AttributeId: number
Read Only:
true
Value that identifies the attribute. -
AttributeName: string
Title:
Attribute
Maximum Length:4000
Description of the attribute. -
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the line attribute. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the line attribute. -
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 attribute target. If false, then do not allow. The default value is false. -
GroupId: integer
(int64)
Read Only:
true
Value that identifies the attribute group. -
GroupName: string
Read Only:
true
Name of the attribute group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the line attribute. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the line attribute. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseType: string
Title:
Response
Maximum Length:80
Specifies whether the response for the line attribute is required. Values include required, optional, or not needed. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE. -
ResponseTypeCode: string
Title:
Response Type Code
Maximum Length:30
Abbreviation that identifies whether the response for the line attribute is required. Valid values are REQUIRED, OPTIONAL, and DISPLAY_ONLY. A list of accepted values is defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE. -
TargetDateValue: string
(date)
Title:
Target Date Value
Target value of the attribute. This value is applicable for dates. -
TargetNumberValue: number
Title:
Target Number Value
Target value for the attribute. This value is applicable for numbers. -
TargetTextValue: string
Title:
Target Text Value
Maximum Length:4000
Target text or URL (Uniform Resource Locator) values of the attribute. -
ValueType: string
Title:
Value Type
Maximum Length:80
Display name of the data type for the attribute response. For example, text, number, date, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type Attribute Value Type. -
ValueTypeCode: string
Title:
Value Type Code
Maximum Length:3
Abbreviation that identifies the type of value for the attribute response. Valid values are TXT, NUM, DAT, and URL. A list of accepted values is defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE. -
Weight: number
Title:
Weight
Importance of the line attribute when compared to other line attributes. The application uses this weight when it calculates the line score.
Nested Schema : Response Values
Type:
array
Title:
Response Values
The Response Values resource manages details about score values for an acceptable response when scoring a line attribute.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-lines-lineAttributeGroups-lineAttributes-acceptableResponseScoreValues-item-response
Type:
Show Source
object
-
AttributeId: number
Read Only:
true
Value that identifies the attribute. -
AttributeName: string
Read Only:
true
Description of the attribute. -
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
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. -
FromDateResponseValue: string
(date)
Title:
From Date Response Value
Earliest date in a date range that the application uses to score each date attribute. -
FromNumberResponseValue: number
Title:
From Number Response Value
Lowest number in a number range that the application uses to score each number attribute. -
GroupName: string
Read Only:
true
Name of the attribute group. -
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. -
Line: string
Read Only:
true
Number that identifies the negotiation line. -
LineDescription: string
Read Only:
true
Description of the negotiation line. -
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Score: number
Title:
Score
Score that the application assigns to each attribute response. -
ScoreId: number
Read Only:
true
Value that uniquely identifies the score. -
TextResponseValue: string
Title:
Text Response Value
Maximum Length:240
Value that the application accepts for the attribute. Applies for text values. -
ToDateResponseValue: string
(date)
Title:
To Date Response Value
Most recent date in the date range that the application uses to score the attribute. This value is applicable for date values. -
ToNumberResponseValue: number
Title:
To Number Response Value
Highest number in the number range that the application uses to score the attribute. This value is applicable for numeric 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.
Links
- lineAttributes
-
Parameters:
- GroupId:
$request.path.GroupId
- LineId:
$request.path.LineId
- supplierNegotiationsUniqID:
$request.path.supplierNegotiationsUniqID
The Line Attributes resource manages details about attributes on the supplier negotiation line. - GroupId:
Examples
This example describes how to get one group.
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/lineAttributeGroups/GroupId"
For example, the following command gets one group where the group identifier is 300100152360639:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/lineAttributeGroups/300100152360639"
Example Response Body
The following shows an example of the response body in JSON format.
{ "AuctionHeaderId": 300100152357495, "LineId": 2, "GroupId": 300100152360639, "GroupName": "Line Attribute group - screen related", "CreationDate": "2018-06-28T12:09:13.037+00:00", "CreatedBy": "CVBUYER01", "LastUpdateDate": "2018-06-28T12:09:35.171+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/lineAttributeGroups/300100152360639", "name": "lineAttributeGroups", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/lineAttributeGroups/300100152360639", "name": "lineAttributeGroups", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2", "name": "lines", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/2/child/lineAttributeGroups/300100152360639/child/lineAttributes", "name": "lineAttributes", "kind": "collection" } ] }