Wellness Assessments
wellnessAssessments Based on latest (2026.09)
Create, change, delete and look up Wellness Assessments, with questionnaire responses.
The record key wellnessAssessmentsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
wellnessAssessmentsUniqID- Required on create
QuestionnaireIdUserId- At a glance
- 4 fields1 finders3 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/wellnessAssessments?fields=QuestionnaireId,SubjectId,SubscriberCode,UserId&limit=25&onlyData=true
{
"items": [
{
"QuestionnaireId": 0,
"SubjectId": "<string, max 80>",
"SubscriberCode": "<string, max 80>",
"UserId": "<string, max 500>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 4
| Attribute | Type | Use |
|---|---|---|
QuestionnaireId | number | Required on createUpdatableSearchable |
SubjectId | text · max 80 | Optional on createUpdatable |
SubscriberCode | text · max 80 | Optional on createUpdatable |
UserId | text · max 500 | Required on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByUserIdAndQuestionnaireId·QuestionnaireIdUserId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 3
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/wellnessAssessments/{wellnessAssessmentsUniqID}/child/<name>. Add them to a GET with expand.
questionnaireResponsesGET · POST · PATCH Questionnaire Responses · 13 fieldsAttemptNumberCreatedByCreationDateLastUpdateDateLastUpdatedByLatestAttemptFlagQuestionnaireParticipantIdQuestionnaireResponseIdQuestionnaireVersionNumberStatusStatusMeaningSubmittedDateTimeTotalScorequestionResponsesGET · POST · PATCH Question Responses · 21 fieldsAnswerCodeAnswerCodeListAnswerCommentsAnswerLargeObjectAnswerListAnswerShortDescriptionListAnswerShortdescriptionChoiceCodeListChoiceListChoiceShortDescriptionCreatedByCreationDateLastUpdateDateLastUpdatedByQuestionAnswerIdQuestionCodeQuestionIdQuestionResponseIdQuestionTextQuestionnaireQuestionIdScorequestionResponseAttachmentsGET · POST · PATCH · DELETE Question Response Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/wellnessAssessmentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByUserIdAndQuestionnaireIdfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:QuestionnaireId, notquestionnaireid. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.