Jump to

• Request
• Response

Update a channel

patch

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}

Request

Path Parameters

• AssetId(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=
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• AssetTypeCode: string
  Maximum Length: 30

  Channel type.
• CampaignId: integer (int64)
  Internal identifier for the campaign.
• FollowupDelay: integer (int32)
  Time between two specific communications.
• LastDeliveryDate: string (date-time)
  Channel end date.
• 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.
• 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.
• SiteNumber: string
  Maximum Length: 240

  Target site for social media post.
• StartDeliveryDate: string (date-time)
  Channel start date.

{
    "type":"object",
    "properties":{
        "LastDeliveryDate":{
            "type":"string",
            "description":"Channel end date.",
            "format":"date-time",
            "nullable":true
        },
        "postContent":{
            "title":"Campaign Banner Details",
            "type":"array",
            "description":"The post content resource creates and updates the banner associated with a post based campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-postContent-item-patch-request"
            }
        },
        "ScheduledDate":{
            "type":"string",
            "description":"Date the channel was scheduled.",
            "format":"date-time",
            "nullable":true
        },
        "SiteNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Target site for social media post.",
            "nullable":true
        },
        "AssetName":{
            "maxLength":"240",
            "type":"string",
            "description":"Channel name.",
            "nullable":false
        },
        "assetMetrics":{
            "title":"Campaign Channel Metrics",
            "type":"array",
            "description":"The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-assetMetrics-item-patch-request"
            }
        },
        "AssetStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Lookup code of the channel status.",
            "nullable":false
        },
        "CampaignId":{
            "type":"integer",
            "description":"Internal identifier for the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the channel row that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"Internal identifier for the email design page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "FollowupDelay":{
            "type":"integer",
            "description":"Time between two specific communications.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            }
        },
        "ParentAssetId":{
            "type":"integer",
            "description":"Internal identifier for the corresponding primary email or message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PublishDestCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Lookup code for the destination where the application publishes the post.",
            "nullable":true
        },
        "AssetTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Channel type.",
            "nullable":false
        },
        "StartDeliveryDate":{
            "type":"string",
            "description":"Channel start date.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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

• Array of: object communicateUICampaignDetails-assetDetails-assetMetrics-item-patch-request

{
    "title":"Campaign Channel Metrics",
    "type":"array",
    "description":"The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-assetMetrics-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Campaign Banner Details",
    "type":"array",
    "description":"The post content resource creates and updates the banner associated with a post based campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-postContent-item-patch-request"
    }
}

Nested Schema : communicateUICampaignDetails-assetDetails-assetMetrics-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"512",
            "type":"string",
            "description":"Banner description.",
            "nullable":false
        },
        "PrimaryAssetURL":{
            "maxLength":"255",
            "type":"string",
            "description":"URL associated with the primary action.",
            "nullable":true
        },
        "SecondaryAssetURLId":{
            "type":"integer",
            "description":"Unique identifier for the secondary action URL.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Title":{
            "maxLength":"64",
            "type":"string",
            "description":"Banner title.",
            "nullable":false
        },
        "ImageURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL for the banner image.",
            "nullable":false,
            "default":"DEFAULT"
        },
        "PrimaryLinkTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Type of link associated with the primary action.",
            "nullable":true
        },
        "PrimaryAssetURLId":{
            "type":"integer",
            "description":"Unique identifier for the primary action URL.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SecondaryLinkTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Type of link associated with the secondary action.",
            "nullable":true
        },
        "SecondaryLabel":{
            "maxLength":"64",
            "type":"string",
            "description":"Secondary action label.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the banner that the user retrieved.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "SecondaryAssetURL":{
            "maxLength":"255",
            "type":"string",
            "description":"URL associated with the secondary action.",
            "nullable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for a post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrimaryLabel":{
            "maxLength":"64",
            "type":"string",
            "description":"Primary action label.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : communicateUICampaignDetails-assetDetails-item-response

Type: object

Show Source

• 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.
• 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.
• SiteNumber: string
  Maximum Length: 240

  Target site for social media post.
• StartDeliveryDate: string (date-time)
  Channel start date.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who created the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDeliveryDate":{
            "type":"string",
            "description":"Channel end date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "postContent":{
            "title":"Campaign Banner Details",
            "type":"array",
            "description":"The post content resource creates and updates the banner associated with a post based campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-postContent-item-response"
            }
        },
        "ScheduledDate":{
            "type":"string",
            "description":"Date the channel was scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SiteNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Target site for social media post.",
            "nullable":true,
            "x-queryable":true
        },
        "PublishDestMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Destination where the application publishes the post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetName":{
            "maxLength":"240",
            "type":"string",
            "description":"Channel name.",
            "nullable":false,
            "x-queryable":true
        },
        "assetMetrics":{
            "title":"Campaign Channel Metrics",
            "type":"array",
            "description":"The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-assetMetrics-item-response"
            }
        },
        "AssetStatusMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Channel status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssetStatusCode"
                ]
            },
            "x-queryable":true
        },
        "AssetStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Lookup code of the channel status.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Internal identifier for the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the channel row that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"Internal identifier for the email design page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FollowupDelay":{
            "type":"integer",
            "description":"Time between two specific communications.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "ParentAssetId":{
            "type":"integer",
            "description":"Internal identifier for the corresponding primary email or message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PublishDestCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Lookup code for the destination where the application publishes the post.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Channel type.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for the channel associated with a campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login associated to the user who last updated the channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDeliveryDate":{
            "type":"string",
            "description":"Channel start date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object communicateUICampaignDetails-assetDetails-assetMetrics-item-response

{
    "title":"Campaign Channel Metrics",
    "type":"array",
    "description":"The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-assetMetrics-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object communicateUICampaignDetails-assetDetails-postContent-item-response

{
    "title":"Campaign Banner Details",
    "type":"array",
    "description":"The post content resource creates and updates the banner associated with a post based campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-postContent-item-response"
    }
}

Nested Schema : communicateUICampaignDetails-assetDetails-assetMetrics-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SecondaryClickedCount":{
            "type":"number",
            "description":"Unique number of times secondary action was clicked.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryClickedCount":{
            "type":"number",
            "description":"Unique number of times primary action was clicked.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for a channel's metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : communicateUICampaignDetails-assetDetails-postContent-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the banner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the banner was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who created the banner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"512",
            "type":"string",
            "description":"Banner description.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryAssetURL":{
            "maxLength":"255",
            "type":"string",
            "description":"URL associated with the primary action.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryAssetURLId":{
            "type":"integer",
            "description":"Unique identifier for the secondary action URL.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Title":{
            "maxLength":"64",
            "type":"string",
            "description":"Banner title.",
            "nullable":false,
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL for the banner image.",
            "nullable":false,
            "default":"DEFAULT",
            "x-queryable":true
        },
        "PrimaryLinkTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Type of link associated with the primary action.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryAssetURLId":{
            "type":"integer",
            "description":"Unique identifier for the primary action URL.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryLinkTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Type of link associated with the secondary action.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryLabel":{
            "maxLength":"64",
            "type":"string",
            "description":"Secondary action label.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the banner that the user retrieved.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SecondaryAssetURL":{
            "maxLength":"255",
            "type":"string",
            "description":"URL associated with the secondary action.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for a post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PostContentId":{
            "type":"integer",
            "description":"Internal identifier for a banner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the banner was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login associated to the user who last updated the banner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLabel":{
            "maxLength":"64",
            "type":"string",
            "description":"Primary action label.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

assetMetrics

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/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.

postContent

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/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.

Back to Top