Create a health survey
post
/hcmRestApi/resources/11.13.18.05/healthSurveys
Request
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
-
EmployeeId: integer
(int64)
Identification value of the employee.
-
IncidentDate: string
(date-time)
The date when the incident happened.
-
IncidentId: integer
(int64)
An identification value used for the incident.
-
IncidentNo(required): string
Maximum Length:
32
The number of the incident that's being associated with the main incident. -
IncidentReviewerEmailFlag: boolean
Maximum Length:
1
Incident reviewer email flag. -
IncidentSourceCode: string
Maximum Length:
30
Label to indicate the origin of the incident record. For example an incident generated using an API or an incident entered using the self-service kiosk pages. -
IncidentSummary(required): string
Maximum Length:
1000
Audit detail for incident summary. -
IncidentTypeCode: string
Maximum Length:
30
Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident. -
LocationId: integer
(int64)
An identification value used for the location.
-
ObjectVersionNumber: integer
(int32)
Object version number for the survey.
-
OffsiteLocTypeCode: string
Maximum Length:
30
A label to describe the category of the offsite location. -
QuestionnaireId: integer
An identification value used for the questionnaire owner
-
QuestionnaireResponses: array
Incident ID
Title:
Incident ID
Questions and responses to use in a questionnaire in a health survey incident. -
ReporterTypeCode: string
Maximum Length:
30
Default Value:ORA_EMPLOYEE
Value that identifies whether the person who's reporting the incident is an employee or a nonemployee. -
ReptrAreaCode: string
Maximum Length:
30
Label for the phone area code of the incident reporter. -
ReptrCountry: string
Maximum Length:
100
The name of the country where the incident occurred. -
ReptrCountryCodeNum: string
Maximum Length:
30
The phone country code for the incident reporter. -
ReptrEmail: string
Maximum Length:
250
The incident reporter email. -
ReptrName: string
Maximum Length:
200
The incident reporter name. -
ReptrNonempTypeCode: string
Maximum Length:
30
A label to describe if the incident reporter is an employee or nonemployee. -
ReptrPhoneNo: string
Maximum Length:
18
The incident reporter phone number. -
ReptrSpecificLocation(required): string
Maximum Length:
255
The incident reporter specific location. -
TargetCompletionDate(required): string
(date-time)
The date that the investigation is targeted for completion.
Nested Schema : Incident ID
Type:
array
Title:
Incident ID
Questions and responses to use in a questionnaire in a health survey incident.
Show Source
Nested Schema : healthSurveys-QuestionnaireResponses-item-post-request
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 is used to view, create, and update attachments. -
BusinessGroupId: string
Maximum Length:
255
An identification value used for business group. -
IncidentId: string
An identification value used for the incident.
-
QstnResponseId: string
An identification value used for the questionnaire response.
-
QuestionId: integer
An identification value used for the question.
-
QuestionResponse: string
Question response value.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : schema
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
-
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 : healthSurveys-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user ID of the person who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the health survey record. -
EmployeeId: integer
(int64)
Identification value of the employee.
-
IncidentDate: string
(date-time)
The date when the incident happened.
-
IncidentId: integer
(int64)
An identification value used for the incident.
-
IncidentNo: string
Maximum Length:
32
The number of the incident that's being associated with the main incident. -
IncidentReviewerEmailFlag: boolean
Maximum Length:
1
Incident reviewer email flag. -
IncidentSourceCode: string
Maximum Length:
30
Label to indicate the origin of the incident record. For example an incident generated using an API or an incident entered using the self-service kiosk pages. -
IncidentSummary: string
Maximum Length:
1000
Audit detail for incident summary. -
IncidentTypeCode: string
Maximum Length:
30
Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date that the record was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user ID of the person who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login of last updated user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
An identification value used for the location.
-
ObjectVersionNumber: integer
(int32)
Object version number for the survey.
-
OffsiteLocTypeCode: string
Maximum Length:
30
A label to describe the category of the offsite location. -
QuestionnaireId: integer
An identification value used for the questionnaire owner
-
QuestionnaireResponses: array
Incident ID
Title:
Incident ID
Questions and responses to use in a questionnaire in a health survey incident. -
ReporterTypeCode: string
Maximum Length:
30
Default Value:ORA_EMPLOYEE
Value that identifies whether the person who's reporting the incident is an employee or a nonemployee. -
ReptrAreaCode: string
Maximum Length:
30
Label for the phone area code of the incident reporter. -
ReptrCountry: string
Maximum Length:
100
The name of the country where the incident occurred. -
ReptrCountryCodeNum: string
Maximum Length:
30
The phone country code for the incident reporter. -
ReptrEmail: string
Maximum Length:
250
The incident reporter email. -
ReptrName: string
Maximum Length:
200
The incident reporter name. -
ReptrNonempTypeCode: string
Maximum Length:
30
A label to describe if the incident reporter is an employee or nonemployee. -
ReptrPhoneNo: string
Maximum Length:
18
The incident reporter phone number. -
ReptrSpecificLocation: string
Maximum Length:
255
The incident reporter specific location. -
TargetCompletionDate: string
(date-time)
The date that the investigation is targeted for completion.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Incident ID
Type:
array
Title:
Incident ID
Questions and responses to use in a questionnaire in a health survey incident.
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 : 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 is used to view, create, and update attachments. -
BusinessGroupId: string
Maximum Length:
255
An identification value used for business group. -
IncidentId: string
An identification value used for the incident.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QstnResponseId: string
An identification value used for the questionnaire response.
-
QuestionId: integer
An identification value used for the question.
-
QuestionResponse: string
Question response value.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
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 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
- QuestionnaireResponses
-
Operation: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponsesParameters:
- IncidentId:
$request.path.IncidentId
Questions and responses to use in a questionnaire in a health survey incident. - IncidentId: