Oracle Fusion HCM endpoint reference

Health Surveys REST API

Get all health surveys

GET https://your-pod.oraclecloud.com/hcmRestApi/resources/11.13.18.05/healthSurveys

Everything on this page is extracted from Oracle's official OpenAPI specification for Fusion Cloud HCM: 27 queryable q fields, and 1 child resource. Unsure how q works? See the Oracle HCM API guide.

Supported operations

GET /healthSurveys
GET /healthSurveys/{id}
POST /healthSurveys

Queryable q fields (27)

Only these fields can appear in a q filter expression on /healthSurveys. Filtering on any other field returns 400 Bad Request.

Example q request

GET /hcmRestApi/resources/11.13.18.05/healthSurveys?q=CreatedBy='<value>'&onlyData=true&limit=25
Field Type Operators
CreatedBy string = !=
CreationDate string = !=
EmployeeId integer = !=
IncidentDate string = !=
IncidentId integer = !=
IncidentNo string = !=
IncidentReviewerEmailFlag boolean = !=
IncidentSourceCode string = !=
IncidentSummary string = !=
IncidentTypeCode string = !=
LastUpdateDate string = !=
LastUpdateLogin string = !=
LastUpdatedBy string = !=
LocationId integer = !=
ObjectVersionNumber integer = !=
OffsiteLocTypeCode string = !=
QuestionnaireId integer = !=
ReporterTypeCode string = !=
ReptrAreaCode string = !=
ReptrCountry string = !=
ReptrCountryCodeNum string = !=
ReptrEmail string = !=
ReptrName string = !=
ReptrNonempTypeCode string = !=
ReptrPhoneNo string = !=
ReptrSpecificLocation string = !=
TargetCompletionDate string = !=

Child resources (1)

Each child is reachable at /healthSurveys/{id}/child/<name> and most can also be inlined with expand.

QuestionnaireResponses

Response fields (28)

Top-level attributes returned for each row. Use fields= to request a subset and shrink the payload.

CreatedByCreationDateEmployeeIdIncidentDateIncidentIdIncidentNoIncidentReviewerEmailFlagIncidentSourceCodeIncidentSummaryIncidentTypeCodeLastUpdateDateLastUpdateLoginLastUpdatedByLocationIdObjectVersionNumberOffsiteLocTypeCodeQuestionnaireIdQuestionnaireResponsesReporterTypeCodeReptrAreaCodeReptrCountryReptrCountryCodeNumReptrEmailReptrNameReptrNonempTypeCodeReptrPhoneNoReptrSpecificLocationTargetCompletionDate

Build this query visually in OPAL

OPAL bundles this endpoint — and 59,000+ more — fully searchable offline, with a visual Q Builder and Finder Builder that only offer the fields listed above, so your filter can't 400. Download free · see features.

Related reference & reading