Supported operations
| DELETE /documentRecords/{id} |
| GET /documentRecords |
| GET /documentRecords/{id} |
| PATCH /documentRecords/{id} |
| POST /documentRecords |
Queryable q fields (39)
Only these fields can appear in a q filter expression on
/documentRecords. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/documentRecords?q=AssignmentName='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| AssignmentId | integer | = != |
| AssignmentName | string | = != |
| AssignmentNumber | string | = != |
| CategoryCode | string | = != |
| Classification | string | = != |
| Comments | string | = != |
| Country | string | = != |
| CreatedBy | string | = != |
| CreationDate | string | = != |
| CreationSource | string | = != |
| DateFrom | string | = != |
| DateTo | string | = != |
| DisplayName | string | = != |
| DocumentCode | string | = != |
| DocumentName | string | = != |
| DocumentNumber | string | = != |
| DocumentType | string | = != |
| DocumentTypeId | integer | = != |
| DocumentsOfRecordId | integer | = != |
| FullName | string | = != |
| IssuedDate | string | = != |
| IssuingAuthority | string | = != |
| IssuingCountry | string | = != |
| IssuingCountryName | string | = != |
| IssuingLocation | string | = != |
| LastUpdateDate | string | = != |
| LastUpdatedBy | string | = != |
| LegislationCode | string | = != |
| ListName | string | = != |
| PersonId | integer | = != |
| PersonNumber | string | = != |
| Publish | string | = != |
| PublishDate | string | = != |
| RelatedObjectId | integer | = != |
| RelatedObjectIdColumn | string | = != |
| RelatedObjectName | string | = != |
| SubCategoryCode | string | = != |
| SystemDocumentType | string | = != |
| TagList | string | = != |
Child resources (6)
Each child is reachable at
/documentRecords/{id}/child/<name>
and most can also be inlined with expand.
attachmentsattachmentsPreviewbannerOverrideMessagesdocumentRecordsDDFdocumentRecordsDFFhrDocumentTypes Response fields (48)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
AssignmentIdAssignmentNameAssignmentNumberAttachmentsCountCategoryCodeClassificationCommentsCountryCreatedByCreationDateCreationSourceDateFromDateToDeleteAllowedFlagDisplayNameDocumentCodeDocumentNameDocumentNumberDocumentTypeDocumentTypeIdDocumentsOfRecordIdEditAllowedFlagFullNameIssuedDateIssuingAuthorityIssuingCountryIssuingCountryNameIssuingLocationLastUpdateDateLastUpdatedByLegislationCodeListNamePersonIdPersonNumberPublishPublishDateRelatedObjectIdRelatedObjectIdColumnRelatedObjectNameSubCategoryCodeSystemDocumentTypeTagListattachmentsattachmentsPreviewbannerOverrideMessagesdocumentRecordsDDFdocumentRecordsDFFhrDocumentTypes 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
- /publicWorkers Get all workers
- /recruitingICEJobRequisitions Get all job requisitions
- /goalPlans Get all goal plans
- /recruitingCEJobApplications Get all job applications
- /recruitingTaxCreditsCandidateDetails Get details for all job applications
- Oracle HCM API guide
- Why the q parameter fails and how to fix it
- Finders: named queries in Oracle Fusion REST APIs
- All endpoint reference pages