Get all health surveys
get
/hcmRestApi/resources/11.13.18.05/healthSurveys
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the health survey event that matches the specified primary key criteria.
Finder Variables:- IncidentId; integer; Unique identifier for the health survey event.
- PrimaryKey: Finds the health survey event that matches the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; User ID of the person who created the record.
- CreationDate; string; Date when the record was created.
- EmployeeId; integer; Identification value of the employee.
- IncidentDate; string; Date when the incident happened.
- IncidentId; integer; Identification value used for the incident.
- IncidentNo; string; Number of the incident associated with the main incident.
- IncidentReviewerEmailFlag; boolean; Indicates whether the incident reviewer receives an email notification. The valid values are Y and N.
- IncidentSourceCode; string; Code for the origin of the incident record, such as incident generated using an API or incident entered using the self-service kiosk pages.
- IncidentSummary; string; Audit detail for the incident summary.
- IncidentTypeCode; string; Label that indicates the type of incident recorded, such as health and safety incident or data security incident.
- LastUpdateDate; string; Date when the record was last updated.
- LastUpdateLogin; string; Last updated login of the user.
- LastUpdatedBy; string; User ID of the person who last updated the record.
- LocationId; integer; Identification value used for the location.
- ObjectVersionNumber; integer; Object version number for the survey.
- OffsiteLocTypeCode; string; Code for the category of the off-site location.
- QuestionnaireId; integer; Identification value used for the questionnaire owner.
- ReporterTypeCode; string; Code that indicates whether the person reporting the incident is an employee of the company or a nonemployee.
- ReptrAreaCode; string; Phone area code of the incident reporter.
- ReptrCountry; string; Name of the country where the incident occurred.
- ReptrCountryCodeNum; string; Phone country code for the incident reporter.
- ReptrEmail; string; Email address of the incident reporter.
- ReptrName; string; Name of the incident reporter.
- ReptrNonempTypeCode; string; Code that indicates whether the incident reporter is an employee or a nonemployee.
- ReptrPhoneNo; string; Phone number of the incident reporter.
- ReptrSpecificLocation; string; Specific location of the incident reporter .
- TargetCompletionDate; string; Date when the investigation is targeted for completion.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : healthSurveys-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User ID of the person who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the record was created. -
EmployeeId: integer
(int64)
Identification value of the employee.
-
IncidentDate: string
(date-time)
Date when the incident happened.
-
IncidentId: integer
(int64)
Identification value used for the incident.
-
IncidentNo: string
Maximum Length:
32
Number of the incident associated with the main incident. -
IncidentReviewerEmailFlag: boolean
Maximum Length:
1
Indicates whether the incident reviewer receives an email notification. The valid values are Y and N. -
IncidentSourceCode: string
Maximum Length:
30
Code for the origin of the incident record, such as incident generated using an API or incident entered using the self-service kiosk pages. -
IncidentSummary: string
Maximum Length:
1000
Audit detail for the incident summary. -
IncidentTypeCode: string
Maximum Length:
30
Label that indicates the type of incident recorded, such as health and safety incident or data security incident. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User ID of the person who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last updated login of the user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Identification value used for the location.
-
ObjectVersionNumber: integer
(int32)
Object version number for the survey.
-
OffsiteLocTypeCode: string
Maximum Length:
30
Code for the category of the off-site location. -
QuestionnaireId: integer
Identification value used for the questionnaire owner.
-
QuestionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The QuestionnaireResponses resource provides questions and responses to use in a health survey incident. -
ReporterTypeCode: string
Maximum Length:
30
Default Value:ORA_EMPLOYEE
Code that indicates whether the person reporting the incident is an employee of the company or a nonemployee. -
ReptrAreaCode: string
Maximum Length:
30
Phone area code of the incident reporter. -
ReptrCountry: string
Maximum Length:
100
Name of the country where the incident occurred. -
ReptrCountryCodeNum: string
Maximum Length:
30
Phone country code for the incident reporter. -
ReptrEmail: string
Maximum Length:
250
Email address of the incident reporter. -
ReptrName: string
Maximum Length:
200
Name of the incident reporter. -
ReptrNonempTypeCode: string
Maximum Length:
30
Code that indicates whether the incident reporter is an employee or a nonemployee. -
ReptrPhoneNo: string
Maximum Length:
18
Phone number of the incident reporter. -
ReptrSpecificLocation: string
Maximum Length:
255
Specific location of the incident reporter . -
TargetCompletionDate: string
(date-time)
Date when 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 : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The QuestionnaireResponses resource provides questions and responses to use 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 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