Oracle Fusion HCM endpoint reference

Person Notes REST API

Get all person notes

GET https://your-pod.oraclecloud.com/hcmRestApi/resources/11.13.18.05/personNotes

Everything on this page is extracted from Oracle's official OpenAPI specification for Fusion Cloud HCM: 25 queryable q fields, and 1 child resource. Unsure how q works? See the Oracle HCM API guide.

Supported operations

DELETE /personNotes/{id}
GET /personNotes
GET /personNotes/{id}
PATCH /personNotes/{id}
POST /personNotes

Queryable q fields (25)

Only these fields can appear in a q filter expression on /personNotes. Filtering on any other field returns 400 Bad Request.

Example q request

GET /hcmRestApi/resources/11.13.18.05/personNotes?q=AuthorKnownAs='<value>'&onlyData=true&limit=25
Field Type Operators
AuthorId integer = !=
AuthorKnownAs string = !=
AuthorName string = !=
CardTitle string = !=
ContextId integer = !=
ContextId2 integer = !=
ContextType string = !=
ContextType2 string = !=
CreatedBy string = !=
CreationDate string = !=
DeleteNonAuthorFlag boolean = !=
ForeignKeyReferenceFlag boolean = !=
HiddenFlag boolean = !=
HideShowFlag boolean = !=
HideShowNonRecipientFlag boolean = !=
ImageReferenceURL string = !=
LastUpdateDate string = !=
LastUpdatedBy string = !=
NoteId integer = !=
NoteVisibilityCode string = !=
NoteVisibilityMeaning string = !=
ThankYouFlag boolean = !=
WorkerId integer = !=
WorkerKnownAs string = !=
WorkerName string = !=

Child resources (1)

Each child is reachable at /personNotes/{id}/child/<name> and most can also be inlined with expand.

attachments

Response fields (29)

Top-level attributes returned for each row. Use fields= to request a subset and shrink the payload.

AuthorIdAuthorKnownAsAuthorNameAuthorNumberCardTitleContextIdContextId2ContextTypeContextType2CreatedByCreationDateDeleteNonAuthorFlagForeignKeyReferenceFlagHiddenFlagHideShowFlagHideShowNonRecipientFlagImageReferenceURLLastUpdateDateLastUpdatedByNoteIdNoteTextNoteVisibilityCodeNoteVisibilityMeaningThankYouFlagWorkerIdWorkerKnownAsWorkerNameWorkerNumberattachments

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