Document Records
documentRecords Based on latest (2026.09)
Create, change, delete and look up Document Records, with banner override messages and hr document types. Actions include check manage access and check massdownload access.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE14 actions
- Record key
DocumentsOfRecordId- Required on create
DocumentTypeDocumentTypeIdPersonIdSystemDocumentType- At a glance
- 42 fields4 finders9 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/documentRecords?fields=AssignmentId,AssignmentName,AssignmentNumber,AttachmentsCount,CategoryCode&limit=25&onlyData=true
{
"items": [
{
"AssignmentId": 0,
"AssignmentName": "<string, max 255>",
"AssignmentNumber": "<string, max 255>",
"AttachmentsCount": 0,
"CategoryCode": "<string, max 30>"
}
],
"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 42
| Attribute | Type | Use |
|---|---|---|
AssignmentId | number | Optional on createUpdatableSearchable |
AssignmentName | text · max 255 | Read-onlySearchable |
AssignmentNumber | text · max 255 | Optional on createUpdatableSearchable |
AttachmentsCount | number | Read-only |
CategoryCode | text · max 30 | Read-onlySearchable |
Classification | text · max 2000 | Optional on createUpdatableSearchable |
Comments | text · max 4000 | Optional on createUpdatableSearchable |
Country | text | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CreationSource | text · max 30 · default ORA_REST | Read-onlySearchable |
DateFrom | date | Optional on createUpdatableSearchable |
DateTo | date | Optional on createUpdatableSearchable |
DeleteAllowedFlag | yes/no · max 30 | Read-only |
DisplayName | text | Read-onlySearchable |
DocumentCode | text · max 150 | Optional on createSearchable |
DocumentName | text · max 80 | Optional on createUpdatableSearchable |
DocumentNumber | text · max 150 | Optional on createUpdatableSearchable |
DocumentType | text · max 80 | Required on createSearchable |
DocumentTypeId | number | Required on createSearchable |
DocumentsOfRecordId | number | Optional on createSearchable |
EditAllowedFlag | yes/no · max 30 | Read-only |
FullName | text | Read-onlySearchable |
IssuedDate | date | Optional on createUpdatableSearchable |
IssuingAuthority | text · max 100 | Optional on createUpdatableSearchable |
IssuingCountry | text · max 60 | Optional on createUpdatableSearchable |
IssuingCountryName | text | Optional on createUpdatableSearchable |
IssuingLocation | text · max 100 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LegislationCode | text · max 30 | Read-onlySearchable |
ListName | text | Read-onlySearchable |
PersonId | number | Required on createSearchable |
PersonNumber | text · max 30 | Optional on createSearchable |
Publish | text · max 30 | Optional on createUpdatableSearchable |
PublishDate | date | Optional on createUpdatableSearchable |
RelatedObjectId | number | Optional on createUpdatableSearchable |
RelatedObjectIdColumn | text · max 60 | Optional on createUpdatableSearchable |
RelatedObjectName | text · max 60 | Optional on createUpdatableSearchable |
SubCategoryCode | text · max 30 | Read-onlySearchable |
SystemDocumentType | text · max 120 | Required on createSearchable |
TagList | text · max 2000 | 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 4
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByAdvancedSearchQuery·KeywordSearchQueryfindByDocumentsOfRecordId·DocumentsOfRecordIdTransactionChangesOnlyTransactionIdfindByPersonId·AssignmentIdDocumentTypeIdPersonIdPublishDateRelatedObjectIdRelatedObjectIdColumnRelatedObjectNameTransactionChangesOnlyTransactionIdfindByPersonIdAfterReload·PersonIdTransactionChangesOnly
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 9
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/<name>. Add them to a GET with expand.
attachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameAttachmentsPreviewGET Attachment Previews · 4 fields · 1 findersImageHeightImageSourceImageWidthPageNumattachmentsPreviewGET Candidate Attachments · 33 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamebannerOverrideMessagesGET Banner Override Messages · 16 fieldsBusinessProcessNameIdentificationKeyLoggedInUserTypeObjectObjectIdPrimaryActionLabelForBannerPrimaryTextForBannerRootTaskIdSecondaryTextForBannerSubjectSubjectIdTaskNumberTaskStateTransactionIdTransactionStateTransactionStatusdocumentRecordsDDFGET · POST · PATCH Developer Descriptive Flexfields for Document RecordsFields depend on your pod's flexfield setup (check
/describe).documentRecordsDFFGET · POST · PATCH Descriptive Flexfields for Document Records · 3 fieldsDocumentsOfRecordId__FLEX_Context__FLEX_Context_DisplayValuehrDocumentTypesGET HR Document Types · 55 fields · 1 findersActiveInactiveFlagArchiveCriteriaBasisArchiveCriteriaDaysAuthorizationRequiredFlagBiReportPathCategoryCodeCategoryMeaningCommentsLabelCommentsRequiredCountryNameCreatedByCreationDateDateFromLabelDateFromRequiredDateToLabelDateToRequiredDescriptionDffCtxSegDefaultValueDffCtxSegDisplayPreferenceDffGlbSegDisplayPreferenceDocumentNameLabelDocumentNameRequiredDocumentNumberLabelDocumentNumberRequiredDocumentTypeDocumentTypeIdDocumentTypeLevelHierarchyCodeIssuedDateLabelIssuedDateRequiredIssuingAuthorityLabelIssuingAuthorityRequiredIssuingCountryLabelIssuingCountryRequiredIssuingLocationLabelIssuingLocationRequiredLastUpdateDateLastUpdatedByLegislationCodeLockCreateFlagLockCreateRoleListLockDeleteFlagLockDeleteRoleListLockUpdateFlagLockUpdateRoleListMinimumAttachmentsCountMultipleOccurencesFlagPublishRequiredFlagPurgeArchiveCriteriaDaysSubCategoryCodeSubCategoryMeaningSystemDocumentTypeTagListWarningPeriodWorkflowAgentCodedocumentTypesDDFGET Developer Descriptive Flexfields for Document Types · 3 fieldsDocumentTypeId__FLEX_Context__FLEX_Context_DisplayValuedocumentTypesDFFGET Descriptive Flexfields for Document Types · 3 fieldsDocumentTypeId__FLEX_Context__FLEX_Context_DisplayValue
Actions 14
POST …/action/checkManageAccess·personIdPOST …/action/checkMassdownloadAccessPOST …/action/checkPersonDocumentTypeCreateAccess·documentTypeIdpersonIdassignmentIdPOST …/action/checkPersonDocumentTypeDeleteAccess·documentTypeIdpersonIdassignmentIdPOST …/action/checkPersonDocumentTypeEditAccess·documentTypeIdpersonIdassignmentIdPOST …/action/checkPersonDocumentTypeManageAccess·documentTypeIdpersonIdassignmentIdPOST …/action/checkViewAccess·personIdPOST …/action/checkViewUnpublishedAccessPOST …/action/downloadAttachments·queryfilterssortPOST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/action/generateDraftLetter·attributeNameValuesPOST …/action/isApprovalInProgress·nonDorFlowdocumentsOfRecordIdPOST …/{DocumentsOfRecordId}/child/hrDocumentTypes/action/checkManageAccessPOST …/{DocumentsOfRecordId}/child/hrDocumentTypes/action/checkManageDocumentTypeAccess·documentTypeId
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/documentRecordsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByAdvancedSearchQueryfor 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:AssignmentId, notassignmentid. - 16 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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.