Jump to

• Request
• Response

Get all quick campaigns

get

/hcmRestApi/resources/11.13.18.05/communicateUIQuickCampaigns

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 quick campaigns based on the primary key.
    Finder Variables
    • CampaignId; integer; Unique identifier for the campaign.
  • findByEntityIdAndType Finds quick campaigns based on entity ID and type.
    Finder Variables
    • pEntityId; integer; Entity ID used to filter quick campaigns.
    • pEntityType; string; Entity type to filter the quick campaigns.
  • findByEntityType Finds quick campaigns based on the specified entity type.
    Finder Variables
    • pEntityType; string; Entity type used to filter quick campaigns.
  • findByPurposeCode Finds quick campaigns based on the specified purpose code.
    Finder Variables
    • pPurposeCode; string; Purpose code used to filter quick campaigns.
  • findQuickCampaignType Finds quick campaign types that match the specified criteria.
    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:
  

  • AudienceCount; integer; Number of individuals in the audience for the quick campaign.
  • CampaignCode; string; Unique identifier for the quick campaign.
  • CampaignDurationCode; string; Duration code for the quick campaign. It specifies the time frame for the campaign.
  • CampaignId; integer; Unique identifier for the quick campaign.
  • CampaignName; string; Name of the quick campaign used for communication purposes.
  • CampaignOwnersName; string; Name of the campaign owner associated with the quick campaign.
  • CampaignStatusCode; string; Indicates the status of the campaign. Valid values are Draft, Active, and Completed. Default is Draft.
  • CampaignTypeCode; string; Indicates the type of campaign for quick communication. This value determines the purpose or category of the campaign.
  • CreatedBy; string; Identifies the user who created the quick campaign.
  • CreationDate; string; Creation date of the quick campaign. This date indicates when the campaign was initially created in the application.
  • PurposeCode; string; Purpose code for the quick campaign. This code defines the objective or intent of the 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: string
  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: string
  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 : communicateUIQuickCampaigns

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/communicateUIQuickCampaigns-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object communicateUIQuickCampaigns-item-response

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

Type: object

Show Source

• assetDetails: array Campaign Channel Details
  Title: Campaign Channel Details

  The assetDetails resource provides details on how to create and update channels on the campaign.
• AudienceCount: integer (int64)
  Number of individuals in the audience for the quick 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.
• boAssociation: array Campaign Business Object Association
  Title: Campaign Business Object Association

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

  Maximum Length: 30

  Unique identifier for the quick campaign.
• CampaignDescription: string (byte)
  Title: Campaign Description

  Brief summary of the quick campaign. This description outlines the purpose and key details of the campaign.
• CampaignDurationCode: string
  Maximum Length: 30

  Duration code for the quick campaign. It specifies the time frame for the campaign.
• CampaignId: integer (int64)
  Unique identifier for the quick campaign.
• CampaignName: string
  Title: Campaign Name

  Maximum Length: 240

  Name of the quick campaign used for communication purposes.
• CampaignOwnersName: string
  Read Only: true

  Maximum Length: 255

  Name of the campaign owner associated with the quick campaign.
• CampaignStatusCode: string
  Title: Status

  Maximum Length: 30

  Indicates the status of the campaign. Valid values are Draft, Active, and Completed. Default is Draft.
• CampaignTypeCode: string
  Maximum Length: 30

  Indicates the type of campaign for quick communication. This value determines the purpose or category of the campaign.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the quick campaign.
• CreationDate: string (date-time)
  Read Only: true

  Creation date of the quick campaign. This date indicates when the campaign was initially created in the application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PurposeCode: string
  Title: Campaign Purpose

  Maximum Length: 30

  Purpose code for the quick campaign. This code defines the objective or intent of the campaign.

