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.
  • RowFinder Finds all campaigns using a row finder.
    Finder Variables
• 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.
  • AudienceCount; integer; Total audience count associated with a campaign.
  • 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.
  • HCMListExtractionDate; string; Date when the HCM list was extracted.
  • 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 assetDetails resource provides details on how to create and update channels on the campaign.
• assetMetrics: array Campaign Channel Metrics
  Title: Campaign Channel Metrics

  The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.
• AudienceCount: integer (int64)
  Total audience count associated with a campaign.
• audienceDetails: array Campaign Audience Details
  Title: Campaign Audience Details

  The audienceDetails resource provides details on how to add and update the audience for a campaign.
• AudienceSavedSearchId: integer (int64)
  Audience based search criteria saved by the user.
• boAssociation: array Campaign Business Object Association
  Title: Campaign Business Object Association

  The boAssociation resource creates and updates a campaign.
• CampaignCode: string
  Title: Number

  Maximum Length: 30

  Campaign number.
• CampaignDescription: string (byte)
  Title: Description

  Campaign description.
• CampaignDurationCode: string
  Title: Duration

  Maximum Length: 30

  Identifies whether the campaign is ongoing or one-time.
• CampaignId: integer (int64)
  Internal identifier for the campaign.
• CampaignLanguageCode: string
  Title: Languages

  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: 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.
• goals: array Campaigns Goals
  Title: Campaigns Goals

  The goals resource provides details on how to create and update the goals of a campaign.
• HCMListExtractionDate: string (date-time)
  Date when the HCM list was extracted.
• 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 owners resource provides details on how to add and update the owners of a campaign.
• PurposeCode: string
  Title: Purpose

  Maximum Length: 30

  Campaign purpose.
• RequisitionSavedSearchId: integer (int64)
  Requisition based search criteria saved by the user.
• ResponseOption: string
  Title: Show Individual Responses

  Maximum Length: 30

  Setting which allows the campaign manager to show or hide responses from the audience.
• selectedLanguages: array Campaign Languages
  Title: Campaign Languages

  The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.
• TargetGoalValue: integer (int64)
  Title: Campaign Goal

  Target goal value for a campaign.
• TeamId: integer (int64)
  Title: Team

  Internal identifier for the communication team.
• TeamName: string
  Read Only: true

  Maximum Length: 255

  Communication team name.
• VanityConfigId: integer (int64)
  Title: Email Sender Profile

  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":{
            "title":"Email Sender Profile",
            "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":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "owners":{
            "title":"Campaign Owners",
            "type":"array",
            "description":"The owners resource provides details on how to add and update the owners of 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":{
            "title":"Languages",
            "maxLength":30,
            "type":"string",
            "description":"Language associated with the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Campaign purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "assetDetails":{
            "title":"Campaign Channel Details",
            "type":"array",
            "description":"The assetDetails resource provides details on how to create and update 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
        },
        "boAssociation":{
            "title":"Campaign Business Object Association",
            "type":"array",
            "description":"The boAssociation resource creates and updates a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-boAssociation-item-response"
            }
        },
        "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"
            }
        },
        "goals":{
            "title":"Campaigns Goals",
            "type":"array",
            "description":"The goals resource provides details on how to create and update the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-item-response"
            }
        },
        "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":"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 audienceDetails resource provides details on how to add and update the audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-item-response"
            }
        },
        "TeamId":{
            "title":"Team",
            "type":"integer",
            "description":"Internal identifier for the communication team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignCode":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"Campaign number.",
            "nullable":false,
            "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
        },
        "CancelledOnDate":{
            "type":"string",
            "description":"Date on which the campaign was canceled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "assetMetrics":{
            "title":"Campaign Channel Metrics",
            "type":"array",
            "description":"The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetMetrics-item-response"
            }
        },
        "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
        },
        "selectedLanguages":{
            "title":"Campaign Languages",
            "type":"array",
            "description":"The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-selectedLanguages-item-response"
            }
        },
        "ResponseOption":{
            "title":"Show Individual Responses",
            "maxLength":30,
            "type":"string",
            "description":"Setting which allows the campaign manager to show or hide responses from the audience.",
            "nullable":true,
            "x-queryable":true
        },
        "HCMListExtractionDate":{
            "type":"string",
            "description":"Date when the HCM list was extracted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Total audience count associated with a campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignDurationCode":{
            "title":"Duration",
            "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 assetDetails resource provides details on how to create and update channels on the campaign.

Show Source

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

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

Nested Schema : Campaign Channel Metrics

Type: array

Title: Campaign Channel Metrics

The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.

Show Source

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

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

Nested Schema : Campaign Audience Details

Type: array

Title: Campaign Audience Details

The audienceDetails resource provides details on how to add and update the audience for a campaign.

Show Source

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

{
    "title":"Campaign Audience Details",
    "type":"array",
    "description":"The audienceDetails resource provides details on how to add and update the audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-item-response"
    }
}

Nested Schema : Campaign Business Object Association

Type: array

Title: Campaign Business Object Association

The boAssociation resource creates and updates a campaign.

Show Source

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

{
    "title":"Campaign Business Object Association",
    "type":"array",
    "description":"The boAssociation resource creates and updates a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-boAssociation-item-response"
    }
}

