Get one questionnaire section
get
/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{supplierInitiativesUniqID}/child/questionnaires/{QuestnaireId}/child/questionnaireSections/{QuestnaireSectionId}
Request
Path Parameters
-
QuestnaireId(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=
-
QuestnaireSectionId(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=
-
supplierInitiativesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Initiatives resource and used to uniquely identify an instance of Supplier Initiatives. The client should not generate the hash key value. Instead, the client should query on the Supplier Initiatives collection resource in order to navigate to a specific instance of Supplier Initiatives 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: string
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: string
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 : supplierInitiatives-questionnaires-questionnaireSections-item-response
Type:
Show Source
object-
DisplaySequence: integer
(int32)
Read Only:
trueSpecifies the order in which the sections should be displayed to the responders on a questionnaire. -
Instructions: string
Title:
InstructionsMaximum Length:1000Instructions provided for the questionnaire sections. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
questionnaireQuestions: array
Questions
Title:
QuestionsInitiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled. -
QuestnaireId: integer
(int64)
Value that uniquely identifies the questionnaire.
-
QuestnaireSectionId: integer
(int64)
Value that uniquely identifies the questionnaire section.
-
SectionName: string
Title:
Section NameMaximum Length:80Name of questionnaire section.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Questions
Type:
arrayTitle:
QuestionsInitiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-item-response
Type:
Show Source
object-
AllowRespCommentFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether comments are allowed for the question response. -
AttachmentAllowed: string
Title:
Response AttachmentsRead Only:trueMaximum Length:80Indicates whether response attachments are required, optional, or not allowed. -
AttachmentAllowedCode: string
Read Only:
trueMaximum Length:30Code for whether the response attachment is allowed. -
BranchLevel: integer
(int32)
Read Only:
trueIndicates the level at which the question appears in the questionnaire. -
CategoryCode: string
Read Only:
trueMaximum Length:30Code for identifying the categorization of the supplier attribute. -
DisplayNumber: string
Read Only:
trueMaximum Length:30The question display number in the questionnaire. -
DisplayPreferredRespFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether there is a preferred response. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentAccResponseId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent acceptable response on which the question is based. -
ParentQuestionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent question of a questionnaire question. -
ParentQuestnaireQuestId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent questionnaire question. -
PreferredResponseDate: string
(date)
Title:
Preferred ResponseRead Only:trueValue of the preferred response in Date format. -
PreferredResponseDatetime: string
(date-time)
Title:
Preferred ResponseRead Only:trueValue of the preferred response in Date and Time format. -
PreferredResponseNumber: number
Title:
Preferred ResponseRead Only:trueValue of the preferred response in Number format. -
PreferredResponseText: string
Title:
Preferred ResponseRead Only:trueMaximum Length:4000Value of the preferred response in Text format. -
QuestionHint: string
Title:
HintRead Only:trueMaximum Length:1000Hint to the question. -
QuestionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the Question. -
QuestionLevel: string
Title:
Question LevelRead Only:trueMaximum Length:80Indicates whether the question is relevant to a supplier or to a supplier site. -
QuestionLevelCode: string
Title:
Question LevelRead Only:trueMaximum Length:30Code to specify the question level. -
questionnaireAcceptableResponses: array
Acceptable Responses
Title:
Acceptable ResponsesInitiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled. -
questionnaireQuestionAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
QuestionName: string
Title:
QuestionRead Only:trueMaximum Length:80Name of the questionnaire question. -
QuestionText: string
(byte)
Title:
Question TextRead Only:trueText of the question to be displayed to responders of a questionnaire. -
QuestionType: string
Title:
Question TypeRead Only:trueMaximum Length:80Specifies whether the question is a multiple choice question with single selection, a multiple choice question with multiple selections, or a text entry box question without predefined acceptable responses. -
QuestionTypeCode: string
Title:
Question TypeRead Only:trueMaximum Length:30Code to specify the question type. -
QuestnaireId: integer
(int64)
Read Only:
trueValue that uniquely identifies the questionnaire. -
QuestnaireQuestionId: integer
(int64)
Read Only:
trueValue that uniquely identifies a questionnaire question. -
QuestnaireSectionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the questionnaire section. -
ResponseRequiredFlag: boolean
Title:
Response RequiredRead Only:trueMaximum Length:1Indicates whether the response is required for the question. -
ResponseType: string
Title:
Response TypeRead Only:trueMaximum Length:80Indicates the response type for questions of text entry box type, such as text, number or date. -
ResponseTypeCode: string
Read Only:
trueMaximum Length:30Code to indicate the response type for questions of text entry box type. -
SupplierAttributeCode: string
Title:
Supplier AttributeRead Only:trueMaximum Length:35Code to uniquely identify the supplier attribute that the question is mapped to. -
SupplierAttributeFlag: boolean
Title:
Mapped to Supplier AttributeRead Only:trueMaximum Length:1Indicates whether the question is mapped to an attribute from the supplier profile. -
SupplierAttributeName: string
Title:
Supplier Site AttributeRead Only:trueMaximum Length:200Indicates the supplier attribute that the question is mapped to.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Acceptable Responses
Type:
arrayTitle:
Acceptable ResponsesInitiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireAcceptableResponses-item-response
Type:
Show Source
object-
AccResponseId: integer
(int64)
Read Only:
trueValue that uniquely identifies the question acceptable response. -
DisplayNumber: string
Read Only:
trueMaximum Length:5The display number for the acceptable response to the questionnaire question. -
HasBranchingFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the acceptable response has a questionnaire branching question. This attribute doesn't have a default value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionId: integer
(int64)
Value that uniquely identifies a questionnaire question.
-
QuestnaireAccResponseId: integer
(int64)
Value that uniquely identifies the questionnaire question's acceptable response.
-
QuestnaireId: integer
(int64)
Value that uniquely identifies the questionnaire.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireQuestionAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the content in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attached file. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the topology manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that identifies the web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when creating the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- questionnaireQuestions
-
Parameters:
- QuestnaireId:
$request.path.QuestnaireId - QuestnaireSectionId:
$request.path.QuestnaireSectionId - supplierInitiativesUniqID:
$request.path.supplierInitiativesUniqID
Initiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled. - QuestnaireId: