Update one questionnaire response record
patch
/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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
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 ByMaximum Length:240Indicates the name of the user who canceled the response. -
CanceledDate: string
(date-time)
Title:
Cancellation DateIndicates the date of cancellation of response header -
CanceledReasonCode: string
Title:
Canceled ReasonMaximum Length:30Indicates the reason for cancellation of the questionnaire response. -
CanceledReasonUserText: string
Title:
Canceled ReasonMaximum Length:1000Indicates the reason when the questionnaire is canceled manually. -
questionnaireAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
questionnaireResponseSections: array
Questionnaire Response Sections
Title:
Questionnaire Response SectionsThe Questionnaire Response Sections resource stores details about various sections included in a questionnaire response. -
RecoveredById: integer
(int64)
Value that uniquely identifies the user who recovered the questionnaire.
-
ResponseStatus: string
Title:
Response StatusMaximum Length:80Indicates the status of the response to questionnaire. -
ResponseStatusCode: string
Maximum Length:
30Code for the status of the response to questionnaire. -
SubmissionDate: string
(date-time)
Title:
Submission DateDate when the response to a questionnaire is submitted. -
SubmittedBy: integer
(int64)
Indicates the person who submitted the response to questionnaire.
-
SubmittedByName: string
Title:
Entered ByMaximum Length:240Name of the person who submitted the response to the questionnaire.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Sections
Type:
arrayTitle:
Questionnaire Response SectionsThe Questionnaire Response Sections resource stores details about various sections included in a questionnaire response.
Show Source
Nested Schema : questionnaireResponses-questionnaireAttachments-item-patch-request
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : questionnaireResponses-questionnaireResponseSections-item-patch-request
Type:
Show Source
object-
questionnaireResponseDetails: array
Questionnaire Response Details
Title:
Questionnaire Response DetailsThe Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire. -
SectionCompletedFlag: string
Title:
Section CompletedMaximum Length:1Value indicates section response is completed.
Nested Schema : Questionnaire Response Details
Type:
arrayTitle:
Questionnaire Response DetailsThe 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-patch-request
Type:
Show Source
object-
businessClassifications: array
Business Classifications
Title:
Business ClassificationsChanges to business classifications associated with a supplier, made by supplier users, are submitted for approval to the buying organization. Once approved, these changes are reflected in the supplier profile. This resource is linked to a feature that requires opt-in. -
questionAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
QuestionDisplayedFlag: boolean
Title:
Question DisplayedMaximum Length:1Indicates if the questions were shown to the responders at the time of response submission. -
questionnaireResponseValues: array
Questionnaire Response Values
Title:
Questionnaire Response ValuesThe Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire. -
ResponseComments: string
Title:
CommentsMaximum Length:1000Comments entered by supplier or internal respondent for response to a question.
Nested Schema : Business Classifications
Type:
arrayTitle:
Business ClassificationsChanges to business classifications associated with a supplier, made by supplier users, are submitted for approval to the buying organization. Once approved, these changes are reflected in the supplier profile. This resource is linked to a feature that requires opt-in.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Values
Type:
arrayTitle:
Questionnaire Response ValuesThe 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 : schema
Type:
Show Source
object-
BusClassCode: string
Title:
ClassificationMaximum Length:30Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task. -
businessClassificationAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CertificationNo: string
Title:
Certificate NumberMaximum Length:80Certificate that the certifying agency issues for the business classification. -
CertifyingAgencyId: integer
(int64)
Value that uniquely identifies the agency responsible for certifying the business classification for the supplier.
-
CertifyingAgencyName: string
Title:
Certifying AgencyMaximum Length:255Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require. -
ConfirmedOn: string
(date)
Title:
Confirmed OnDate when the application confirmed the business classification for the supplier. -
ExpirationDate: string
(date)
Title:
Certificate End DateDate on which the certificate that the certifying agency issues for the business classification expires. -
MappingId: integer
Value that uniquely identifies the mapping between the supplier business classification and the question.
-
Notes: string
Title:
NotesMaximum Length:1000Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes. -
OtherCertifyingAgency: string
Title:
Other Certifying AgencyMaximum Length:255Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require. -
ProvidedByContactId: integer
(int64)
Value that uniquely identifies the person in the supplier organization who provides the business classification details.
-
ProvidedByContactName: string
Title:
Provided ByMaximum Length:255Full name of the supplier contact who has provided the classification information. -
RowStatus: string
Maximum Length:
15Status of the business classification for the supplier. -
StartDate: string
(date)
Title:
Certificate Start DateDate on which the certificate, which the certifying agency issues for the business classification, goes into effect. -
Status: string
Maximum Length:
255Status of the business classification for the supplier. -
StatusCode: string
Title:
StatusMaximum Length:255Abbreviation that identifies the status of the supplier business classification. -
SubClassificationCode: string
Title:
SubclassificationMaximum Length:240Describes the subclassification when a minority owns the business classification.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-businessClassifications-businessClassificationAttachments-item-patch-request
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-patch-request
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-patch-request
Type:
Show Source
object-
FromUI: string
Title:
From UIMaximum Length:1Value was provided through the user interface. -
IsSelectedFlag: boolean
Title:
Response SelectedMaximum Length:1Indicates if acceptable response value is selected by the responder or not. -
responseAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
ResponseValueDate: string
(date)
Title:
Response Value DateIndicates a response value for a questionnaire question setup with response type as date. -
ResponseValueDatetime: string
(date-time)
Title:
Response Value Date TimeIndicates a response value for a questionnaire question setup with response type as date and time. -
ResponseValueNumber: number
Title:
Response Value NumberIndicates a response value for a questionnaire question setup with response type as number. -
ResponseValueText: string
Title:
Response Value TextMaximum Length:4000Indicates a response value for a questionnaire question setup with response type as text.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-patch-request
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Response
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 DateRead Only:trueIndicates the date when the response to the question was accepted. -
AcceptanceInstanceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the Business Process Execution Language (BPEL) instance ID for acceptance. -
AcceptanceNote: string
Title:
Acceptance NoteRead Only:trueMaximum Length:1000Note entered by acceptor for a question response at the time of acceptance. -
AcceptanceProcessedStage: string
Read Only:
trueMaximum Length:30Indicates the stage when acceptance is in progress. -
AcceptanceRecoveredCode: string
Read Only:
trueMaximum Length:1Indicates if acceptance recovery has started processing. -
AcceptedBy: integer
(int64)
Read Only:
trueIndicates the ID of the user who accepted the response to the questionnaire. -
AcceptedByDisplayName: string
Title:
Accepted ByRead Only:trueMaximum Length:240Person who accepted the response to questionnaire. -
AcceptedByName: string
Title:
Accepted ByRead Only:trueMaximum Length:240Person 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.
-
CanceledByDisplayName: string
Title:
Canceled ByRead Only:trueMaximum Length:240Indicates the name of the user who canceled the response. -
CanceledByName: string
Title:
Canceled ByMaximum Length:240Indicates the name of the user who canceled the response. -
CanceledDate: string
(date-time)
Title:
Cancellation DateIndicates the date of cancellation of response header -
CanceledReasonCode: string
Title:
Canceled ReasonMaximum Length:30Indicates the reason for cancellation of the questionnaire response. -
CanceledReasonUserText: string
Title:
Canceled ReasonMaximum Length:1000Indicates the reason when the questionnaire is canceled manually. -
CloseDate: string
(date-time)
Title:
Close DateRead Only:trueDate on which the questionnaire was closed for responding. -
ClosedBy: integer
(int64)
Read Only:
trueIndicates the ID of the user who closed the questionnaire. The response could be closed directly or because the open period ended. -
ClosedByDisplayName: string
Title:
Closed ByRead Only:trueMaximum Length:240Indicates the name of the user who closed the questionnaire. The response could be closed directly or because the open period ended. -
ClosedByName: string
Title:
Closed ByRead Only:trueMaximum Length:240Indicates the name of the user who closed the questionnaire. The response could be closed directly or because the open period ended. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the application created the questionnaire response header record. -
DueDate: string
(date)
Title:
Due DateRead Only:trueDate when the questionnaire responses are due from the responders. -
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.
-
InitiativeSupplierContactDisplayName: string
Title:
Supplier ContactRead Only:trueMaximum Length:255Indicates the name of the supplier contact specified on the initiative for a questionnaire to be sent to the supplier or supplier site. -
InitiativeSupplierContactName: string
Title:
Supplier ContactRead Only:trueMaximum Length:255Indicates 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.
-
InternalResponderDisplayName: string
Title:
Internal ResponderRead Only:trueMaximum Length:240Indicates the name of the internal responder that the questionnaire was sent to. -
InternalResponderName: string
Title:
Internal ResponderRead Only:trueMaximum Length:240Indicates the name of the internal responder that the questionnaire was sent to. -
Introduction: string
Title:
IntroductionRead Only:trueMaximum Length:4000Introduction to the questionnaire. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MergeRequestId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier merge request ID. -
ProcurementBU: string
Title:
Owning Procurement BURead Only:trueMaximum Length:240Name of the procurement business unit associated with the questionnaire response. -
ProcurementBUId: integer
(int64)
Title:
Owning Procurement BU IDValue that uniquely identifies the procurement business unit for questionnaire response. -
Questionnaire: string
Title:
InitiativeRead Only:trueMaximum Length:30Number that's assigned to the questionnaire. -
questionnaireAttachments: array
Attachments
Title:
AttachmentsThe 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 SectionsThe Questionnaire Response Sections resource stores details about various sections included in a questionnaire response. -
QuestionnaireType: string
Title:
Questionnaire TypeRead Only:trueMaximum Length:80Type of the questionnaire such as supplier or internal responder. -
QuestionnaireTypeCode: string
Read Only:
trueMaximum Length:30Code for the type of the questionnaire such as supplier questionnaire or internal questionnaire. -
QuestionnaireUsage: string
Title:
Questionnaire UsageRead Only:trueMaximum Length:80Type of the questionnaire usage such as checklist or qualification. -
QuestionnaireUsageCode: string
Read Only:
trueMaximum Length:30Code for the type of questionnaire usage. -
QuestnaireId: integer
(int64)
Value that uniquely identifies a questionnaire.
-
RecentNotificationFlag: boolean
Title:
ReceivedRead Only:trueMaximum Length:1A 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. -
RecoveredByDisplayName: string
Title:
Recovered ByRead Only:trueMaximum Length:240Name of the person who recovered the questionnaire. -
RecoveredById: integer
(int64)
Value that uniquely identifies the user who recovered the questionnaire.
-
RecoveredByName: string
Title:
Recovered ByRead Only:trueMaximum Length:240Name of the person who recovered the questionnaire. -
RecoveredDate: string
(date-time)
Read Only:
trueDate when the questionnaire was recovered. -
RequestedByDisplayName: string
Title:
Requested ByRead Only:trueMaximum Length:240Name of the person who recovered the questionnaire. -
RequestedById: integer
(int64)
Read Only:
trueValue that uniquely identifies the person requesting the questionnaire response. -
RequestedByName: string
Title:
Requested ByRead Only:trueMaximum Length:240Name of the person requesting the questionnaire response. -
RequestErrorReason: string
Read Only:
trueMaximum Length:4000Indicates the reason why the questionnaire response was rejected or couldn't be processed. -
ResponseStatus: string
Title:
Response StatusMaximum Length:80Indicates the status of the response to questionnaire. -
ResponseStatusCode: string
Maximum Length:
30Code for the status of the response to questionnaire. -
ReturnedBy: integer
(int64)
Read Only:
trueValue that uniquely Identifies the person who returned the response to the responder. -
ReturnedByDisplayName: string
Title:
Returned ByRead Only:trueMaximum Length:240Name of the person who returned the response to the responder. -
ReturnedByName: string
Title:
Returned ByRead Only:trueMaximum Length:240Name of the person who returned the response to the responder. -
ReturnedDate: string
(date-time)
Title:
Return DateRead Only:trueDate on which the response was returned to the responder. -
ReturnMessageContent: string
(byte)
Title:
Return ReasonRead Only:trueIndicates the message content sent to the responder when the response was returned. -
SubmissionDate: string
(date-time)
Title:
Submission DateDate when the response to a questionnaire is submitted. -
SubmittedBy: integer
(int64)
Indicates the person who submitted the response to questionnaire.
-
SubmittedByDisplayName: string
Title:
Entered ByRead Only:trueMaximum Length:240Name of the person who submitted the response to the questionnaire. -
SubmittedByName: string
Title:
Entered ByMaximum Length:240Name of the person who submitted the response to the questionnaire. -
SupplierContactPartyDisplayName: string
Title:
ResponderRead Only:trueMaximum Length:255Name of the contact person for a supplier or supplier site. -
SupplierContactPartyId: integer
(int64)
Read Only:
trueValue that uniquely Identifies the contact person for a supplier or supplier site. -
SupplierContactPartyName: string
Title:
ResponderRead Only:trueMaximum Length:255Name of the contact person for a supplier or supplier site. -
SupplierId: integer
(int64)
Read Only:
trueValue that uniquely Identifies the Supplier who's being responded. -
SupplierName: string
Title:
SupplierRead Only:trueMaximum Length:360Name of the supplier who's being responded to. -
SupplierSiteAddress: string
Title:
Supplier Site AddressRead Only:trueMaximum Length:255Name of the address associated with the supplier site. -
SupplierSiteId: integer
(int64)
Value that uniquely Identifies the Supplier site.
-
SupplierSiteName: string
Title:
Supplier SiteRead Only:trueMaximum Length:240Name of the supplier site. -
SurrogateEnteredByDisplayName: string
Title:
Surrogate Entered ByRead Only:trueMaximum Length:240Name of the user who entered the surrogate response for the questionnaire on behalf of the supplier or internal responder. -
SurrogateEnteredByName: string
Title:
Surrogate Entered ByRead Only:trueMaximum Length:240Name of the user who entered the surrogate response for the questionnaire on behalf of the supplier or internal responder. -
SurrogEnteredBy: integer
(int64)
Read Only:
trueValue 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 DateRead Only:trueSurrogate entry date is the date on which qualification manager submitted the response. -
SurrogResponseFlag: boolean
Title:
Surrogate ResponseRead Only:trueMaximum Length:1Indicates if a response is a surrogate response entered by qualification manager on behalf of supplier or internal responder. -
Title: string
Title:
TitleRead Only:trueMaximum Length:80Title of the questionnaire.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Sections
Type:
arrayTitle:
Questionnaire Response SectionsThe 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 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 : questionnaireResponses-questionnaireAttachments-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 IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-item-response
Type:
Show Source
object-
DisplaySequence: integer
(int32)
Title:
Display SequenceRead Only:trueSpecifies the order in which the sections should be displayed to the responders on a questionnaire. -
Instructions: string
Title:
InstructionsRead Only:trueMaximum Length:1000Indicates the instructions provided to the person responding to questionnaire. -
links: array
Links
Title:
LinksThe 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 DetailsThe 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 NameRead Only:trueMaximum Length:80Indicates the name of a section in questionnaire. -
SectionCompletedFlag: string
Title:
Section CompletedMaximum Length:1Value indicates section response is completed. -
SectionGeneratedFlag: boolean
Title:
Section GeneratedRead Only:trueMaximum Length:1Indicates if section was generated into the questionnaire response.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Questionnaire Response Details
Type:
arrayTitle:
Questionnaire Response DetailsThe 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:
trueMaximum Length:1000Note entered by acceptor at the time of acceptance. -
AllowRespCommentFlag: boolean
Title:
Allow comments from responderRead 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)
Title:
Branch LevelRead Only:trueIndicates the level at which question is appearing in the questionnaire. -
businessClassifications: array
Business Classifications
Title:
Business ClassificationsChanges to business classifications associated with a supplier, made by supplier users, are submitted for approval to the buying organization. Once approved, these changes are reflected in the supplier profile. This resource is linked to a feature that requires opt-in. -
Category: string
Title:
CategoryRead Only:trueMaximum Length:80Indicates the categorization of the supplier attribute that the question is mapped to. -
CategoryCode: string
Read Only:
trueMaximum Length:30Code for identifying the categorization of the supplier attribute. -
DisplayNumber: string
Title:
NumberRead Only:trueMaximum Length:30Indicates the order in which the questions are displayed. -
DisplayPreferredRespFlag: boolean
Title:
Display preferred responseRead Only:trueMaximum Length:1Indicates whether there is a preferred response. -
DisplaySequence: integer
(int32)
Read Only:
trueValue that indicates the display sequence of the responses. -
FailedPozValidationFlag: boolean
Title:
Failed POZ ValidationRead Only:trueMaximum Length:1Indicates that this response failed POZ validation and this response will be ignored -
HasNewerResponseFlag: boolean
Title:
Has Newer ResponseRead Only:trueMaximum Length:1Indicates that a newer response is available and this response will be ignored. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MappedToPrereqQuestionFlag: boolean
Title:
Mapped to prerequisite questionRead Only:trueMaximum Length:1Indicates whether the question is mapped to a prerequisite question. -
MappingId: integer
(int64)
Read Only:
trueValue that uniquely identifies the mapping between the supplier and the question. -
ParentAcceptableResponseId: integer
(int64)
Read Only:
trueIndicates the ID for the acceptable response that the branching question belongs to. -
ParentQuestionnaireQuestId: integer
(int64)
Read Only:
trueValue that uniquely identifies Questionnaire question from the questionnaires table. -
PreferredResponseDate: string
(date)
Title:
Preferred Response DateRead Only:trueValue of the preferred response in Date format. -
PreferredResponseDatetime: string
(date-time)
Title:
Preferred Response Date and TimeRead Only:trueValue of the preferred response in Date and Time format. -
PreferredResponseNumber: number
Title:
Preferred Response NumberRead Only:trueValue of the preferred response in Number format. -
PreferredResponseText: string
Title:
Preferred Response TextRead Only:trueMaximum Length:4000Value of the preferred response in Text format. -
questionAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
QuestionDisplayedFlag: boolean
Title:
Question DisplayedMaximum Length:1Indicates if the questions were shown to the responders at the time of response submission. -
QuestionHint: string
Title:
HintRead Only:trueMaximum Length:1000Hint to the question. -
QuestionId: integer
(int64)
Identifier of the questionnaire question.
-
QuestionLevel: string
Title:
Question LevelRead Only:trueMaximum Length:80Identifier of the questionnaire question. -
QuestionLevelCode: string
Title:
Lookup CodeRead Only:trueMaximum Length:30Name 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 ValuesThe 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:
QuestionRead Only:trueMaximum Length:80Name of the questionnaire question. -
QuestionPlainText: string
(byte)
Title:
Question Plain TextRead Only:trueText of the question to be displayed to responders of a questionnaire. -
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. -
ResponseComments: string
Title:
CommentsMaximum Length:1000Comments entered by supplier or internal respondent for response to a question. -
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:
Supplier AttributeRead Only:trueMaximum Length:1Indicates whether the question is mapped to an attribute from the supplier profile. -
SupplierAttributeName: string
Read Only:
trueMaximum Length:200Indicates the supplier attribute that the question is mapped to.
Nested Schema : Business Classifications
Type:
arrayTitle:
Business ClassificationsChanges to business classifications associated with a supplier, made by supplier users, are submitted for approval to the buying organization. Once approved, these changes are reflected in the supplier profile. This resource is linked to a feature that requires opt-in.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Values
Type:
arrayTitle:
Questionnaire Response ValuesThe 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-businessClassifications-item-response
Type:
Show Source
object-
AgencyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the agency that certifies the business classification for the supplier. -
BusClassCode: string
Title:
ClassificationMaximum Length:30Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task. -
BusClassRequestId: integer
Value that uniquely identifies a business classification on a supplier change request.
-
businessClassificationAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CertificationNo: string
Title:
Certificate NumberMaximum Length:80Certificate that the certifying agency issues for the business classification. -
CertifyingAgencyId: integer
(int64)
Value that uniquely identifies the agency responsible for certifying the business classification for the supplier.
-
CertifyingAgencyName: string
Title:
Certifying AgencyMaximum Length:255Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require. -
ConfirmedOn: string
(date)
Title:
Confirmed OnDate when the application confirmed the business classification for the supplier. -
DisplayedField: string
Title:
ClassificationRead Only:trueMaximum Length:80Classification for the supplier business. -
EnabledFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then the business classification is enabled for suppliers. If false, then the business classification isn't enabled for suppliers. -
EndDateActive: string
(date)
Read Only:
trueDate when the business classification becomes inactive. -
ExistingClassificationFlag: boolean
Read Only:
trueMaximum Length:255Contains one of the following values: true or false. If true, then the business classification is an existing classification for the supplier. If false, then the business classification is a new classification for the supplier. -
ExpirationDate: string
(date)
Title:
Certificate End DateDate on which the certificate that the certifying agency issues for the business classification expires. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MappingId: integer
Value that uniquely identifies the mapping between the supplier business classification and the question.
-
Notes: string
Title:
NotesMaximum Length:1000Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes. -
OtherCertifyingAgency: string
Title:
Other Certifying AgencyMaximum Length:255Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require. -
ProvidedByContactId: integer
(int64)
Value that uniquely identifies the person in the supplier organization who provides the business classification details.
-
ProvidedByContactName: string
Title:
Provided ByMaximum Length:255Full name of the supplier contact who has provided the classification information. -
RowStatus: string
Maximum Length:
15Status of the business classification for the supplier. -
StartDate: string
(date)
Title:
Certificate Start DateDate on which the certificate, which the certifying agency issues for the business classification, goes into effect. -
StartDateActive: string
(date)
Read Only:
trueDate when the business classification becomes active. -
Status: string
Maximum Length:
255Status of the business classification for the supplier. -
StatusCode: string
Title:
StatusMaximum Length:255Abbreviation that identifies the status of the supplier business classification. -
SubClassification: string
Read Only:
trueMaximum Length:80Describes the subclassification when a minority owns a business classification. -
SubClassificationCode: string
Title:
SubclassificationMaximum Length:240Describes the subclassification when a minority owns the business classification.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-businessClassifications-businessClassificationAttachments-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 IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-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 IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 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. -
CertifyingAgencyId: integer
(int64)
Read Only:
trueValue that uniquely Identifies the certifying agency that granted the business classification certificate to the supplier. -
DisplayNumber: string
Title:
NumberRead Only:trueMaximum Length:5Specifies the display number for the acceptable response that will be shown on a questionnaire for this specific question. -
DisplaySequence: integer
(int32)
Read Only:
trueValue that indicates the display sequence of the response values. -
FromUI: string
Title:
From UIMaximum Length:1Value was provided through the user interface. -
HasBranchingFlag: boolean
Title:
Has BranchingRead Only:trueMaximum Length:1Indicates whether the response value has branching questions. -
IsSelectedFlag: boolean
Title:
Response SelectedMaximum Length:1Indicates if acceptable response value is selected by the responder or not. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PreferredResponseFlag: boolean
Title:
Preferred ResponseRead Only:trueMaximum Length:1Indicates 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:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
ResponseText: string
Title:
Acceptable Response TextRead Only:trueMaximum Length:1000The text of a manually entered response value to a questionnaire question. -
ResponseValueDate: string
(date)
Title:
Response Value DateIndicates a response value for a questionnaire question setup with response type as date. -
ResponseValueDatetime: string
(date-time)
Title:
Response Value Date TimeIndicates a response value for a questionnaire question setup with response type as date and time. -
ResponseValueNumber: number
Title:
Response Value NumberIndicates a response value for a questionnaire question setup with response type as number. -
ResponseValueText: string
Title:
Response Value TextMaximum Length:4000Indicates a response value for a questionnaire question setup with response type as text.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe 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 IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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: