Nudge Plan Executions
nudgePlanExecutions Based on latest (2026.09)
Look up Nudge Plan Executions, with nudge counts, nudges and object nudges. Actions include find by advanced search query and find by advanced search for nudge execution detail. Changes only through its actions.
- Operations
- GET (list)GET (one)6 actions
- Record key
PlanExecutionId- Required on create
- no create on this resource
- At a glance
- 10 fields0 finders5 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/nudgePlanExecutions?fields=EndDate,ExecutionRequestId,NudgePlanId,ObjectType,PlanExecutionId&limit=25&onlyData=true
{
"items": [
{
"EndDate": "2026-01-31T09:00:00+00:00",
"ExecutionRequestId": 0,
"NudgePlanId": 0,
"ObjectType": "ORA_PERSON",
"PlanExecutionId": 0
}
],
"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 10
| Attribute | Type | Use |
|---|---|---|
EndDate | date-time | Searchable |
ExecutionRequestId | number | Searchable |
NudgePlanId | number | Searchable |
ObjectType | text · max 30 · default ORA_PERSON | Read-onlySearchable |
PlanExecutionId | number | Searchable |
PlanName | text · max 120 | Read-onlySearchable |
RunType | text · max 30 | Searchable |
StartDate | date-time | Searchable |
Status | text · max 30 | Searchable |
SubscriberCode | text · max 30 · default PER | 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.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 5
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/nudgePlanExecutions/{PlanExecutionId}/child/<name>. Add them to a GET with expand.
nudgeCountsGET Nudge Counts · 8 fieldsErrorMessageErrorStackTraceNudgeCountNudgeNamePlanExecutionIdPlanExecutionStatIdPlanNudgeIdStatusnudgesGET Nudges · 14 fieldsAssigneeNameAssigneePersonIdAssignmentIdDisplayNameFirstPlanExecutionIdLastPlanExecutionIdNudgeIdNudgeKeyNudgeNameNudgePlanIdNudgeTypeCodeNudgeTypeMeaningPlanNudgeIdProductCodechannelsGET Channels · 14 fieldsChannelTypeChannelTypeMeaningEndDateErrorDetailsNudgeChannelDetailIdNudgeIdRecipientPersonIdRecipientPersonNameRecipientTypeRecipientTypeMeaningStartDateStatusStatusMeaningWorkflowInstanceobjectNudgesGET Object Nudges · 13 fieldsFirstPlanExecutionIdInitiatorPersonIdLastPlanExecutionIdNudgeKeyNudgeNameNudgePlanIdNudgeTypeCodeNudgeTypeMeaningObjectIdObjectNudgeIdPlanNudgeIdProductCodeProductCodeMeaningchannelsGET Channels · 14 fieldsChannelTypeChannelTypeMeaningEndDateErrorDetailsNudgeChannelDetailIdNudgeIdRecipientPersonIdRecipientPersonNameRecipientTypeRecipientTypeMeaningStartDateStatusStatusMeaningWorkflowInstance
Actions 6
POST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/{PlanExecutionId}/action/findByAdvancedSearchForNudgeExecutionDetail·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/{PlanExecutionId}/action/findByAdvancedSearchForNudgeExecutionSummary·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/{PlanExecutionId}/action/findByAdvancedSearchForObjectNudgeExecutionDetail·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/{PlanExecutionId}/child/nudges/{NudgeId}/action/findByAdvancedSearchForNudgeExecutionChannelDetail·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/{PlanExecutionId}/child/objectNudges/{ObjectNudgeId}/action/findByAdvancedSearchForNudgeExecutionChannelDetail·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQuery
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/nudgePlanExecutionsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - 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:EndDate, notenddate. - 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.