Create a channel
post
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails
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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssetFrequency: integer
(int32)
Attribute for the frequency with which the grow notification email is sent out.
-
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(required): string
Maximum Length:
240
Channel name. -
AssetStatusCode(required): string
Maximum Length:
30
Lookup code of the channel status. -
AssetTypeCode(required): string
Maximum Length:
30
Channel type. -
CampaignId(required): integer
(int64)
Internal identifier for the campaign.
-
FollowupDelay: integer
(int32)
Time between two specific communications.
-
Frequency: string
Maximum Length:
255
Frequency with which the grow notification email is sent out. -
LastDeliveryDate: string
(date-time)
Channel end date.
-
MessageDesignId: integer
(int64)
Internal identifier for the email design page.
-
notificationMetrics: array
Grow Notification Metrics
Title:
Grow Notification Metrics
The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles. -
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. -
PublishDestCode: string
Maximum Length:
32
Lookup code for the destination where the application publishes the post. -
ScheduledDate: string
(date-time)
Date the channel was scheduled.
-
SenderProfileConfigId: integer
Internal identifier for the sender profile used on the grow notification email.
-
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 : Grow Notification Metrics
Type:
array
Title:
Grow Notification Metrics
The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles.
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-post-request
Type:
Show Source
object
Nested Schema : communicateUICampaignDetails-assetDetails-notificationMetrics-item-post-request
Type:
Show Source
object
Nested Schema : communicateUICampaignDetails-assetDetails-postContent-item-post-request
Type:
Show Source
object
-
AssetId: integer
(int64)
Internal identifier for a post.
-
Description: string
Maximum Length:
512
Banner description. -
ImageURL: string
Maximum Length:
1000
Default Value:DEFAULT
URL for the banner image. -
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.
Response
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-assetDetails-item-response
Type:
Show Source
object
-
AssetFrequency: integer
(int32)
Attribute for the frequency with which the grow notification email is sent out.
-
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.
-
Frequency: string
Maximum Length:
255
Frequency with which the grow notification email is sent out. -
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.
-
notificationMetrics: array
Grow Notification Metrics
Title:
Grow Notification Metrics
The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles. -
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. -
PublishDestCode: string
Maximum Length:
32
Lookup code for the destination where the application publishes the post. -
PublishDestMeaning: string
Read Only:
true
Maximum Length:255
Destination where the application publishes the post. -
ScheduledDate: string
(date-time)
Date the channel was scheduled.
-
SenderProfileConfigId: integer
Internal identifier for the sender profile used on the grow notification email.
-
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 : Grow Notification Metrics
Type:
array
Title:
Grow Notification Metrics
The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles.
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-notificationMetrics-item-response
Type:
Show Source
object
-
AssetFrequency: integer
(int32)
Read Only:
true
Attribute for the frequency with which the grow notification email is sent out. -
Clicks: number
Read Only:
true
Count of unique clicks registered on the grow notification email so far. -
LastDeliveryDate: string
(date-time)
Read Only:
true
Date after which the application won't send the grow notification email. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextCycleDate: string
(date-time)
Read Only:
true
Date on which the application will send the next grow notification email. -
NotificationId: integer
(int64)
Read Only:
true
Unique identifier of a grow notification. -
NotificationsSent: number
Read Only:
true
Count of all the grow notification emails sent so far. -
Opened: number
Read Only:
true
Count of all the unique opens on a grow notification email so far. -
StartDeliveryDate: string
(date-time)
Read Only:
true
Date on which the application sent the first grow notification email. -
TotalCycles: integer
Read Only:
true
Total number of all the grow notification email cycles.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Links
- assetMetrics
-
Parameters:
- AssetId:
$request.path.AssetId
- CampaignId:
$request.path.CampaignId
The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign. - AssetId:
- notificationMetrics
-
Parameters:
- AssetId:
$request.path.AssetId
- CampaignId:
$request.path.CampaignId
The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles. - AssetId:
- postContent
-
Parameters:
- AssetId:
$request.path.AssetId
- CampaignId:
$request.path.CampaignId
The post content resource creates and updates the banner associated with a post based campaign. - AssetId: