- Subcategories:
- Attachments
- Banner Override Messages
- Candidate Attachments
- Descriptive Flexfields for Document Records
- Developer Descriptive Flexfields for Document Records
Document Records REST Endpoints
Document Records
The documentRecords resource includes all the document records for a person. It's used to create and view the document records for a person.
- Check access for unpublished document records
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkViewUnpublishedAccess
- Check document type create access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeCreateAccess
- Check document type delete access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeDeleteAccess
- Check document type edit access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeEditAccess
- Check if approval is in progress for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/isApprovalInProgress
- Check manage access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkManageAccess
- Check mass download access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkMassdownloadAccess
- Checks manage access of document records.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeManageAccess
- Create a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords
- Delete a document record
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
- Download attachments for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/downloadAttachments
- Find document records
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/findByAdvancedSearchQuery
- Generate letter for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/generateDraftLetter
- Get a document record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
- Get all document records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords
- Update a document record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}