{
    "type":"object",
    "properties":{
        "AudienceCount":{
            "type":"integer",
            "description":"Number of individuals in the audience for the quick campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignCode":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the quick campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignDescription":{
            "title":"Campaign Description",
            "type":"string",
            "description":"Brief summary of the quick campaign. This description outlines the purpose and key details of the campaign.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignDurationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Duration code for the quick campaign. It specifies the time frame for the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Unique identifier for the quick campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the quick campaign used for communication purposes.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignOwnersName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the campaign owner associated with the quick campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the campaign. Valid values are Draft, Active, and Completed. Default is Draft.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of campaign for quick communication. This value determines the purpose or category of the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the quick campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the quick campaign. This date indicates when the campaign was initially created in the application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Campaign Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Purpose code for the quick campaign. This code defines the objective or intent of the campaign.",
            "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/communicateUIQuickCampaigns-assetDetails-item-response"
            }
        },
        "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/communicateUIQuickCampaigns-audienceDetails-item-response"
            }
        },
        "boAssociation":{
            "title":"Campaign Business Object Association",
            "type":"array",
            "description":"The boAssociation resource creates and updates a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUIQuickCampaigns-boAssociation-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 communicateUIQuickCampaigns-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/communicateUIQuickCampaigns-assetDetails-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 communicateUIQuickCampaigns-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/communicateUIQuickCampaigns-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 communicateUIQuickCampaigns-boAssociation-item-response

{
    "title":"Campaign Business Object Association",
    "type":"array",
    "description":"The boAssociation resource creates and updates a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUIQuickCampaigns-boAssociation-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 : communicateUIQuickCampaigns-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.
• 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.
• 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.
• CreatedByDisplayName: string
  Read Only: true

  Maximum Length: 255

  Display name of the user who created the campaign asset.
• CreationDate: string (date-time)
  Read Only: true

  Date the channel was created.
• DesignMetadata: string (byte)
  Read Only: true

  Design metadata for the campaign asset. This attribute contains detailed design information for the asset used in the campaign.
• FollowupDelay: integer (int32)
  Time between two specific communications.
• Frequency: string
  Maximum Length: 255

  Frequency with which the grow notification email is sent out.
• LastDeliveryDate: string (date-time)
  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.
• MSTeamsText: string (byte)
  Title: Message

  Text content for Microsoft Teams associated with the campaign asset.
• 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.
• 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.
• SendImmediatelyFlag: boolean
  Maximum Length: 1

  Indicates whether to send the campaign asset immediately. Valid values are Y and N. Default is N.
• 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":{
        "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
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for the channel associated with a campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Channel name.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup code of the channel status.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Channel status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssetStatusCode"
                ]
            },
            "x-queryable":true
        },
        "AssetTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Channel type.",
            "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
        },
        "ContentLastModified":{
            "type":"string",
            "description":"Date when the campaign content was last modified.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who created the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the user who created the campaign asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DesignMetadata":{
            "type":"string",
            "description":"Design metadata for the campaign asset. This attribute contains detailed design information for the asset used in the campaign.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FollowupDelay":{
            "type":"integer",
            "description":"Time between two specific communications.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "Frequency":{
            "maxLength":255,
            "type":"string",
            "description":"Frequency with which the grow notification email is sent out.",
            "nullable":true,
            "x-queryable":true
        },
        "LastDeliveryDate":{
            "title":"End Date",
            "type":"string",
            "description":"Channel end date.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MSTeamsText":{
            "title":"Message",
            "type":"string",
            "description":"Text content for Microsoft Teams associated with the campaign asset.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"Internal identifier for the email design page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "PublishDestMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Destination where the application publishes the post.",
            "nullable":true,
            "readOnly":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
        },
        "SendImmediatelyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to send the campaign asset immediately. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "StartDeliveryDate":{
            "title":"Initial Delivery Date",
            "type":"string",
            "description":"Channel start date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : communicateUIQuickCampaigns-audienceDetails-item-response

Type: object

Show Source

• AddedAudienceCount: integer
  Read Only: true

  Number of audience members added to the campaign.
• AudienceCount: integer
  Read Only: true

  Total number of employees who will see the post.
• AudienceCriteria: string (byte)
  Audience criteria for defining the target audience in a campaign. This attribute specifies the conditions or rules used to filter and select the audience.
• AudienceExtractionDate: string (date-time)
  Read Only: true

  Date when the audience was extracted.
• AudienceExtractionStatus: string
  Maximum Length: 30

  Indicates the status of audience extraction for the campaign. Valid values are In Progress, Completed, and Failed. Default is In Progress.
• 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.
• CampaignId: integer (int64)
  Internal identifier for the campaign.
• ColumnMapping: string (byte)
  Mapping of columns for the campaign audience details. This attribute defines how data fields are aligned for processing.
• 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.
• CustomTokens: string (byte)
  Custom tokens used in the campaign audience details. These tokens personalize the communication content.
• Description: string
  Maximum Length: 4000

  Description of the campaign audience details. This field provides additional context or information about the audience targeted in the campaign.
• ExcludedAudienceCount: integer
  Read Only: true

  Number of audience members excluded from the campaign.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

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

  Default Value: true

  Indicates whether to refresh the audience details. Valid values are true and false. Default is false.
• Status: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  Indicates the current status of the audience details in the campaign. This field reflects whether the audience is active, inactive, or another status defined by the application.

{
    "type":"object",
    "properties":{
        "AddedAudienceCount":{
            "type":"integer",
            "description":"Number of audience members added to the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Total number of employees who will see the post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceCriteria":{
            "type":"string",
            "description":"Audience criteria for defining the target audience in a campaign. This attribute specifies the conditions or rules used to filter and select the audience.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AudienceExtractionDate":{
            "type":"string",
            "description":"Date when the audience was extracted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceExtractionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of audience extraction for the campaign. Valid values are In Progress, Completed, and Failed. Default is In Progress.",
            "nullable":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
        },
        "AudienceSourceId":{
            "title":"Audience",
            "type":"integer",
            "description":"Internal identifier for the selected audience list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AudienceSourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the selected audience list.",
            "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
        },
        "ColumnMapping":{
            "type":"string",
            "description":"Mapping of columns for the campaign audience details. This attribute defines how data fields are aligned for processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added 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
        },
        "CustomTokens":{
            "type":"string",
            "description":"Custom tokens used in the campaign audience details. These tokens personalize the communication content.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the campaign audience details. This field provides additional context or information about the audience targeted in the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "ExcludedAudienceCount":{
            "type":"integer",
            "description":"Number of audience members excluded from the campaign.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the audience.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "RefreshFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to refresh the audience details. Valid values are true and false. Default is false.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the audience details in the campaign. This field reflects whether the audience is active, inactive, or another status defined by the application.",
            "nullable":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : communicateUIQuickCampaigns-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":{
        "BoAssignedAfterDate":{
            "title":"Journey Assigned After",
            "type":"string",
            "description":"Business object assignment date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BoGoal":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the business object goal",
            "nullable":false,
            "x-queryable":true
        },
        "BoType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of business object association.",
            "nullable":false,
            "x-queryable":true
        },
        "CampBoId":{
            "type":"integer",
            "description":"Internal identifier for the business object association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added 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
        },
        "ExcludeBoAudFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Exclude business object association audience indicator for the campaign.",
            "nullable":true,
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the business object association.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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/communicateUIQuickCampaigns-boAssociation-boAssocItems-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 communicateUIQuickCampaigns-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/communicateUIQuickCampaigns-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 : communicateUIQuickCampaigns-boAssociation-boAssocItems-item-response

Type: object

Show Source

• BoId: integer (int64)
  Internal identifier for the business object.
• 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":{
        "BoId":{
            "type":"integer",
            "description":"Internal identifier for the business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added 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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

promoteEntity

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIQuickCampaigns/action/promoteEntity

Promotes a quick campaign entity to enhance visibility or priority within the communication UI. The campaign must be in a valid state for promotion.

quickAction

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIQuickCampaigns/action/quickAction

Creates a quick campaign to facilitate rapid communication with targeted audiences.

Back to Top