Questionnaire Instructions
questionnaireInstructions Based on latest (2026.09)
Look up Questionnaire Instructions. Read-only.
The record key questionnaireInstructionsUniqID 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)
- Record key
questionnaireInstructionsUniqID- Required on create
- no create on this resource
- At a glance
- 7 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/questionnaireInstructions?fields=InstructionText,QuestionnaireCode,QuestionnaireId,QuestionnaireName,SubscriberId&limit=25&onlyData=true
{
"items": [
{
"InstructionText": "<string, max 4000>",
"QuestionnaireCode": "<string, max 240>",
"QuestionnaireId": 0,
"QuestionnaireName": "<string, max 240>",
"SubscriberId": 0
}
],
"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 7
| Attribute | Type | Use |
|---|---|---|
InstructionText | text · max 4000 | Read-onlySearchable |
QuestionnaireCode | text · max 240 | Read-onlySearchable |
QuestionnaireId | number | Read-onlySearchable |
QuestionnaireName | text · max 240 | Read-onlySearchable |
SubscriberId | number | Read-onlySearchable |
SubscriberName | text · max 240 | Read-onlySearchable |
VersionNumber | number | Read-onlySearchable |
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.
findByQuestionnaireIdAndVersion·QuestionnaireIdVersionNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/<name>. Add them to a GET with expand.
questionnaireInstructionAttachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/questionnaireInstructionsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByQuestionnaireIdAndVersionfor 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.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:InstructionText, notinstructiontext. 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.