Update one question response value record in a questionnaire
patch
/fscmRestApi/resources/11.13.18.05/supplierRegistrationQuestionnaireResponses/{SupplierRegistrationKey}/child/questionnaireResponseSections/{QuestnaireRespSectionId}/child/questionnaireResponses/{QuestnaireResponseId}/child/questionnaireResponseValues/{QuestnaireRespValueId}
Request
Path Parameters
-
QuestnaireRespSectionId(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=
-
QuestnaireRespValueId(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=
-
QuestnaireResponseId(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=
-
SupplierRegistrationKey(required): string
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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
FromUI: string
Maximum Length:
1
Value was provided through the user interface. -
IsSelectedFlag: boolean
Title:
Response Selected
Maximum Length:1
Indicates if acceptable response value is selected by the responder or not. -
QuestnaireRespValueId: 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. -
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. -
ResponseValueTxt: string
Title:
Response Value Text
Maximum Length:4000
Indicates a response value for a questionnaire question setup with response type as text.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : supplierRegistrationQuestionnaireResponses-questionnaireResponseSections-questionnaireResponses-questionnaireResponseValues-responseAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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. -
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.
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 : supplierRegistrationQuestionnaireResponses-questionnaireResponseSections-questionnaireResponses-questionnaireResponseValues-item-response
Type:
Show Source
object
-
AccResponseId: 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. -
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. -
QuestnaireAccResponseId: integer
(int64)
Value that uniquely identifies the questionnaire's acceptable response.
-
QuestnaireResponseId: integer
(int64)
Value that uniquely Identifies a response to questionnaire question.
-
QuestnaireRespValueId: 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. -
ResponseValueTxt: 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 : 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 : supplierRegistrationQuestionnaireResponses-questionnaireResponseSections-questionnaireResponses-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
- responseAttachments
-
Parameters:
- QuestnaireRespSectionId:
$request.path.QuestnaireRespSectionId
- QuestnaireRespValueId:
$request.path.QuestnaireRespValueId
- QuestnaireResponseId:
$request.path.QuestnaireResponseId
- SupplierRegistrationKey:
$request.path.SupplierRegistrationKey
The attachments resource is used to view, create, and update attachments. - QuestnaireRespSectionId: