Jump to

• Request
• Response

Get all campaigns

get

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all campaigns using a unique identifier.
    Finder Variables
    • CampaignId; integer; Internal identifier for the campaign.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActivatedOnDate; string; Date on which campaign was scheduled.
  • AudienceSavedSearchId; integer; Audience based search criteria saved by the user.
  • CampaignCode; string; Campaign number.
  • CampaignDurationCode; string; Identifies whether the campaign is ongoing or one-time.
  • CampaignId; integer; Internal identifier for the campaign.
  • CampaignLanguageCode; string; Language associated with the campaign.
  • CampaignMediumCode; string; Indicates whether the campaign is an email and message or post based campaign.
  • CampaignName; string; Name of the campaign.
  • CampaignStatusCode; string; Lookup code associated with campaign status.
  • CampaignStatusMeaning; string; Campaign status.
  • CampaignTypeCode; string; Indicates whether the campaign is recruiting or communicate campaign.
  • CancelledOnDate; string; Date on which the campaign was canceled.
  • ClosedOnDate; string; Date on which the campaign was closed.
  • CreatedBy; string; Person who created the campaign.
  • CreationDate; string; Date on which the campaign was created.
  • EligObjId; integer; Internal key defined for the combination of the campaign and audience selection.
  • EligPrflId; integer; Internal identifier for the eligibility profile associated with a campaign audience.
  • HCMListId; integer; Internal identifier for the HCM list associated with a campaign audience.
  • LastUpdateDate; string; Date on which the campaign was last updated.
  • LastUpdateLogin; string; Session login associated to the user who last updated the campaign.
  • LastUpdatedBy; string; Person who last updated the campaign.
  • ObjectVersionNumber; integer; Version number of the campaign row that the user retrieved.
  • PurposeCode; string; Campaign purpose.
  • RequisitionSavedSearchId; integer; Requisition based search criteria saved by the user.
  • ResponseOption; string; Setting which allows the campaign manager to show or hide responses from the audience.
  • TargetGoalValue; integer; Target goal value for a campaign.
  • TeamId; integer; Internal identifier for the communication team.
  • TeamName; string; Communication team name.
  • VanityConfigId; integer; Internal identifier for a sender profile associated with a campaign.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object communicateUICampaignDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-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 : communicateUICampaignDetails-item-response

Type: object

Show Source

• 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.
• HCMListId: integer (int64)
  Internal identifier for the HCM list 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the campaign was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivatedOnDate":{
            "title":"Activation Date",
            "type":"string",
            "description":"Date on which campaign was scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetGoalValue":{
            "title":"Campaign Goal",
            "type":"integer",
            "description":"Target goal value for a campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "VanityConfigId":{
            "type":"integer",
            "description":"Internal identifier for a sender profile associated with a campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "owners":{
            "title":"Campaign Owners",
            "type":"array",
            "description":"The owner details resource adds and updates the owners for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-owners-item-response"
            }
        },
        "TeamName":{
            "maxLength":"255",
            "type":"string",
            "description":"Communication team name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedOnDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"Date on which the campaign was closed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignLanguageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Language associated with the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Campaign Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Campaign purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "assetDetails":{
            "title":"Campaign Channel Details",
            "type":"array",
            "description":"The asset details resource creates and updates channels on the campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-item-response"
            }
        },
        "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 campaign row that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RequisitionSavedSearchId":{
            "type":"integer",
            "description":"Requisition based search criteria saved by the user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStatusMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Campaign status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CampaignStatusCode"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who created the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligObjId":{
            "type":"integer",
            "description":"Internal key defined for the combination of the campaign and audience selection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignDescription":{
            "title":"Campaign Description",
            "type":"string",
            "description":"Campaign description.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EligPrflId":{
            "type":"integer",
            "description":"Internal identifier for the eligibility profile associated with a campaign audience.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "audienceDetails":{
            "title":"Campaign Audience Details",
            "type":"array",
            "description":"The audience details resource adds and updates the audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-item-response"
            }
        },
        "TeamId":{
            "type":"integer",
            "description":"Internal identifier for the communication team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignCode":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"Campaign number.",
            "nullable":false,
            "x-queryable":true
        },
        "CancelledOnDate":{
            "type":"string",
            "description":"Date on which the campaign was canceled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HCMListId":{
            "type":"integer",
            "description":"Internal identifier for the HCM list associated with a campaign audience.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the campaign is recruiting or communicate campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Lookup code associated with campaign status.",
            "nullable":false,
            "x-queryable":true
        },
        "ResponseOption":{
            "maxLength":"30",
            "type":"string",
            "description":"Setting which allows the campaign manager to show or hide responses from the audience.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignDurationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Identifies whether the campaign is ongoing or one-time.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignMediumCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Indicates whether the campaign is an email and message or post based campaign.",
            "nullable":false,
            "default":"ORA_BASIC",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the campaign 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 campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceSavedSearchId":{
            "type":"integer",
            "description":"Audience based search criteria saved by the user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Channel Details

Type: array

Title: Campaign Channel Details

The asset details resource creates and updates channels on the campaign.

Show Source

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

{
    "title":"Campaign Channel Details",
    "type":"array",
    "description":"The asset details resource creates and updates channels on the campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-item-response"
    }
}

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

• Array of: object communicateUICampaignDetails-audienceDetails-item-response

{
    "title":"Campaign Audience Details",
    "type":"array",
    "description":"The audience details resource adds and updates the audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-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 Owners

Type: array

Title: Campaign Owners

The owner details resource adds and updates the owners for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-owners-item-response

{
    "title":"Campaign Owners",
    "type":"array",
    "description":"The owner details resource adds and updates the owners for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-owners-item-response"
    }
}

Nested Schema : communicateUICampaignDetails-assetDetails-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date the channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDeliveryDate":{
            "type":"string",
            "description":"Channel end date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledDate":{
            "type":"string",
            "description":"Date the channel was scheduled.",
            "format":"date-time",
            "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
        },
        "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
        },
        "FollowupDelay":{
            "type":"integer",
            "description":"Time between two specific communications.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "notificationMetrics":{
            "title":"Grow Notification Metrics",
            "type":"array",
            "description":"The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-notificationMetrics-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the channel.",
            "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
        },
        "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"
            }
        },
        "SenderProfileConfigId":{
            "type":"integer",
            "description":"Internal identifier for the sender profile used on the grow notification email.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Target site for social media post.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetFrequency":{
            "type":"integer",
            "description":"Attribute for the frequency with which the grow notification email is sent out.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "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"
            }
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"Internal identifier for the email design page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "Frequency":{
            "maxLength":"255",
            "type":"string",
            "description":"Frequency with which the grow notification email is sent out.",
            "nullable":true,
            "x-queryable":true
        },
        "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 : 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

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

{
    "title":"Grow Notification Metrics",
    "type":"array",
    "description":"The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-notificationMetrics-item-response"
    },
    "x-cardinality":"1"
}

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-notificationMetrics-item-response

Type: object

Show Source

• AssetFrequency: integer (int32)
  Read Only: true

  Attribute for the frequency with which the grow notification email is sent out.
• AssetId: integer (int64)
  Read Only: true

  Internal identifier for a grow notification's metrics.
• 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.

{
    "type":"object",
    "properties":{
        "Opened":{
            "type":"number",
            "description":"Count of all the unique opens on a grow notification email so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDeliveryDate":{
            "type":"string",
            "description":"Date after which the application won't send the grow notification email.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Unique identifier of a grow notification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalCycles":{
            "type":"integer",
            "description":"Total number of all the grow notification email cycles.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextCycleDate":{
            "type":"string",
            "description":"Date on which the application will send the next grow notification email.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Clicks":{
            "type":"number",
            "description":"Count of unique clicks registered on the grow notification email so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetFrequency":{
            "type":"integer",
            "description":"Attribute for the frequency with which the grow notification email is sent out.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "NotificationsSent":{
            "type":"number",
            "description":"Count of all the grow notification emails sent so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for a grow notification's metrics.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDeliveryDate":{
            "type":"string",
            "description":"Date on which the application sent the first grow notification email.",
            "format":"date-time",
            "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 : 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"
    }
}

Nested Schema : communicateUICampaignDetails-audienceDetails-item-response

Type: object

Show Source

• AudienceCount: integer (int32)
  Total number of employees who will see the post.
• AudienceExtractionDate: string (date-time)
  Date when the audience was extracted.
• AudienceId: integer (int64)
  Internal identifier for the association between a campaign and its corresponding audience.
• AudienceSourceId: integer (int64)
  Internal identifier for the selected audience list.
• AudienceSourceName: string
  Read Only: true

  Maximum Length: 255

  Name of the selected audience list.
• AudienceSourceType: string
  Maximum Length: 64

  Type of audience list.
• CampaignAudienceSourceItems: array Campaign Target Audience Details
  Title: Campaign Target Audience Details

  The audience source item resource provides the target audience for a campaign.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the audience.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the audience was added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who added the audience.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceExtractionDate":{
            "type":"string",
            "description":"Date when the audience was extracted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AudienceSourceType":{
            "maxLength":"64",
            "type":"string",
            "description":"Type of audience list.",
            "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 associated with the audience that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Total number of employees who will see the post.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AudienceId":{
            "type":"integer",
            "description":"Internal identifier for the association between a campaign and its corresponding audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AudienceSourceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the selected audience list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignAudienceSourceItems":{
            "title":"Campaign Target Audience Details",
            "type":"array",
            "description":"The audience source item resource provides the target audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response"
            }
        },
        "AudienceSourceId":{
            "type":"integer",
            "description":"Internal identifier for the selected audience list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the audience 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 audience.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Target Audience Details

Type: array

Title: Campaign Target Audience Details

The audience source item resource provides the target audience for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response

{
    "title":"Campaign Target Audience Details",
    "type":"array",
    "description":"The audience source item resource provides the target audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-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 : communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response

Type: object

Show Source

• AudienceId: integer (int64)
  Internal identifier for the source of the campaign audience.
• AudienceItemId: integer (int64)
  Unique identifier generated by the application for the campaign target audience.
• ItemId: integer (int64)
  Unique identifier generated by user input for the campaign target audience.
• ItemMeaning: string
  Read Only: true

  Maximum Length: 255

  Name of the campaign target audience.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AudienceItemId":{
            "type":"integer",
            "description":"Unique identifier generated by the application for the campaign target audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AudienceId":{
            "type":"integer",
            "description":"Internal identifier for the source of the campaign audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the campaign target audience.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier generated by user input for the campaign target audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : communicateUICampaignDetails-owners-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the list of campaign owners.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the campaign owner was added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who added the campaign owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Unique identifier for the entity the campaign owner's working on.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollaboratorRespTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Lookup code for the collaborator type.",
            "nullable":true,
            "x-queryable":true
        },
        "MemberTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Lookup code for the member type.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of entity the campaign owner's working on.",
            "nullable":false,
            "x-queryable":true
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Internal identifier for a campaign owner associated with a specific campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier for the campaign owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the list of campaign owners that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Internal identifier for the employee's assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the list of campaign owners 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 list of campaign owners.",
            "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"
    }
}

Links

campaignAction

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/action/campaignAction

Allows user to perform various actions on the campaign based on the campaign status.

Back to Top