Nested Schema : Campaigns Goals

Type: array

Title: Campaigns Goals

The goals resource provides details on how to create and update the goals of a campaign.

Show Source

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

{
    "title":"Campaigns Goals",
    "type":"array",
    "description":"The goals resource provides details on how to create and update the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-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 owners resource provides details on how to add and update the owners of a campaign.

Show Source

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

{
    "title":"Campaign Owners",
    "type":"array",
    "description":"The owners resource provides details on how to add and update the owners of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-owners-item-response"
    }
}

Nested Schema : Campaign Languages

Type: array

Title: Campaign Languages

The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.

Show Source

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

{
    "title":"Campaign Languages",
    "type":"array",
    "description":"The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-selectedLanguages-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 assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.
• AssetName: string
  Title: Name

  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.
• audienceSegments: array Campaign Audience Segments
  Title: Campaign Audience Segments

  The audienceSegments resource provides details on how to retrieve the segments associated with one or more channels defined within a campaign.
• CampaignId: integer (int64)
  Internal identifier for the campaign.
• ContentLastModified: string (date-time)
  Read Only: true

  Date when the campaign content was last modified.
• 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)
  Title: End Date

  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 notificationMetrics resource provides details on how to retrieve the metrics associated with one or more 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 postContent resource provides details on how to create and update 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)
  Title: Delivery Date

  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.
• SMSText: string
  Title: SMS Text

  Maximum Length: 255

  SMS text.
