Get one acceptable response

get

/fscmRestApi/resources/11.13.18.05/supplierQualificationQuestions/{QuestionId}/child/acceptableResponses/{AcceptableResponseId}

Request

Path Parameters
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 : supplierQualificationQuestions-acceptableResponses-item-response
Type: object
Show Source
  • Value that uniquely identifies the acceptable response.
  • Title: Response Attachments
    Maximum Length: 80
    Value that identifies whether the responder is allowed to attach any documents to their responses.
  • Title: Response Attachments Code
    Maximum Length: 30
    Abbreviation that identifies whether the responder is allowed to attach any documents to their responses.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the supplier attribute.
  • Read Only: true
    Value that uniquely identifies the supplier attribute.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the supplier attribute value.
  • Branches
    Title: Branches
    The Branches resource gets the branching questions for the acceptable response for a particular question.
  • Read Only: true
    Maximum Length: 250
    Value that indicates the category name of browse category or item category if a question is mapped to products and services. The category name is always stored in session language of the buyer the first time a question is created.
  • Read Only: true
    Value that uniquely identifies whether the question is mapped to browse category or item category when it is mapped to the supplier attribute products and services.
  • Title: Critical Response
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the response is critical for evaluation. If false, then the response is not critical. The default value is false.
  • Title: Display Sequence
    Specifies the order in which the acceptable responses should be displayed to the responder on a questionnaire for this specific question.
  • Title: Exclude from Scoring
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the question is excluded from scoring. If false, then the question is included in scoring. The default value is false.
  • Links
  • Value that uniquely identifies the original account response for propagate responses for a new revision of a question.
  • Read Only: true
    Value that uniquely identifies the immediate parent browse category of a given node, if there is a parent category, when the question is mapped to the supplier attribute products and services.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the response value is the preferred response value for this question when evaluating responses. If false, then the response value is not the preferred response value. The default value is false.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the question belongs to item category. If false, then the question belongs to browse category. The default value is null.
  • Value that uniquely identifies the question an acceptable response applies to.
  • Title: Response Text
    Maximum Length: 1000
    Text of a manually entered acceptable response value.
  • Title: Score
    Score that is automatically assigned to the question response if the user selects the corresponding acceptable value as the question response.
Nested Schema : Branches
Type: array
Title: Branches
The Branches resource gets the branching questions for the acceptable response for a particular question.
Show Source
Nested Schema : supplierQualificationQuestions-acceptableResponses-branches-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get one acceptable response.

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/supplierQualificationQuestions/QuestionId/child/acceptableResponses/AcceptableResponseId"

For example, the following command gets one acceptable response:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses/300100185020264"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"AcceptableResponseId": 300100185020264,
	"QuestionId": 300100185020258,
	"DisplaySequence": 20,
	"ResponseText": "No,we dont.",
	"AttachmentAllowedCode": "NOT_ALLOWED",
	"AttachmentAllowed": "Not allowed",
	"PreferredResponseFlag": false,
	"CategoryId": null,
	"Category": null,
	"ParentCategoryId": null,
	"PurchasingCategoryFlag": null,
	"AttributeId": null,
	"AttributeCode": null,
	"AttributeValueCode": null,
	"OriginalAcceptableResponseId": 300100185020264,
	"Score": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses/300100185020264",
		"name": "acceptableResponses",
		"kind": "item",
		"properties": {
			"changeIndicator": 
			...
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses/300100185020264",
		"name": "acceptableResponses",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258",
		"name": "supplierQualificationQuestions",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses/300100185020264/child/branches",
		"name": "branches",
		"kind": "collection"
	}
	]
}
Back to Top