Get all acceptable responses
get
/fscmRestApi/resources/11.13.18.05/supplierQualificationQuestions/{QuestionId}/child/acceptableResponses
Request
Path Parameters
-
QuestionId(required): integer(int64)
Value that uniquely identifies the question.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a unique acceptable response according to acceptable response identifier.
Finder Variables:- AcceptableResponseId; integer; Value that uniquely identifies the acceptable response.
- PrimaryKey: Finds a unique acceptable response according to acceptable response identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AcceptableResponseId; integer; Value that uniquely identifies the acceptable response.
- AttachmentAllowed; string; Value that identifies whether the responder is allowed to attach any documents to their responses.
- AttachmentAllowedCode; string; Abbreviation that identifies whether the responder is allowed to attach any documents to their responses.
- AttributeCode; string; Abbreviation that identifies the supplier attribute.
- AttributeId; integer; Value that uniquely identifies the supplier attribute.
- AttributeValueCode; string; Abbreviation that identifies the supplier attribute value.
- Category; string; 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.
- CategoryId; integer; 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.
- CriticalResponseFlag; boolean; 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.
- DisplaySequence; integer; Specifies the order in which the acceptable responses should be displayed to the responder on a questionnaire for this specific question.
- ExcludeScoringFlag; boolean; 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.
- OriginalAcceptableResponseId; integer; Value that uniquely identifies the original account response for propagate responses for a new revision of a question.
- ParentCategoryId; integer; 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.
- PreferredResponseFlag; boolean; 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.
- PurchasingCategoryFlag; boolean; 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.
- QuestionId; integer; Value that uniquely identifies the question an acceptable response applies to.
- ResponseText; string; Text of a manually entered acceptable response value.
- Score; integer; Score that is automatically assigned to the question response if the user selects the corresponding acceptable value as the question response.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : supplierQualificationQuestions-acceptableResponses
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierQualificationQuestions-acceptableResponses-item-response
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the acceptable response.
-
AttachmentAllowed: string
Title:
Response Attachments
Maximum Length:80
Value that identifies whether the responder is allowed to attach any documents to their responses. -
AttachmentAllowedCode: string
Title:
Response Attachments Code
Maximum Length:30
Abbreviation that identifies whether the responder is allowed to attach any documents to their responses. -
AttributeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the supplier attribute. -
AttributeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier attribute. -
AttributeValueCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the supplier attribute value. -
branches: array
Branches
Title:
Branches
The Branches resource gets the branching questions for the acceptable response for a particular question. -
Category: string
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. -
CategoryId: integer
(int64)
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. -
CriticalResponseFlag: boolean
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. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Specifies the order in which the acceptable responses should be displayed to the responder on a questionnaire for this specific question. -
ExcludeScoringFlag: boolean
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalAcceptableResponseId: integer
(int64)
Value that uniquely identifies the original account response for propagate responses for a new revision of a question.
-
ParentCategoryId: integer
(int64)
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. -
PreferredResponseFlag: boolean
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. -
PurchasingCategoryFlag: boolean
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. -
QuestionId: integer
(int64)
Value that uniquely identifies the question an acceptable response applies to.
-
ResponseText: string
Title:
Response Text
Maximum Length:1000
Text of a manually entered acceptable response value. -
Score: integer
(int32)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierQualificationQuestions-acceptableResponses-branches-item-response
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the acceptable response.
-
BranchToQuestionId: integer
(int64)
Value that uniquely identifies the question to branch to after the user selects the acceptable response value.
-
DisplaySequence: integer
(int32)
Title:
Display Sequence
Number that specifies the order in which the branch question should be displayed under the acceptable response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Question: string
Title:
Question
Maximum Length:80
Name of the branching question or identifier entered by the user. -
QuestionBranchesId: integer
(int64)
Value that uniquely identifies the question branch.
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 all acceptable responses.
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"
For example, the following command gets all acceptable responses:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AcceptableResponseId": 300100185020261, "QuestionId": 300100185020258, "DisplaySequence": 10, "ResponseText": "Yes,we agree.", "AttachmentAllowedCode": "NOT_ALLOWED", "AttachmentAllowed": "Not allowed", "PreferredResponseFlag": false, "CategoryId": null, "Category": null, "ParentCategoryId": null, "PurchasingCategoryFlag": null, "AttributeId": null, "AttributeCode": null, "AttributeValueCode": null, "OriginalAcceptableResponseId": 300100185020261, "Score": 100, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses/300100185020261", "name": "acceptableResponses", "kind": "item", "properties": { "changeIndicator": ... } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses/300100185020261", "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/300100185020261/child/branches", "name": "branches", "kind": "collection" } ] }, { "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" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100185020258/child/acceptableResponses", "name": "acceptableResponses", "kind": "collection" } ] }