Check-In Documents
checkInDocuments Based on latest (2026.09)
Create, change and look up Check-In Documents, with questionnaire responses.
The record key checkInDocumentsUniqID 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)
- Record key
checkInDocumentsUniqID- Required on create
AssignmentIdCheckInDateCheckInTemplateIdCheckInTemplateNameDocumentNameManagerPersonIdManagerPersonNumberPersonIdPersonNumber- At a glance
- 13 fields0 finders3 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/checkInDocuments?fields=AssignmentId,AssignmentNumber,CheckInDate,CheckInDocumentId,CheckInTemplateId&limit=25&onlyData=true
{
"items": [
{
"AssignmentId": 0,
"AssignmentNumber": "<string, max 30>",
"CheckInDate": "2026-01-31",
"CheckInDocumentId": 0,
"CheckInTemplateId": 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 13
| Attribute | Type | Use |
|---|---|---|
AssignmentId | number | Required on createSearchable |
AssignmentNumber | text · max 30 | Optional on createSearchable |
CheckInDate | date | Required on createUpdatableSearchable |
CheckInDocumentId | number | Optional on createSearchable |
CheckInTemplateId | number | Required on createUpdatableSearchable |
CheckInTemplateName | text · max 400 | Required on createUpdatableSearchable |
DocumentName | text · max 240 | Required on createUpdatableSearchable |
ManagerPersonId | number | Required on createUpdatableSearchable |
ManagerPersonNumber | text · max 30 | Required on createUpdatableSearchable |
PersonId | number | Required on createSearchable |
PersonNumber | text · max 30 | Required on createSearchable |
ReviewPeriodId | number | Optional on createSearchable |
ReviewPeriodName | text · max 400 | Optional on createSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
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/checkInDocuments/{checkInDocumentsUniqID}/child/<name>. Add them to a GET with expand.
questionnaireResponsesGET Questionnaire Responses · 12 fieldsAttemptNumberCreatedByCreationDateLastUpdateDateLastUpdatedByParticipantPersonNumberQuestionnaireCodeQuestionnaireIdQuestionnaireResponseIdQuestionnaireVersionNumberStatusSubmittedDateTimequestionResponsesGET · POST · PATCH Question Responses · 10 fieldsAnswerCLOBAnswerListCreatedByCreationDateLastUpdateDateLastUpdatedByQuestionAnswerIdQuestionCodeQuestionResponseIdQuestionnaireQuestionIdresponseAttachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/checkInDocumentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - 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:AssignmentId, notassignmentid. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - 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.