Supported operations
| DELETE /goalPlans/{id} |
| GET /goalPlans |
| GET /goalPlans/{id} |
| PATCH /goalPlans/{id} |
| POST /goalPlans |
Queryable q fields (37)
Only these fields can appear in a q filter expression on
/goalPlans. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/goalPlans?q=CanDelHRGoal='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| CanDelHRGoal | string | = != |
| CanDelHRGoalMeaning | string | = != |
| CreatedBy | string | = != |
| CreationDate | string | = != |
| Description | string | = != |
| EnableWeightingFlag | boolean | = != |
| EndDate | string | = != |
| EnforceGoalWeightFlag | boolean | = != |
| EnforceMaximumGoalsInGpFlag | boolean | = != |
| EvaluationType | string | = != |
| EvaluationTypeMeaning | string | = != |
| GoalAccessLevelCode | string | = != |
| GoalAccessLevelMeaning | string | = != |
| GoalPlanActiveCode | string | = != |
| GoalPlanActiveCodeMeaning | string | = != |
| GoalPlanExternalId | string | = != |
| GoalPlanId | integer | = != |
| GoalPlanName | string | = != |
| GoalPlanTypeCode | string | = != |
| GoalSettingEndDate | string | = != |
| GoalSettingStartDate | string | = != |
| GoalSubTypeCode | string | = != |
| GoalSubTypeLookupCode | string | = != |
| GoalSubTypeMeaning | string | = != |
| GoalsCount | integer | = != |
| LastUpdateDate | string | = != |
| LastUpdatedBy | string | = != |
| MassRequestId | integer | = != |
| MaximumGoalsNumberInGoalPlan | integer | = != |
| MinimumGoalsNumberInGoalPlan | integer | = != |
| PrimaryGoalPlanFlag | boolean | = != |
| RequestStatus | string | = != |
| RestrictGoalCreationFlag | boolean | = != |
| RestrictGoalUpdateFlag | boolean | = != |
| ReviewPeriodId | integer | = != |
| ReviewPeriodName | string | = != |
| StartDate | string | = != |
Child resources (6)
Each child is reachable at
/goalPlans/{id}/child/<name>
and most can also be inlined with expand.
associatedPerfDocumentTypesgoalPlansDFFperfGoalEligibilityProfilesperfGoalExcludedWorkersperfGoalIncludedWorkersperformanceGoals Response fields (45)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
AssigneesCanDelHRGoalCanDelHRGoalMeaningCreatedByCreationDateDescriptionEnableWeightingFlagEndDateEnforceGoalWeightFlagEnforceMaximumGoalsInGpFlagEvaluationTypeEvaluationTypeMeaningGoalAccessLevelCodeGoalAccessLevelMeaningGoalPlanActiveCodeGoalPlanActiveCodeMeaningGoalPlanExternalIdGoalPlanIdGoalPlanNameGoalPlanTypeCodeGoalSettingEndDateGoalSettingStartDateGoalSubTypeCodeGoalSubTypeLookupCodeGoalSubTypeMeaningGoalsCountLastUpdateDateLastUpdatedByMassRequestIdMaximumGoalsNumberInGoalPlanMinimumGoalsNumberInGoalPlanNbrOfPDConsumedPrimaryGoalPlanFlagRequestStatusRestrictGoalCreationFlagRestrictGoalUpdateFlagReviewPeriodIdReviewPeriodNameStartDateassociatedPerfDocumentTypesgoalPlansDFFperfGoalEligibilityProfilesperfGoalExcludedWorkersperfGoalIncludedWorkersperformanceGoals 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
- /recruitingCEJobApplications Get all job applications
- /recruitingTaxCreditsCandidateDetails Get details for all job applications
- /documentRecords Get all document records
- /recruitingUICandidateResumeParsers Get all the candidate resumes in a collection
- /recruitingCECandidateResumeParsers Get all the candidate resumes in a collection
- Oracle HCM API guide
- Why the q parameter fails and how to fix it
- Finders: named queries in Oracle Fusion REST APIs
- All endpoint reference pages