Supported operations
| DELETE /communicateUICampaignDetails/{id} |
| GET /communicateUICampaignDetails |
| GET /communicateUICampaignDetails/{id} |
| PATCH /communicateUICampaignDetails/{id} |
| POST /communicateUICampaignDetails |
Queryable q fields (34)
Only these fields can appear in a q filter expression on
/communicateUICampaignDetails. Filtering on any other field returns
400 Bad Request.
Example q request
GET /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails?q=ActivatedOnDate='<value>'&onlyData=true&limit=25
| Field | Type | Operators |
|---|---|---|
| ActivatedOnDate | string | = != |
| AudEmailLimitEnabledFlag | boolean | = != |
| AudienceCount | integer | = != |
| AudienceSavedSearchId | integer | = != |
| CampaignCode | string | = != |
| CampaignDurationCode | string | = != |
| CampaignId | integer | = != |
| CampaignLanguageCode | string | = != |
| CampaignMediumCode | string | = != |
| CampaignName | string | = != |
| CampaignStatusCode | string | = != |
| CampaignStatusMeaning | string | = != |
| CampaignTypeCode | string | = != |
| CancelledOnDate | string | = != |
| ClosedOnDate | string | = != |
| CreatedBy | string | = != |
| CreationDate | string | = != |
| EligObjId | integer | = != |
| EligPrflId | integer | = != |
| HCMListExtractionDate | string | = != |
| HCMListId | integer | = != |
| LastUpdateDate | string | = != |
| LastUpdateLogin | string | = != |
| LastUpdatedBy | string | = != |
| ObjectVersionNumber | integer | = != |
| PurposeCode | string | = != |
| RequisitionSavedSearchId | integer | = != |
| ResponseOption | string | = != |
| SearchRequisitionsFlag | boolean | = != |
| TargetGoalValue | integer | = != |
| TeamDownloadAudienceFlag | boolean | = != |
| TeamId | integer | = != |
| TeamName | string | = != |
| VanityConfigId | integer | = != |
Child resources (13)
Each child is reachable at
/communicateUICampaignDetails/{id}/child/<name>
and most can also be inlined with expand.
assetDetailsassetMetricsaudienceDetailsboAssociationcategoriesexternalWorkspacesgoalsmsTeamsMessageMetricsownersrequisitionMetricsrequisitionsselectedLanguagesuploadAudiences Response fields (48)
Top-level attributes returned for each row. Use
fields= to request a subset and shrink the payload.
ActivatedOnDateAudEmailLimitEnabledFlagAudienceCountAudienceSavedSearchIdCampaignCodeCampaignDescriptionCampaignDurationCodeCampaignIdCampaignLanguageCodeCampaignMediumCodeCampaignNameCampaignStatusCodeCampaignStatusMeaningCampaignTypeCodeCancelledOnDateClosedOnDateCreatedByCreationDateEligObjIdEligPrflIdHCMListExtractionDateHCMListIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPurposeCodeRequisitionSavedSearchIdResponseOptionSearchRequisitionsFlagTargetGoalValueTeamDownloadAudienceFlagTeamIdTeamNameVanityConfigIdassetDetailsassetMetricsaudienceDetailsboAssociationcategoriesexternalWorkspacesgoalsmsTeamsMessageMetricsownersrequisitionMetricsrequisitionsselectedLanguagesuploadAudiences 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
- /recruitingCEJobRequisitions Get all job requisitions
- /recruitingCEJobRequisitionDetails Get all job requisition details in preview mode
- /recruitingCEJobRequisitionDetailsPreviews Get all job requisition details in preview mode
- /recruitingICEJobRequisitionDetails Get details for all job requisitions
- /recruitingUIJobOfferDetails Get details about all recruiting job offers
- 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