Get one group

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationResponses/{supplierNegotiationResponsesUniqID}/child/lines/{LineId}/child/lineAttributeGroups/{GroupId}

Request

Path Parameters
  • 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=
  • 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=
  • This is the hash key of the attributes which make up the composite key for the Supplier Negotiation Responses resource and used to uniquely identify an instance of Supplier Negotiation Responses. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiation Responses collection resource in order to navigate to a specific instance of Supplier Negotiation Responses to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : supplierNegotiationResponses-lines-lineAttributeGroups-item-response
Type: object
Show Source
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 : supplierNegotiationResponses-lines-lineAttributeGroups-lineAttributes-item-response
Type: object
Show Source
  • Title: Attribute ID
    Value that identifies the attribute.
  • Title: Attribute
    Read Only: true
    Maximum Length: 4000
    Description of the attribute.
  • Read Only: true
    Maximum Length: 64
    Identifies the user who created the row.
  • Read Only: true
    Timestamp of the creation of the row.
  • Title: Group ID
    Read Only: true
    Value that uniquely identifies the line attribute groups.
  • Title: Group Name
    Read Only: true
    Maximum Length: 240
    Name of the attribute group.
  • Read Only: true
    Timestamp of the last update of the row.
  • Read Only: true
    Maximum Length: 64
    Identifies the user who last updated the row.
  • Title: Line
    Read Only: true
    Maximum Length: 25
    Number that identifies the negotiation line.
  • Title: Description
    Read Only: true
    Maximum Length: 2500
    Description of the line item.
  • Title: Line ID
    Value that identifies the negotiation line.
  • Links
  • Title: Response Date Value
    Response value of the line attribute. This value is a date.
  • Title: Response Number
    Identification number used for the supplier's internal tracking.
  • Title: Response Number Value
    Response value of the line attribute. This value is a number data type.
  • Title: Response Text Value
    Maximum Length: 4000
    Response value for the line attribute. This value is a text data type.
  • Title: Response Type
    Read Only: true
    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.
  • Title: Response Type Code
    Read Only: true
    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.
  • Title: Score
    Value that identifies the score assigned to a supplier's response for a line group, attribute group, or line attribute.
  • Title: Supplier
    Read Only: true
    Maximum Length: 255
    Name of the supplier who responds to the negotiation.
  • Title: Supplier ID
    Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Target Date Value
    Read Only: true
    Target value of the attribute. This value is applicable for dates.
  • Title: Target Number Value
    Read Only: true
    Target value for the attribute. This value is applicable for numbers.
  • Title: Target Text Value
    Read Only: true
    Maximum Length: 4000
    Target text or URL values of the attribute.
  • Title: Value Type
    Read Only: true
    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.
  • Title: Value Type Code
    Read Only: true
    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.
  • Title: Weight
    Read Only: true
    Value that identifies the preference given by the buyer to a particular attribute group.
  • Title: Weighted Score
    Value of an attribute's response by calculating its score relative to its weight. The weighted score is calculated by multiplying its score by its weight, divided by 100.
Back to Top

Examples

This example describes how to get one attribute groups in a negotiation response line using a response ID, a line ID, and a group 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/supplierNegotiationResponses/supplierNegotiationResponsesUniqID/child/lines/LineId/child/lineAttributeGroups/GroupId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175333/child/lines/1/child/lineAttributeGroups/300100581415178"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ResponseNumber": 175333,
    "LineId": 1,
    "Line": "1",
    "LineDescription": "Laptop X800",
    "GroupId": 300100581415178,
    "GroupName": "Additional Details",
    "Weight": 100,
    "Score": 4,
    "WeightedScore": 2,
    "CreatedBy": "Tech Corp",
    "CreationDate": "2023-04-17T12:59:23.507+00:00",
    "SupplierId": 300100036697924,
    "Supplier": "PONSupplier06",
    "LastUpdatedBy": "Tech Corp",
    "LastUpdateDate": "2023-04-17T12:59:48.295+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175333/child/lines/1/child/lineAttributeGroups/300100581415178",
            "name": "lineAttributeGroups",
            "kind": "item",
            "properties": {
                "changeIndicator": ". . ."
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175333/child/lines/1/child/lineAttributeGroups/300100581415178",
            "name": "lineAttributeGroups",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175333/child/lines/1",
            "name": "lines",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175333/child/lines/1/child/lineAttributeGroups/300100581415178/child/lineAttributes",
            "name": "lineAttributes",
            "kind": "collection"
        }
    ]
}
Back to Top