Get one questionnaire response record
get
/fscmRestApi/resources/11.13.18.05/questionnaireResponses/{QuestionnaireRespHeaderId}
Request
Path Parameters
-
QuestionnaireRespHeaderId(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=
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 : questionnaireResponses-item-response
Type:
Show Source
object
-
AcceptanceDate: string
(date-time)
Title:
Acceptance Date
Read Only:true
Indicates the date when the response to the question was accepted. -
AcceptanceInstanceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the Business Process Execution Language (BPEL) instance ID for acceptance. -
AcceptanceNote: string
Title:
Acceptance Note
Read Only:true
Maximum Length:1000
Note entered by acceptor for a question response at the time of acceptance. -
AcceptanceProcessedStage: string
Read Only:
true
Maximum Length:30
Indicates the stage when acceptance is in progress. -
AcceptanceRecoveredCode: string
Read Only:
true
Maximum Length:1
Indicates if acceptance recovery has started processing. -
AcceptedBy: integer
(int64)
Read Only:
true
Indicates the ID of the user who accepted the response to the questionnaire. -
AcceptedByName: string
Title:
Accepted By
Read Only:true
Maximum Length:240
Person who accepted the response to questionnaire. -
CanceledBy: integer
(int64)
Indicates the ID of the user who canceled the response. The response could be canceled directly or an action on a related entity led to the cancellation of the entity.
-
CanceledByName: string
Title:
Canceled By
Maximum Length:240
Indicates the name of the user who canceled the response. -
CanceledDate: string
(date-time)
Title:
Cancellation Date
Indicates the date of cancellation of response header -
CanceledReasonCode: string
Title:
Canceled Reason
Maximum Length:30
Indicates the reason for cancellation of the questionnaire response. -
CanceledReasonUserText: string
Title:
Canceled Reason
Maximum Length:1000
Indicates the reason when the questionnaire is canceled manually. -
CloseDate: string
(date-time)
Title:
Close Date
Read Only:true
Date on which the questionnaire was closed for responding. -
ClosedBy: integer
(int64)
Read Only:
true
Indicates the ID of the user who closed the questionnaire. The response could be closed directly or because the open period ended. -
ClosedByName: string
Title:
Closed By
Read Only:true
Maximum Length:240
Indicates the name of the user who closed the questionnaire. The response could be closed directly or because the open period ended. -
InitiativeId: integer
(int64)
Value that uniquely identifies an initiative that contains the questionnaire.
-
InitiativeSuppContactId: integer
(int64)
Value that uniquely identifies the supplier contact specified on the initiative for a questionnaire.
-
InitiativeSupplierContactName: string
Title:
Initiative Supplier Details
Read Only:true
Maximum Length:240
Indicates the name of the supplier contact specified on the initiative for a questionnaire to be sent to the supplier or supplier site. -
InternalRespondentId: integer
(int64)
Indicates the person identifier of the internal responder.
-
InternalResponderName: string
Title:
Internal Responder
Read Only:true
Maximum Length:240
Indicates the name of the internal responder that the questionnaire was sent to. -
Introduction: string
Title:
Introduction
Read Only:true
Maximum Length:4000
Introduction to the questionnaire. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MergeRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier merge request ID. -
ProcurementBU: string
Title:
Owning Procurement BU
Read Only:true
Maximum Length:240
Name of the procurement business unit associated with the questionnaire response. -
ProcurementBUId: integer
(int64)
Title:
Owning Procurement BU ID
Value that uniquely identifies the procurement business unit for questionnaire response. -
questionnaireAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
QuestionnaireRespHeaderId: integer
(int64)
Indicates an Internal system identifier for a questionnaire response.
-
questionnaireResponseSections: array
Questionnaire Response Sections
Title:
Questionnaire Response Sections
The Questionnaire Response Sections resource stores details about various sections included in a questionnaire response. -
QuestionnaireType: string
Title:
Questionnaire Type
Read Only:true
Maximum Length:80
Type of the questionnaire such as supplier or internal responder. -
QuestionnaireTypeCode: string
Read Only:
true
Maximum Length:30
Code for the type of the questionnaire such as supplier questionnaire or internal questionnaire. -
QuestionnaireUsage: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of the questionnaire usage such as checklist or qualification. -
QuestionnaireUsageCode: string
Read Only:
true
Maximum Length:30
Code for the type of questionnaire usage. -
QuestnaireId: integer
(int64)
Value that uniquely identifies a questionnaire.
-
RecentNotificationFlag: boolean
Title:
Received
Read Only:true
Maximum Length:1
A value to indicate that the supplier contact or internal responder for this response has been updated and a response to the questionnaire notification needs to be sent to the new contact. -
RecoveredBy: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who recovered the questionnaire. -
RecoveredDate: string
(date-time)
Read Only:
true
Date when the questionnaire was recovered. -
RequestErrorReason: string
Read Only:
true
Maximum Length:4000
Indicates the reason why the questionnaire response was rejected or couldn't be processed. -
ResponseStatus: string
Title:
Response Status
Maximum Length:80
Indicates the status of the response to questionnaire. -
ResponseStatusCode: string
Maximum Length:
30
Code for the status of the response to questionnaire. -
ReturnedBy: integer
(int64)
Read Only:
true
Value that uniquely Identifies the person who returned the response to the responder. -
ReturnedByName: string
Title:
Returned By
Read Only:true
Maximum Length:240
Name of the person who returned the response to the responder. -
ReturnedDate: string
(date-time)
Title:
Return Date
Read Only:true
Date on which the response was returned to the responder. -
ReturnMessageContent: string
(byte)
Title:
Return Reason
Read Only:true
Indicates the message content sent to the responder when the response was returned. -
SubmissionDate: string
(date-time)
Title:
Submission Date
Date when the response to a questionnaire is submitted. -
SubmittedBy: integer
(int64)
Indicates the person who submitted the response to questionnaire.
-
SubmittedByName: string
Title:
Entered By
Maximum Length:240
Name of the person who submitted the response to the questionnaire. -
SupplierContactPartyId: integer
(int64)
Read Only:
true
Value that uniquely Identifies the contact person for a supplier or supplier site. -
SupplierContactPartyName: string
Title:
Supplier Contact
Read Only:true
Maximum Length:240
Name of the contact person for a supplier or supplier site. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely Identifies the Supplier who's being responded. -
SupplierName: string
Title:
Supplier
Read Only:true
Maximum Length:360
Name of the supplier who's being responded to. -
SupplierSiteId: integer
(int64)
Value that uniquely Identifies the Supplier site.
-
SupplierSiteName: string
Title:
Supplier Site
Read Only:true
Maximum Length:240
Name of the supplier site. -
SurrogateEnteredByName: string
Title:
Surrogate Entered By
Read Only:true
Maximum Length:240
Name of the user who entered the surrogate response for the questionnaire on behalf of the supplier or internal responder. -
SurrogEnteredBy: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who entered the surrogate response for the questionnaire on behalf of the supplier or internal responder. -
SurrogEntryDate: string
(date-time)
Title:
Surrogate Entry Date
Read Only:true
Surrogate entry date is the date on which qualification manager submitted the response. -
SurrogResponseFlag: boolean
Title:
Surrogate Response
Read Only:true
Maximum Length:1
Indicates if a response is a surrogate response entered by qualification manager on behalf of supplier or internal responder.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Sections
Type:
array
Title:
Questionnaire Response Sections
The Questionnaire Response Sections resource stores details about various sections included in a questionnaire response.
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.
Nested Schema : questionnaireResponses-questionnaireAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-item-response
Type:
Show Source
object
-
DisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
Specifies the order in which the sections should be displayed to the responders on a questionnaire. -
Instructions: string
Title:
Instructions
Read Only:true
Maximum Length:1000
Indicates the instructions provided to the person responding to questionnaire. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionnaireRespHeaderId: integer
(int64)
Indicates an Internal system identifier for a questionnaire response.
-
questionnaireResponseDetails: array
Questionnaire Response Details
Title:
Questionnaire Response Details
The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire. -
QuestionnaireRespSectionId: integer
(int64)
Indicates value that uniquely identifies a questionnaire response section.
-
QuestionnaireSectionId: integer
(int64)
Indicates an Internal system identifier for a questionnaire section.
-
QuestionnaireSectionName: string
Title:
Section Name
Read Only:true
Maximum Length:80
Indicates the name of a section in questionnaire. -
SectionCompletedFlag: string
Title:
Section Completed
Maximum Length:1
Value indicates section response is completed. -
SectionGeneratedFlag: boolean
Title:
Section Generated
Read Only:true
Maximum Length:1
Indicates if section was generated into the questionnaire response.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Questionnaire Response Details
Type:
array
Title:
Questionnaire Response Details
The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-response
Type:
Show Source
object
-
AcceptanceNote: string
Read Only:
true
Maximum Length:1000
Note entered by acceptor at the time of acceptance. -
AllowRespCommentFlag: boolean
Title:
Allow comments from responder
Read Only:true
Maximum Length:1
Indicates whether comments are allowed for the question response. -
AttachmentAllowed: string
Title:
Response Attachments
Read Only:true
Maximum Length:80
Indicates whether response attachments are required, optional, or not allowed. -
AttachmentAllowedCode: string
Read Only:
true
Maximum Length:30
Code for whether the response attachment is allowed. -
BranchLevel: integer
(int32)
Title:
Branch Level
Read Only:true
Indicates the level at which question is appearing in the questionnaire. -
Category: string
Title:
Category
Read Only:true
Maximum Length:80
Indicates the categorization of the supplier attribute that the question is mapped to. -
CategoryCode: string
Read Only:
true
Maximum Length:30
Code for identifying the categorization of the supplier attribute. -
DisplayNumber: string
Title:
Number
Read Only:true
Maximum Length:30
Indicates the order in which the questions are displayed. -
DisplayPreferredRespFlag: boolean
Title:
Display preferred response
Read Only:true
Maximum Length:1
Indicates whether there is a preferred response. -
DisplaySequence: integer
(int32)
Read Only:
true
Value that indicates the display sequence of the responses. -
FailedPozValidationFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that this response failed POZ validation and this response will be ignored -
HasNewerResponseFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that a newer response is available and this response will be ignored. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappedToPrereqQuestionFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the question is mapped to a prerequisite question. -
ParentAcceptableResponseId: integer
(int64)
Read Only:
true
Indicates the ID for the acceptable response that the branching question belongs to. -
ParentQuestionnaireQuestId: integer
(int64)
Read Only:
true
Value that uniquely identifies Questionnaire question from the questionnaires table. -
PreferredResponseDate: string
(date)
Title:
Preferred Response Date
Read Only:true
Value of the preferred response in Date format. -
PreferredResponseDatetime: string
(date-time)
Title:
Preferred Response Date and Time
Read Only:true
Value of the preferred response in Date and Time format. -
PreferredResponseNumber: number
Title:
Preferred Response Number
Read Only:true
Value of the preferred response in Number format. -
PreferredResponseText: string
Title:
Preferred Response Text
Read Only:true
Maximum Length:4000
Value of the preferred response in Text format. -
questionAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
QuestionDisplayedFlag: boolean
Title:
Question Displayed
Maximum Length:1
Indicates if the questions were shown to the responders at the time of response submission. -
QuestionHint: string
Title:
Hint
Read Only:true
Maximum Length:1000
Hint to the question. -
QuestionId: integer
(int64)
Identifier of the questionnaire question.
-
QuestionnaireQuestionId: integer
(int64)
Value that uniquely identifies Questionnaire question from the questionnaires table.
-
QuestionnaireRespHeaderId: integer
(int64)
Value that uniquely Identifies the response to questionnaire.
-
QuestionnaireResponseId: integer
(int64)
Value that uniquely identifies a questionnaire question response.
-
questionnaireResponseValues: array
Questionnaire Response Values
Title:
Questionnaire Response Values
The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire. -
QuestionnaireRespSectionId: integer
(int64)
Value that uniquely identifies the section of questionnaire.
-
QuestionName: string
Title:
Question
Read Only:true
Maximum Length:80
Name of the questionnaire question. -
QuestionPlainText: string
(byte)
Title:
Question Text
Read Only:true
Text of the question to be displayed to responders of a questionnaire. -
QuestionText: string
(byte)
Title:
Question Text
Read Only:true
Text of the question to be displayed to responders of a questionnaire. -
QuestionType: string
Title:
Question Type
Read Only:true
Maximum Length:80
Specifies 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 Type
Read Only:true
Maximum Length:30
Code to specify the question type. -
ResponseComments: string
Title:
Comments
Maximum Length:1000
Comments entered by supplier or internal respondent for response to a question. -
ResponseRequiredFlag: boolean
Title:
Response Required
Read Only:true
Maximum Length:1
Indicates whether the response is required for the question. -
ResponseType: string
Title:
Response Type
Read Only:true
Maximum Length:80
Indicates the response type for questions of text entry box type, such as text, number or date. -
ResponseTypeCode: string
Read Only:
true
Maximum Length:30
Code to indicate the response type for questions of text entry box type. -
SupplierAttributeCode: string
Title:
Supplier Attribute
Read Only:true
Maximum Length:35
Code to uniquely identify the supplier attribute that the question is mapped to. -
SupplierAttributeFlag: boolean
Title:
Supplier Attribute
Read Only:true
Maximum Length:1
Indicates whether the question is mapped to an attribute from the supplier profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Values
Type:
array
Title:
Questionnaire Response Values
The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-response
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that identifies the acceptable response from poq_ques_acc_responses.
-
AttachmentAllowed: string
Title:
Response Attachments
Read Only:true
Maximum Length:80
Indicates whether response attachments are required, optional, or not allowed. -
AttachmentAllowedCode: string
Read Only:
true
Maximum Length:30
Code for whether the response attachment is allowed. -
DisplayNumber: string
Title:
Number
Read Only:true
Maximum Length:5
Specifies the display number for the acceptable response that will be shown on a questionnaire for this specific question. -
DisplaySequence: integer
(int32)
Read Only:
true
Value that indicates the display sequence of the response values. -
FromUI: string
Maximum Length:
1
Value was provided through the user interface. -
HasBranchingFlag: boolean
Title:
Has Branching
Read Only:true
Maximum Length:1
Indicates whether the response value has branching questions. -
IsSelectedFlag: boolean
Title:
Response Selected
Maximum Length:1
Indicates if acceptable response value is selected by the responder or not. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreferredResponseFlag: boolean
Title:
Preferred Response
Read Only:true
Maximum Length:1
Indicates whether there is a preferred response. -
QuestionnaireAccResponseId: integer
(int64)
Value that uniquely identifies the questionnaire's acceptable response.
-
QuestionnaireResponseId: integer
(int64)
Value that uniquely Identifies a response to questionnaire question.
-
QuestionnaireRespValueId: integer
(int64)
Value that uniquely identifies a response to question.
-
responseAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
ResponseText: string
Title:
Acceptable Response Text
Read Only:true
Maximum Length:1000
The text of a manually entered response value to a questionnaire question. -
ResponseValueDate: string
(date)
Title:
Response Value Date
Indicates a response value for a questionnaire question setup with response type as date. -
ResponseValueDatetime: string
(date-time)
Title:
Response Value Date Time
Indicates a response value for a questionnaire question setup with response type as date and time. -
ResponseValueNumber: number
Title:
Response Value Number
Indicates a response value for a questionnaire question setup with response type as number. -
ResponseValueText: string
Title:
Response Value Text
Maximum Length:4000
Indicates a response value for a questionnaire question setup with response type as text.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- questionnaireAttachments
-
Parameters:
- QuestionnaireRespHeaderId:
$request.path.QuestionnaireRespHeaderId
The attachments resource is used to view, create, and update attachments. - QuestionnaireRespHeaderId:
- questionnaireResponseSections
-
Parameters:
- QuestionnaireRespHeaderId:
$request.path.QuestionnaireRespHeaderId
The Questionnaire Response Sections resource stores details about various sections included in a questionnaire response. - QuestionnaireRespHeaderId:
Examples
This example describes how to get one questionnaire 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/questionnaireResponses/QuestionnaireRespHeaderId"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "QuestionnaireRespHeaderId": 300100584908955, "InitiativeId": 300100584908906, "QuestnaireId": 300100584908911, "QuestionnaireTypeCode": "SUPPLIER", "QuestionnaireType": "Supplier", "QuestionnaireUsageCode": "ORA_CHECKLIST", "QuestionnaireUsage": "Checklist", "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "ResponseStatusCode": "DRAFT", "ResponseStatus": "Draft", "Introduction": null, "SupplierId": -1, "SupplierName": null, "SupplierSiteId": null, "SupplierSiteName": null, "SupplierContactPartyId": null, "SupplierContactPartyName": null, "InternalRespondentId": null, "InternalResponderName": null, "InitiativeSuppContactId": null, "InitiativeSupplierContactName": null, "SubmissionDate": null, "SubmittedBy": 100010026863783, "SubmittedByName": "Furey,Clare", "SurrogResponseFlag": null, "SurrogEntryDate": null, "SurrogEnteredBy": null, "SurrogateEnteredByName": null, "AcceptanceDate": null, "AcceptedBy": null, "AcceptedByName": null, "AcceptanceNote": null, "CanceledDate": null, "CanceledBy": null, "CanceledByName": null, "CanceledReasonCode": null, "CanceledReasonUserText": null, "ReturnedDate": null, "ReturnedBy": null, "ReturnedByName": null, "RequestErrorReason": null, "RecentNotificationFlag": null, "MergeRequestId": null, "CloseDate": null, "ClosedBy": null, "ClosedByName": null, "AcceptanceProcessedStage": null, "AcceptanceRecoveredCode": null, "AcceptanceInstanceId": null, "RecoveredBy": null, "RecoveredDate": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955", "name": "questionnaireResponses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955", "name": "questionnaireResponses", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireAttachments", "name": "questionnaireAttachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireResponseSections", "name": "questionnaireResponseSections", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/enclosure/ReturnMessageContent", "name": "ReturnMessageContent", "kind": "other" } ] }