Create a questionnaire response
post
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses
Request
Path Parameters
-
IncidentId(required): string
Identification value used for the incident.
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
-
AttachmentEntityName: string
Maximum Length:
255
Default Value:HRQ_QSTN_RESPONSE
Name of the attachment entity. -
Attachments: array
Attachments
Title:
Attachments
The Attachments resource provides attachments that are included with a response in a health survey incident. -
BusinessGroupId: string
Maximum Length:
255
Identification value of the business group. -
IncidentId: string
Identification value used for the incident.
-
QstnResponseId: string
Identification value used for the questionnaire response.
-
QuestionId: integer
Identification value used for the question.
-
QuestionResponse: string
Response value for the question.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource provides attachments that are included with a response in a health survey incident.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from where the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
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
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attachment. -
FileUrl: string
Title:
File Url
URI of the file. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
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(required):
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(required):
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 : healthSurveys-QuestionnaireResponses-item-response
Type:
Show Source
object
-
AttachmentEntityName: string
Maximum Length:
255
Default Value:HRQ_QSTN_RESPONSE
Name of the attachment entity. -
Attachments: array
Attachments
Title:
Attachments
The Attachments resource provides attachments that are included with a response in a health survey incident. -
BusinessGroupId: string
Maximum Length:
255
Identification value of the business group. -
IncidentId: string
Identification value used for the incident.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QstnResponseId: string
Identification value used for the questionnaire response.
-
QuestionId: integer
Identification value used for the question.
-
QuestionResponse: string
Response value for the question.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource provides attachments that are included with a response in a health survey incident.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : healthSurveys-QuestionnaireResponses-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from where the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
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
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attachment. -
FileUrl: string
Title:
File Url
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
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
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 : 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.
Links
- Attachments
-
Parameters:
- IncidentId:
$request.path.IncidentId
- QuestionId:
$request.path.QuestionId
The Attachments resource provides attachments that are included with a response in a health survey incident. - IncidentId: