Document Delivery Preferences
documentDeliveryPreferencesV2 Based on latest (2026.09)
Create, change, delete and look up Document Delivery Preferences.
The record key documentDeliveryPreferencesV2UniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
documentDeliveryPreferencesV2UniqID- Required on create
- none marked
- At a glance
- 24 fields1 finders0 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2?fields=AllowWorkerOverrideFlag,AssignmentId,AssignmentNumber,CreatedBy,CreationDate&limit=25&onlyData=true
{
"items": [
{
"AllowWorkerOverrideFlag": false,
"AssignmentId": 0,
"AssignmentNumber": "<string, max 255>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00"
}
],
"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 24
| Attribute | Type | Use |
|---|---|---|
AllowWorkerOverrideFlag | yes/no · max 30 | Read-only |
AssignmentId | number | Read-onlySearchable |
AssignmentNumber | text · max 255 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
DocumentDeliveryPreferenceId | number | Read-onlySearchable |
DocumentType | text · max 80 | Read-only |
DocumentTypeCountry | text · max 30 | Read-only |
DocumentTypeId | number | Optional on createSearchable |
EditAllowedFlag | yes/no | Read-only |
HierarchyCode | text · max 30 | Read-only |
InitialConsentValueFlag | yes/no · max 30 | Read-only |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LegislationCode | text · max 30 | Read-only |
LevelCode | text · max 40 · default 900_PERSON | Read-only |
LevelId | number | Read-only |
OnlineConsentRequiredFlag | yes/no · max 30 | Read-only |
OnlineConsentValueFlag | yes/no · max 30 | Optional on createUpdatable |
OnlineEnabledFlag | yes/no · max 30 | Optional on createUpdatable |
PaperEnabledFlag | yes/no · max 30 | Optional on createUpdatable |
PersonId | number | Optional on createSearchable |
PersonNumber | text · max 30 | Optional on createSearchable |
SystemDocumentType | text · max 120 | 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.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByPerson·PersonIdPersonNumberSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2and ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByPersonfor 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:DocumentTypeId, notdocumenttypeid. - 17 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
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.