• StartDeliveryDate: string (date-time)
  Title: Initial Delivery Date

  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
        },
        "ContentLastModified":{
            "type":"string",
            "description":"Date when the campaign content was last modified.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDeliveryDate":{
            "title":"End Date",
            "type":"string",
            "description":"Channel end date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SMSText":{
            "title":"SMS Text",
            "maxLength":255,
            "type":"string",
            "description":"SMS text.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledDate":{
            "title":"Delivery Date",
            "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 notificationMetrics resource provides details on how to retrieve the metrics associated with one or more 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 postContent resource provides details on  how to create and update 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":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Channel name.",
            "nullable":false,
            "x-queryable":true
        },
        "assetMetrics":{
            "title":"Campaign Channel Metrics",
            "type":"array",
            "description":"The assetMetrics resource provides details on how to retrieve 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
        },
        "audienceSegments":{
            "title":"Campaign Audience Segments",
            "type":"array",
            "description":"The audienceSegments resource provides details on how to retrieve the segments associated with one or more channels defined within a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-audienceSegments-item-response"
            }
        },
        "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":{
            "title":"Initial Delivery Date",
            "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 assetMetrics resource provides details on how to retrieve 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 assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-assetMetrics-item-response"
    }
}

Nested Schema : Campaign Audience Segments

Type: array

Title: Campaign Audience Segments

The audienceSegments resource provides details on how to retrieve the segments associated with one or more channels defined within a campaign.

Show Source

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

{
    "title":"Campaign Audience Segments",
    "type":"array",
    "description":"The audienceSegments resource provides details on how to retrieve the segments associated with one or more channels defined within a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-assetDetails-audienceSegments-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 notificationMetrics resource provides details on how to retrieve the metrics associated with one or more notification email cycles.

Show Source

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

{
    "title":"Grow Notification Metrics",
    "type":"array",
    "description":"The notificationMetrics resource provides details on how to retrieve the metrics associated with one or more 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 postContent resource provides details on how to create and update 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 postContent resource provides details on  how to create and update 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-audienceSegments-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Internal identifier of the audience segment.
• AssetSegmentId: integer (int64)
  Segment identifier for the audience segment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who created the audience segment.
• CreationDate: string (date-time)
  Read Only: true

  Date when the audience segment was created.
• CriteriaTypeCode: string
  Maximum Length: 30

  Criteria type code of the audience segment.
• GoalResponseId: integer (int64)
  Goal response identifier for the audience segments associated with the goal.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the audience segment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the audience segment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last session login associated to the user who last updated the audience segment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number of the audience segment that the user retrieved.
• SegmentTypeCode: string
  Maximum Length: 30

  Segment type code of the audience segment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the audience segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the audience segment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Criteria type code of the audience segment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who created the audience segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the audience segment that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SegmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Segment type code of the audience segment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetSegmentId":{
            "type":"integer",
            "description":"Segment identifier for the audience segment.",
            "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"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier of the audience segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"Goal response identifier for the audience segments associated with the goal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the audience segment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last session login associated to the user who last updated the audience segment.",
            "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-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.
• PrimaryDeepLinkId: integer
  Unique identifier for the predefined link defined on the primary action button.
• 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.
• SecondaryDeepLinkId: integer
  Unique identifier for the predefined link defined on the secondary action button.
• 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
        },
        "SecondaryDeepLinkId":{
            "type":"integer",
            "description":"Unique identifier for the predefined link defined on the secondary action button.",
            "nullable":true,
            "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
        },
        "PrimaryDeepLinkId":{
            "type":"integer",
            "description":"Unique identifier for the predefined link defined on the primary action button.",
            "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-assetMetrics-item-response

Type: object

Show Source

• AssetId: integer
  Read Only: true

  Internal identifier for the asset metrics.
• AssetName: string
  Read Only: true

  Maximum Length: 240

  Name of the selected asset.
• AssetStatusCode: string
  Read Only: true

  Maximum Length: 30

  Status code of the asset.
• AssetTypeCode: string
  Read Only: true

  Maximum Length: 30

  Type code of the asset.
• CampaignId: integer (int64)
  Read Only: true

  Campaign identifier for the asset metrics associated with the campaign.
• ClickCount: number
  Read Only: true

  Count of unique clicks registered on the campaign email so far.
• DeliveredCount: number
  Read Only: true

  Count of all the campaign emails delivered so far.
• LastDeliveryDate: string (date-time)
  Read Only: true

  Date when the last campaign email was delivered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoMobileNumberCount: number
  Read Only: true

  Count of all SMS sent on the campaign so far.
• OpenCount: number
  Read Only: true

  Open count on the campaign so far.
• ParentAssetId: integer (int64)
  Read Only: true

  Parent asset identifier.
• ScheduledDate: string (date-time)
  Read Only: true

  Date when the asset is scheduled.
• SentCount: number
  Read Only: true

  Count of all the campaign emails sent so far.
• StartDeliveryDate: string (date-time)
  Read Only: true

  Date when the campaign email was first delivered.
• TotalCount: number
  Read Only: true

  Total audience count associated with the campaign.
• UndeliveredCount: number
  Read Only: true

  Count of all the campaign emails undelivered so far.
• UnsentCount: number
  Read Only: true

  Count of all the campaign emails unsent so far.

{
    "type":"object",
    "properties":{
        "LastDeliveryDate":{
            "type":"string",
            "description":"Date when the last campaign email was delivered.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnsentCount":{
            "type":"number",
            "description":"Count of all the campaign emails unsent so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledDate":{
            "type":"string",
            "description":"Date when the asset is scheduled.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UndeliveredCount":{
            "type":"number",
            "description":"Count of all the campaign emails undelivered so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the selected asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoMobileNumberCount":{
            "type":"number",
            "description":"Count of all SMS sent on the campaign so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClickCount":{
            "type":"number",
            "description":"Count of unique clicks registered on the campaign email so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCount":{
            "type":"number",
            "description":"Total audience count associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveredCount":{
            "type":"number",
            "description":"Count of all the campaign emails delivered so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Campaign identifier for the asset metrics associated with the campaign.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OpenCount":{
            "type":"number",
            "description":"Open count on the campaign so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAssetId":{
            "type":"integer",
            "description":"Parent asset identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":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"
            }
        },
        "AssetTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for the asset metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SentCount":{
            "type":"number",
            "description":"Count of all the campaign emails sent so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDeliveryDate":{
            "type":"string",
            "description":"Date when the campaign email was first delivered.",
            "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-audienceDetails-item-response

Type: object

Show Source

• AudienceCount: integer
  Read Only: true

  Total number of employees who will see the post.
• AudienceExtractionDate: string (date-time)
  Read Only: true

  Date when the audience was extracted.
• AudienceId: integer (int64)
  Internal identifier for the association between a campaign and its corresponding audience.
• AudienceSourceId: integer (int64)
  Title: Audience

  Internal identifier for the selected audience list.
• AudienceSourceName: string
  Read Only: true

  Maximum Length: 255

  Name of the selected audience list.
• AudienceSourceType: string
  Title: Audience Type

  Maximum Length: 64

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

  The CampaignAudienceSourceItems 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.
• metrics: array Campaign Audience Details Metrics
  Title: Campaign Audience Details Metrics

  The metrics resource retrieves the metrics associated with the audience for a campaign.
• 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,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceSourceType":{
            "title":"Audience Type",
            "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.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "metrics":{
            "title":"Campaign Audience Details Metrics",
            "type":"array",
            "description":"The metrics resource retrieves the metrics associated with the audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-metrics-item-response"
            }
        },
        "CampaignAudienceSourceItems":{
            "title":"Campaign Target Audience Details",
            "type":"array",
            "description":"The CampaignAudienceSourceItems resource provides the target audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response"
            }
        },
        "AudienceSourceId":{
            "title":"Audience",
            "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 CampaignAudienceSourceItems 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 CampaignAudienceSourceItems 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 : Campaign Audience Details Metrics

Type: array

Title: Campaign Audience Details Metrics

The metrics resource retrieves the metrics associated with the audience for a campaign.

Show Source

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

{
    "title":"Campaign Audience Details Metrics",
    "type":"array",
    "description":"The metrics resource retrieves the metrics associated with the audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-metrics-item-response"
    }
}

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-audienceDetails-metrics-item-response

Type: object

Show Source

• AudienceCount: integer
  Audience count associated with the campaign.
• AudienceId: integer (int64)
  Audience identifier.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the metrics.
• CreationDate: string (date-time)
  Read Only: true

  Date when the metrics were added to the campaign.
• EntityId: integer (int64)
  Entity identifier for the audience criteria.
• EntityName: string
  Maximum Length: 2000

  Name of the selected entity.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the audience metrics were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the audience metrics.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the audience metrics.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricId: integer (int64)
  Internal identifier for a metric.
• MetricType: string
  Maximum Length: 30

  Types of metrics.
• ObjectVersionNumber: integer (int32)
  Version number associated with the audience metrics that the user retrieved.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the audience metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the metrics were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the selected entity.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricType":{
            "maxLength":30,
            "type":"string",
            "description":"Types of metrics.",
            "nullable":false,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Entity identifier for the audience criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricId":{
            "type":"integer",
            "description":"Internal identifier for a metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the audience metrics that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Audience count associated with the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "AudienceId":{
            "type":"integer",
            "description":"Audience identifier.",
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the audience metrics were 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 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 : communicateUICampaignDetails-boAssociation-item-response

Type: object

Show Source

• BoAssignedAfterDate: string (date-time)
  Title: Journey Assigned After

  Business object assignment date.
• boAssocItems: array Campaign Business Object Association Items
  Title: Campaign Business Object Association Items

  The boAssocItems resource retrieves the items associated with the business object association for a campaign.
• BoGoal: string
  Maximum Length: 30

  Name of the business object goal
• BoType: string
  Maximum Length: 30

  Type of business object association.
• CampaignId: integer (int64)
  Internal identifier for the campaign associated with the business object association.
• CampBoId: integer (int64)
  Internal identifier for the business object association.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the business object association.
• CreationDate: string (date-time)
  Read Only: true

  Date when the business object association was added to the campaign.
• ExcludeBoAudFlag: boolean
  Maximum Length: 1

  Exclude business object association audience indicator for the campaign.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the business object association was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the business object association.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the business object association.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the business object association that the user retrieved.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the business object association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the business object association 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 business object association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BoType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of business object association.",
            "nullable":false,
            "x-queryable":true
        },
        "ExcludeBoAudFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Exclude business object association audience indicator for the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "boAssocItems":{
            "title":"Campaign Business Object Association Items",
            "type":"array",
            "description":"The boAssocItems resource retrieves the items associated with the business object association for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-boAssociation-boAssocItems-item-response"
            }
        },
        "BoAssignedAfterDate":{
            "title":"Journey Assigned After",
            "type":"string",
            "description":"Business object assignment date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Internal identifier for the campaign associated with the business object association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the business object association that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CampBoId":{
            "type":"integer",
            "description":"Internal identifier for the business object association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BoGoal":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the business object goal",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the business object association 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 business object association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Business Object Association Items

Type: array

Title: Campaign Business Object Association Items

The boAssocItems resource retrieves the items associated with the business object association for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-boAssociation-boAssocItems-item-response

{
    "title":"Campaign Business Object Association Items",
    "type":"array",
    "description":"The boAssocItems resource retrieves the items associated with the business object association for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-boAssociation-boAssocItems-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-boAssociation-boAssocItems-item-response

Type: object

Show Source

• BoId: integer (int64)
  Internal identifier for the business object.
• campaignBoMetrics: array Campaign Business Object Association Metrics
  Title: Campaign Business Object Association Metrics

  The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.
• CampBoId: integer (int64)
  Internal identifier for the business object association.
• CampBoItemId: integer (int64)
  Internal identifier for the business object association items.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the business object association items.
• CreationDate: string (date-time)
  Read Only: true

  Date when the business object association items were added to the campaign.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the business object association items were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the business object association items.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the business object association items.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the business object association items that the user retrieved.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the business object association items.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the business object association items were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "campaignBoMetrics":{
            "title":"Campaign Business Object Association Metrics",
            "type":"array",
            "description":"The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the business object association items.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the business object association items that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BoId":{
            "type":"integer",
            "description":"Internal identifier for the business object.",
            "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"
            }
        },
        "CampBoId":{
            "type":"integer",
            "description":"Internal identifier for the business object association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampBoItemId":{
            "type":"integer",
            "description":"Internal identifier for the business object association items.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the business object association items were 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 business object association items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Business Object Association Metrics

Type: array

Title: Campaign Business Object Association Metrics

The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-item-response

{
    "title":"Campaign Business Object Association Metrics",
    "type":"array",
    "description":"The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-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-boAssociation-boAssocItems-campaignBoMetrics-item-response

Type: object

Show Source

• CampBoItemId: integer (int64)
  Internal identifier for the campaign business object metrics associated with the business object association items.
• Count: integer (int32)
  Total audience count associated with the campaign business object metrics.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the business object metrics.
• CreationDate: string (date-time)
  Read Only: true

  Date when the business object metrics items were added to the campaign.
• DisplayContext: string
  Maximum Length: 30

  Context for the business object association.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the business object metrics were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the business object metrics.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the business object metrics.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricId: integer (int64)
  Internal identifier for the campaign business object metrics.
• ObjectVersionNumber: integer (int32)
  Version number associated with the business object metrics that the user retrieved.
• Status: string
  Maximum Length: 30

  Status of the business object association.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the business object metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the business object association.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the business object metrics items were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricId":{
            "type":"integer",
            "description":"Internal identifier for the campaign business object metrics.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the business object metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the business object metrics that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DisplayContext":{
            "maxLength":30,
            "type":"string",
            "description":"Context for the business object association.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Count":{
            "type":"integer",
            "description":"Total audience count associated with the campaign business object metrics.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CampBoItemId":{
            "type":"integer",
            "description":"Internal identifier for the campaign business object metrics associated with the business object association items.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the business object metrics were 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 business object 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 : communicateUICampaignDetails-goals-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Campaign identifier for the goals associated with the campaign.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who created the goals.
• CreationDate: string (date-time)
  Read Only: true

  Date when the goals were added to the campaign.
• GoalId: integer (int64)
  Internal identifier for the goals.
• GoalName: string
  Title: Question

  Maximum Length: 240

  Name of the goals.
• GoalTypeCode: string
  Maximum Length: 30

  Types of the goals.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the goals were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the goals.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the goals.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the goals that the user retrieved.
• PrimaryGoalFlag: boolean
  Maximum Length: 1

  Indicates whether the primary goal is enabled or not
• responseChoices: array Campaign Goal Response Choices
  Title: Campaign Goal Response Choices

  The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.
• responseMetrics: array Campaign Goal Response Metrics
  Title: Campaign Goal Response Metrics

  The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.
• SystemGoalFlag: boolean
  Maximum Length: 1

  Indicates whether the system goal is enabled or not

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the goals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the goals were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who created the goals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryGoalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the primary goal is enabled or not",
            "nullable":true,
            "x-queryable":true
        },
        "responseMetrics":{
            "title":"Campaign Goal Response Metrics",
            "type":"array",
            "description":"The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseMetrics-item-response"
            }
        },
        "SystemGoalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the system goal is enabled or not",
            "nullable":true,
            "x-queryable":true
        },
        "responseChoices":{
            "title":"Campaign Goal Response Choices",
            "type":"array",
            "description":"The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseChoices-item-response"
            }
        },
        "CampaignId":{
            "type":"integer",
            "description":"Campaign identifier for the goals associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the goals that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "GoalTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Types of the goals.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalName":{
            "title":"Question",
            "maxLength":240,
            "type":"string",
            "description":"Name of the goals.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the goals were 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 goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the goals.",
            "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 : Campaign Goal Response Choices

Type: array

Title: Campaign Goal Response Choices

The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.

Show Source

• Array of: object communicateUICampaignDetails-goals-responseChoices-item-response

{
    "title":"Campaign Goal Response Choices",
    "type":"array",
    "description":"The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseChoices-item-response"
    }
}

Nested Schema : Campaign Goal Response Metrics

Type: array

Title: Campaign Goal Response Metrics

The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.

Show Source

• Array of: object communicateUICampaignDetails-goals-responseMetrics-item-response

{
    "title":"Campaign Goal Response Metrics",
    "type":"array",
    "description":"The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseMetrics-item-response"
    }
}

Nested Schema : communicateUICampaignDetails-goals-responseChoices-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the response choices of the goals.
• CreationDate: string (date-time)
  Read Only: true

  Date when the response choices of the goals were added to the campaign.
• DestinationURL: string
  Title: Response Destination Page URL

  Maximum Length: 1000

  Response choices destination URL.
• GoalId: integer (int64)
  Internal identifier for the response choices associated with goals.
• GoalResponseId: integer (int64)
  Internal identifier for the response choices.
• IncludeInTargetFlag: boolean
  Title: Counts Toward Goal

  Maximum Length: 1

  Default Value: false

  Indicates whether the include in target is enabled or not.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the response choices were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the response choices.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the response choices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the response choices that the user retrieved.
• ResponseLabel: string
  Title: Response

  Maximum Length: 240

  Response choices label.
• UseDefaultURLFlag: boolean
  Title: Response Destination Page

  Maximum Length: 1

  Default Value: false

  Default URL flag for response choices.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the response choices.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the response choices of the goals were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the response choices of the goals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseLabel":{
            "title":"Response",
            "maxLength":240,
            "type":"string",
            "description":"Response choices label.",
            "nullable":false,
            "x-queryable":true
        },
        "DestinationURL":{
            "title":"Response Destination Page URL",
            "maxLength":1000,
            "type":"string",
            "description":"Response choices destination URL.",
            "nullable":true,
            "x-queryable":true
        },
        "UseDefaultURLFlag":{
            "title":"Response Destination Page",
            "maxLength":1,
            "type":"boolean",
            "description":"Default URL flag for response choices.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the response choices that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"Internal identifier for the response choices.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeInTargetFlag":{
            "title":"Counts Toward Goal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the include in target is enabled or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the response choices were 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 response choices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the response choices associated with goals.",
            "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-goals-responseMetrics-item-response

Type: object

Show Source

• GoalId: integer
  Read Only: true

  Internal identifier for the response metrics associated with goals.
• GoalResponseId: integer (int64)
  Read Only: true

  Internal identifier for the response metrics associated with response choices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseCount: number
  Read Only: true

  Response count for the response choices
• ResponseLabel: string
  Read Only: true

  Maximum Length: 240

  Label for the response choices.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"Internal identifier for the response metrics associated with response choices.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseCount":{
            "type":"number",
            "description":"Response count for the response choices",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the response metrics associated with goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseLabel":{
            "maxLength":240,
            "type":"string",
            "description":"Label for the response choices.",
            "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-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"
    }
}

Nested Schema : communicateUICampaignDetails-selectedLanguages-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Internal identifier for the campaign.
• CampLanguageId: integer (int64)
  Internal identifier for a selected language associated with a specific campaign.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the selected language.
• CreationDate: string (date-time)
  Read Only: true

  Date the selected language was added to the campaign.
• IsBaseFlag: boolean
  Maximum Length: 1

  Indicates whether the selected language is the base language for the campaign.
• LanguageCode: string
  Maximum Length: 4

  Language code of the selected language.
• LanguageDescription: string
  Read Only: true

  Maximum Length: 255

  Language name of the selected language.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the selected language was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the selected language.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the selected language.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the selected language that the user retrieved.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the selected language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsBaseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the selected language is the base language for the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the selected language was added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageCode":{
            "maxLength":4,
            "type":"string",
            "description":"Language code of the selected language.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the selected language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Language name of the selected language.",
            "nullable":true,
            "readOnly":true,
            "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 selected language that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CampLanguageId":{
            "type":"integer",
            "description":"Internal identifier for a selected language associated with a specific campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the selected language 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 selected language.",
            "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.

canUserManageAllHCMCampaigns

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

Checks if the logged in user is a superuser and can manage all Communicate campaigns.

Back to Top