1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Incident ID

Get all health surveys

get

/hcmRestApi/resources/11.13.18.05/healthSurveys

Request

Query Parameters
  • 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).
  • 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
  • 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; The unique identifier of the health survey event.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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; The user ID of the person who created the record.
    • CreationDate; string; Creation date of the health survey record.
    • EmployeeId; integer; Identification value of the employee.
    • IncidentDate; string; The date when the incident happened.
    • IncidentId; integer; An identification value used for the incident.
    • IncidentNo; string; The number of the incident that's being associated with the main incident.
    • IncidentReviewerEmailFlag; boolean; Incident reviewer email flag.
    • IncidentSourceCode; string; 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; Audit detail for incident summary.
    • IncidentTypeCode; string; Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident.
    • LastUpdateDate; string; The last date that the record was updated.
    • LastUpdateLogin; string; Login of last updated user.
    • LastUpdatedBy; string; The user ID of the person who last updated the record.
    • LocationId; integer; An identification value used for the location.
    • ObjectVersionNumber; integer; Object version number for the survey.
    • OffsiteLocTypeCode; string; A label to describe the category of the offsite location.
    • QuestionnaireId; integer; An identification value used for the questionnaire owner
    • ReporterTypeCode; string; Value that identifies whether the person who's reporting the incident is an employee or a nonemployee.
    • ReptrAreaCode; string; Label for the phone area code of the incident reporter.
    • ReptrCountry; string; The name of the country where the incident occurred.
    • ReptrCountryCodeNum; string; The phone country code for the incident reporter.
    • ReptrEmail; string; The incident reporter email.
    • ReptrName; string; The incident reporter name.
    • ReptrNonempTypeCode; string; A label to describe if the incident reporter is an employee or nonemployee.
    • ReptrPhoneNo; string; The incident reporter phone number.
    • ReptrSpecificLocation; string; The incident reporter specific location.
    • TargetCompletionDate; string; The date that the investigation is targeted for completion.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : healthSurveys
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : healthSurveys-item-response
Type: object
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 : healthSurveys-QuestionnaireResponses-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : healthSurveys-QuestionnaireResponses-Attachments-item-response
Type: object
Show Source
Back to Top