Get a campaign
get
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}
Request
Path Parameters
-
CampaignId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : communicateUICampaignDetails-item-response
Type:
Show Source
object
-
ActivatedOnDate: string
(date-time)
Title:
Activation Date
Date on which campaign was scheduled. -
assetDetails: array
Campaign Channel Details
Title:
Campaign Channel Details
The asset details resource creates and updates channels on the campaign. -
audienceDetails: array
Campaign Audience Details
Title:
Campaign Audience Details
The audience details resource adds and updates the audience for a campaign. -
AudienceSavedSearchId: integer
(int64)
Audience based search criteria saved by the user.
-
CampaignCode: string
Title:
Campaign Number
Maximum Length:30
Campaign number. -
CampaignDescription: string
(byte)
Title:
Campaign Description
Campaign description. -
CampaignDurationCode: string
Maximum Length:
30
Identifies whether the campaign is ongoing or one-time. -
CampaignId: integer
(int64)
Internal identifier for the campaign.
-
CampaignLanguageCode: string
Maximum Length:
30
Language associated with the campaign. -
CampaignMediumCode: string
Maximum Length:
32
Default Value:ORA_BASIC
Indicates whether the campaign is an email and message or post based campaign. -
CampaignName: string
Title:
Campaign Name
Maximum Length:240
Name of the campaign. -
CampaignStatusCode: string
Title:
Status
Maximum Length:30
Lookup code associated with campaign status. -
CampaignStatusMeaning: string
Read Only:
true
Maximum Length:255
Campaign status. -
CampaignTypeCode: string
Maximum Length:
30
Indicates whether the campaign is recruiting or communicate campaign. -
CancelledOnDate: string
(date-time)
Date on which the campaign was canceled.
-
ClosedOnDate: string
(date-time)
Title:
Closed Date
Date on which the campaign was closed. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the campaign. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the campaign was created. -
EligObjId: integer
(int64)
Internal key defined for the combination of the campaign and audience selection.
-
EligPrflId: integer
(int64)
Internal identifier for the eligibility profile associated with a campaign audience.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the campaign was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the campaign. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the campaign. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Version number of the campaign row that the user retrieved.
-
owners: array
Campaign Owners
Title:
Campaign Owners
The owner details resource adds and updates the owners for a campaign. -
PurposeCode: string
Title:
Campaign Purpose
Maximum Length:30
Campaign purpose. -
RequisitionSavedSearchId: integer
(int64)
Requisition based search criteria saved by the user.
-
ResponseOption: string
Maximum Length:
30
Setting which allows the campaign manager to show or hide responses from the audience. -
TargetGoalValue: integer
(int64)
Title:
Campaign Goal
Target goal value for a campaign. -
TeamId: integer
(int64)
Internal identifier for the communication team.
-
TeamName: string
Read Only:
true
Maximum Length:255
Communication team name. -
VanityConfigId: integer
(int64)
Internal identifier for a sender profile associated with a campaign.
Nested Schema : Campaign Channel Details
Type:
array
Title:
Campaign Channel Details
The asset details resource creates and updates channels on the campaign.
Show Source
Nested Schema : Campaign Audience Details
Type:
array
Title:
Campaign Audience Details
The audience details resource adds and updates the audience for a campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Campaign Owners
Type:
array
Title:
Campaign Owners
The owner details resource adds and updates the owners for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Internal identifier for the channel associated with a campaign.
-
assetMetrics: array
Campaign Channel Metrics
Title:
Campaign Channel Metrics
The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign. -
AssetName: string
Maximum Length:
240
Channel name. -
AssetStatusCode: string
Maximum Length:
30
Lookup code of the channel status. -
AssetStatusMeaning: string
Read Only:
true
Maximum Length:255
Channel status. -
AssetTypeCode: string
Maximum Length:
30
Channel type. -
CampaignId: integer
(int64)
Internal identifier for the campaign.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the channel. -
CreationDate: string
(date-time)
Read Only:
true
Date the channel was created. -
FollowupDelay: integer
(int32)
Time between two specific communications.
-
LastDeliveryDate: string
(date-time)
Channel end date.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date the channel was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the channel. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the channel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDesignId: integer
(int64)
Internal identifier for the email design page.
-
ObjectVersionNumber: integer
(int32)
Version number of the channel row that the user retrieved.
-
ParentAssetId: integer
(int64)
Internal identifier for the corresponding primary email or message.
-
postContent: array
Campaign Banner Details
Title:
Campaign Banner Details
The post content resource creates and updates the banner associated with a post based campaign. -
ScheduledDate: string
(date-time)
Date the channel was scheduled.
-
SiteNumber: string
Maximum Length:
240
Target site for social media post. -
StartDeliveryDate: string
(date-time)
Channel start date.
Nested Schema : Campaign Channel Metrics
Type:
array
Title:
Campaign Channel Metrics
The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Campaign Banner Details
Type:
array
Title:
Campaign Banner Details
The post content resource creates and updates the banner associated with a post based campaign.
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-assetMetrics-item-response
Type:
Show Source
object
-
AssetId: integer
Read Only:
true
Internal identifier for a channel's metrics. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryClickedCount: number
Read Only:
true
Unique number of times primary action was clicked. -
SecondaryClickedCount: number
Read Only:
true
Unique number of times secondary action was clicked.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : communicateUICampaignDetails-assetDetails-postContent-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Internal identifier for a post.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the banner. -
CreationDate: string
(date-time)
Read Only:
true
Date the banner was created. -
Description: string
Maximum Length:
512
Banner description. -
ImageURL: string
Maximum Length:
1000
Default Value:DEFAULT
URL for the banner image. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the banner was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the banner. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the banner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Version number of the banner that the user retrieved.
-
PostContentId: integer
(int64)
Internal identifier for a banner.
-
PrimaryAssetURL: string
Maximum Length:
255
URL associated with the primary action. -
PrimaryAssetURLId: integer
(int64)
Unique identifier for the primary action URL.
-
PrimaryLabel: string
Maximum Length:
64
Primary action label. -
PrimaryLinkTypeCode: string
Maximum Length:
32
Type of link associated with the primary action. -
SecondaryAssetURL: string
Maximum Length:
255
URL associated with the secondary action. -
SecondaryAssetURLId: integer
(int64)
Unique identifier for the secondary action URL.
-
SecondaryLabel: string
Maximum Length:
64
Secondary action label. -
SecondaryLinkTypeCode: string
Maximum Length:
32
Type of link associated with the secondary action. -
Title: string
Maximum Length:
64
Banner title.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-item-response
Type:
Show Source
object
-
AudienceCount: integer
(int32)
Total number of employees who will see the post.
-
AudienceSourceId: integer
(int64)
Internal identifier for the selected audience list.
-
AudienceSourceName: string
Maximum Length:
240
Name of the selected audience list. -
AudienceSourceType: string
Maximum Length:
255
Type of audience list. -
CampaignId: integer
(int64)
Internal identifier for the campaign.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who added the audience. -
CreationDate: string
(date-time)
Read Only:
true
Date the audience was added to the campaign. -
EligObjId: integer
(int64)
Internal key defined for the combination of the campaign and audience selection.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date the audience was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the audience. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the audience. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Version number associated with the audience that the user retrieved.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicateUICampaignDetails-owners-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Internal identifier for the employee's assignment.
-
CollaboratorRespTypeCode: string
Maximum Length:
30
Lookup code for the collaborator type. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who added the campaign owner. -
CreationDate: string
(date-time)
Read Only:
true
Date the campaign owner was added to the campaign. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the list of campaign owners was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the list of campaign owners. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the list of campaign owners. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberTypeCode: string
Maximum Length:
30
Lookup code for the member type. -
ObjectId: integer
(int64)
Unique identifier for the entity the campaign owner's working on.
-
ObjectType: string
Maximum Length:
30
Type of entity the campaign owner's working on. -
ObjectVersionNumber: integer
(int32)
Version number associated with the list of campaign owners that the user retrieved.
-
PersonId: integer
(int64)
Person identifier for the campaign owner.
-
TeamMemberId: integer
(int64)
Internal identifier for a campaign owner associated with a specific campaign.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assetDetails
-
Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetailsParameters:
- CampaignId:
$request.path.CampaignId
The asset details resource creates and updates channels on the campaign. - CampaignId:
- audienceDetails
-
Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetailsParameters:
- CampaignId:
$request.path.CampaignId
The audience details resource adds and updates the audience for a campaign. - CampaignId:
- owners
-
Parameters:
- CampaignId:
$request.path.CampaignId
The owner details resource adds and updates the owners for a campaign. - CampaignId: