Goal Plans
goalPlans Based on latest (2026.09)
Create, change, delete and look up Goal Plans, with associated perf document types, perf goal eligibility profiles and perf goal excluded workers. Actions include ess process trigger and find by advanced search query.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE20 actions
- Record key
GoalPlanId- Required on create
EndDateGoalPlanNameStartDate- At a glance
- 39 fields1 finders6 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/goalPlans?fields=Assignees,CanDelHRGoal,CanDelHRGoalMeaning,CreatedBy,CreationDate&limit=25&onlyData=true
{
"items": [
{
"Assignees": 0,
"CanDelHRGoal": "<string, max 60>",
"CanDelHRGoalMeaning": "<string, max 80>",
"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 39
| Attribute | Type | Use |
|---|---|---|
Assignees | number | Read-only |
CanDelHRGoal | text · max 60 | Optional on createUpdatableSearchable |
CanDelHRGoalMeaning | text · max 80 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
Description | text · max 4000 | Optional on createUpdatableSearchable |
EnableWeightingFlag | yes/no · max 30 · default true | Optional on createUpdatableSearchable |
EndDate | date | Required on createUpdatableSearchable |
EnforceGoalWeightFlag | yes/no · max 30 · default false | Optional on createUpdatableSearchable |
EnforceMaximumGoalsInGpFlag | yes/no · max 30 | Optional on createUpdatableSearchable |
EvaluationType | text · max 30 · default ORA_HRA_EVAL_TYPE_DEFAULT | Optional on createUpdatableSearchable |
EvaluationTypeMeaning | text · max 80 | Read-onlySearchable |
GoalAccessLevelCode | text · max 30 · default ALL | Optional on createUpdatableSearchable |
GoalAccessLevelMeaning | text · max 80 | Read-onlySearchable |
GoalPlanActiveCode | text · max 30 · default A | Optional on createUpdatableSearchable |
GoalPlanActiveCodeMeaning | text · max 80 | Read-onlySearchable |
GoalPlanExternalId | text · max 250 | Optional on createUpdatableSearchable |
GoalPlanId | number | Optional on createSearchable |
GoalPlanName | text · max 400 | Required on createUpdatableSearchable |
GoalPlanTypeCode | text · max 30 · default ORA_HRG_WORKER | Optional on createUpdatableSearchable |
GoalSettingEndDate | date | Optional on createUpdatableSearchable |
GoalSettingStartDate | date | Optional on createUpdatableSearchable |
GoalSubTypeCode | text · max 30 | Optional on createUpdatableSearchable |
GoalSubTypeLookupCode | text · max 30 | Read-onlySearchable |
GoalSubTypeMeaning | text · max 80 | Read-onlySearchable |
GoalsCount | number | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MassRequestId | number | Optional on createSearchable |
MaximumGoalsNumberInGoalPlan | number | Optional on createUpdatableSearchable |
MinimumGoalsNumberInGoalPlan | number | Optional on createUpdatableSearchable |
NbrOfPDConsumed | number | Read-only |
PrimaryGoalPlanFlag | yes/no · max 30 · default false | Optional on createUpdatableSearchable |
RequestStatus | text · max 30 | Optional on createUpdatableSearchable |
RestrictGoalCreationFlag | yes/no · max 30 | Optional on createUpdatableSearchable |
RestrictGoalUpdateFlag | yes/no · max 30 | Optional on createUpdatableSearchable |
ReviewPeriodId | number | Optional on createUpdatableSearchable |
ReviewPeriodName | text · max 400 | Read-onlySearchable |
StartDate | date | Required on createUpdatableSearchable |
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.
findbyAdvanceSearch·EnableWeightingFlagEndDateGoalPlanActiveCodeGoalPlanExternalIdGoalSubTypeCodeReviewPeriodIdStartDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 6
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/<name>. Add them to a GET with expand.
associatedPerfDocumentTypesGET · POST · PATCH · DELETE Associated Performance Document Types · 8 fieldsCreatedByCreationDateDocumentTypeIdGoalPlanDocumentTypeIdGoalPlanIdLastUpdateDateLastUpdatedByNamegoalPlansDFFGET · POST · PATCH · DELETE Goal Plans Descriptive Flexfields · 3 fieldsGoalPlanId__FLEX_Context__FLEX_Context_DisplayValueperfGoalEligibilityProfilesGET · POST · PATCH · DELETE Performance Goal Eligibility Profiles · 7 fieldsEligObjIdEligibilityProfileDescriptionEligibilityProfileIdEligibilityProfileNameEligibilityProfileObjectIdRequiredFlagTalentObjectTypeperfGoalExcludedWorkersGET · POST · PATCH · DELETE Performance Goal Excluded Workers · 18 fieldsAssignmentIdAssignmentNameAssignmentNumberAssignmentStatusTypeBusinessTitleCreatedByCreationDateDepartmentNameDisplayNameLastUpdateDateLastUpdatedByManagerNameMassRequestExemptionIdMassRequestHierarchyIdPersonIdPersonNumberPositionNameSysEffectiveDateperfGoalIncludedWorkersGET · POST · PATCH · DELETE Performance Goal Included Workers · 19 fieldsAssignmentIdAssignmentNameAssignmentNumberAssignmentStatusTypeBusinessTitleCascadingLevelCreatedByCreationDateDepartmentNameDirectsCountDisplayNameLastUpdateDateLastUpdatedByManagerNameMassRequestHierarchyIdPersonIdPersonNumberPositionNameSysEffectiveDateperformanceGoalsGET · POST · PATCH · DELETE Performance Goals · 62 fields · 3 findersActualCompletionDateAllowDelGoalCodeAllowDelGoalFlagAllowKeyAttrUpdateFlagAssignedByPersonIdAssignmentIdAssignmentNumberCategoryCodeCategoryMeaningChildObjectIdChildObjectNameCommentsCreatedByCreationDateDescriptionDisplaySequenceGoalApprovalStateGoalIdGoalNameGoalPlanEndDateGoalPlanGoalIdGoalPlanIdGoalPlanNameGoalPlanStartDateGoalPlanWeightEnabledGoalSourceCodeGoalSubTypeCodeGoalSubtypeMeaningGoalVersionTypeCodeLastUpdateDateLastUpdatedByLevelCodeLevelMeaningLoggedInPersonTypeLongDescriptionMassRequestIdPercentCompletionPersonIdPersonNumberPriorityCodePriorityMeaningPrivateFlagPublishDatePublishedFlagReferenceContentItemIdReferenceGoalIdRelatedLinkRequestContextRequiredGPGIdRequiresApprovalStateRequiresApprovalStatusReviewPeriodEndDateReviewPeriodIdReviewPeriodNameReviewPeriodStartDateStartDateStatusCodeStatusMeaningSuccessCriteriaTargetCompletionDateValidationBypassCodeWeighting
Actions 20
POST …/action/essProcessTrigger·paramsPOST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/action/importGoals·reviewPeriodIdinputPayloadmassRequestIdtargetMassRequestIdgoalPlanIdPOST …/{GoalPlanId}/child/performanceGoals/action/buildBipReportUrlForGoals·goalTypehostNamebipReportParametersPOST …/{GoalPlanId}/child/performanceGoals/action/cancelGoalsBatchAction·goalIdsparamsPOST …/{GoalPlanId}/child/performanceGoals/action/checkGoalsForBulkActionValidation·goalIdsparamsPOST …/{GoalPlanId}/child/performanceGoals/action/copyAttachments·copyFromGoalIdparamsPOST …/{GoalPlanId}/child/performanceGoals/action/deleteGoalsBatchAction·goalIdsparamsPOST …/{GoalPlanId}/child/performanceGoals/action/getMultiplePerformanceGoalDetails·evaluationIdgoalIdsPOST …/{GoalPlanId}/child/performanceGoals/action/getPerformanceGoalDetails·goalIdPOST …/{GoalPlanId}/child/performanceGoals/action/getPerformanceLibraryGoalDetails·contentItemIdPOST …/{GoalPlanId}/child/performanceGoals/action/goalApprovalTransactionData·reloadTransactionFlagfetchTransactionDataFlagobjectIdPOST …/{GoalPlanId}/child/performanceGoals/action/goalAssignActionBatch·IndirectReportsInputPayloadRestGoalPlanIdReviewPeriodIdAllowKeyAttrFlagGoalWeightsGoalsPOST …/{GoalPlanId}/child/performanceGoals/action/prepareApprovalTxnForSubmission·paramsPOST …/{GoalPlanId}/child/performanceGoals/action/savePerfGoalApproval·pathpayloadoperationinputParametersPOST …/{GoalPlanId}/child/performanceGoals/action/shareActionBatch·inputPayloadPOST …/{GoalPlanId}/child/performanceGoals/action/submitEss·MassRequestIdPOST …/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/checkGoalInPDAndCheckInDocPOST …/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/copyGoal·GoalPlanIdReviewPeriodIdAssignmentIdGoalNameGoalPlanGoalIdPOST …/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/goalAssignAction·InputPayloadRestGoalPlanIdReviewPeriodIdGoalWeightAllowKeyAttrFlag
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/goalPlansand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findbyAdvanceSearchfor 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:CanDelHRGoal, notcandelhrgoal. - 14 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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.