Root Schema : createComponentLayout_response
Type: object
Show Source
{
"properties":{
"regions":{
"description":"The regions of the new layout.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deviceType":{
"description":"The device type.",
"type":"string"
},
"metadata":{
"description":"The metadata for the region.",
"type":"string"
},
"components":{
"description":"Components in the region.",
"type":"array",
"items":{
"type":"object",
"properties":{
"isLatestVersion":{
"description":"Is this the latest version of the component.",
"type":"boolean"
},
"updatesAvailable":{
"description":"Are there any updates available for this component.",
"type":"boolean"
},
"slotType":{
"description":"If component type of slot, the type of slot.",
"type":"string"
},
"instances":{
"description":"The instances of the component.",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the component.",
"type":"string"
},
"widgetFamily":{
"description":"If component type of widget, the family the widget belongs to.",
"type":"string"
},
"global":{
"description":"Is the component global.",
"type":"boolean"
},
"source":{
"description":"Is this component out of the box (100) or uploaded (101).",
"type":"integer"
},
"type":{
"description":"The type of component.",
"type":"string"
},
"version":{
"description":"The current version of the component.",
"type":"integer"
},
"widgetType":{
"description":"If component type of widget, the type of widget.",
"type":"string"
},
"latestVersion":{
"description":"The latest version of the component.",
"type":"integer"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"hiddenFromSiteStudio":{
"description":"Is this component hidden from the site.",
"type":"boolean"
},
"stackType":{
"description":"If component type of stack, the type of stack.",
"type":"string"
}
}
}
},
"endDate":{
"description":"End date of the region (slot-variant-specific).",
"type":"string"
},
"displayName":{
"description":"The display name of the region",
"type":"string"
},
"roles":{
"description":"The roles of the region.",
"type":"array",
"items":{
"type":"string"
}
},
"type":{
"description":"Type of region.",
"type":"integer"
},
"widgets":{
"description":"Widgets",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the widget instance",
"type":"string"
},
"repositoryId":{
"description":"the repository id of the widget instance",
"type":"string"
},
"descriptor":{
"description":"Descriptor",
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the widget type",
"type":"string"
},
"minWidth":{
"description":"The minimum width of the widget type",
"type":"number"
},
"editableWidget":{
"description":"Whether or not this widget type can be edited",
"type":"boolean"
}
}
}
}
}
},
"structure":{
"description":"The structure of the region",
"type":"integer"
},
"cssClass":{
"description":"the custom CSS class for the region",
"type":"string"
},
"repositoryId":{
"description":"The repository ID of the region",
"type":"string"
},
"name":{
"description":"The name of the region",
"type":"string"
},
"width":{
"description":"The width of the region",
"type":"integer"
},
"audiences":{
"description":"Region audiences (slot-variant-specific).",
"type":"array",
"items":{
"type":"object",
"properties":{
"useInReports":{
"description":"Indicates if this audience will be used in reporting.",
"type":"boolean"
},
"deleted":{
"description":"Indicates if this audience is deleted.",
"type":"boolean"
},
"visitorType":{
"description":"Indicates the type of visitors the audience allows. visitorType must be one of the following: \"ANONYMOUS\" (users not authenticated or soft logged in), \"RECOGNIZED\" (users that were logged in before but, have not been authenticated in the current session), \"AUTHENTICATED\" (logged in users), \"ANONYMOUS_OR_RECOGNIZED\", \"ANONYMOUS_OR_AUTHENTICATED\", \"REGISTERED\", or \"ALL\". These correspond to various combinations of the options that appear in the UI (ANONYMOUS, RECOGNIZED, and AUTHENTICATED) where \"REGISTERED\" means the user selected RECOGNIZED and AUTHENTICATED and \"ALL\" means the user selected all three options.",
"type":"string"
},
"displayName":{
"description":"The display name for the Audience.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the Audience.",
"type":"string"
},
"ruleSet":{
"description":"The rule set for the Audience.",
"type":"object",
"properties":{
"rules":{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
},
"operator":{
"description":"The operator applied to all of the rules in the rule set.",
"type":"string"
}
}
},
"description":{
"description":"The Audience description.",
"type":"string"
},
"stateLastModified":{
"description":"The time the Audience state (i.e. created, deleted, or enabled) was last modified.",
"type":"integer"
},
"id":{
"description":"The id of the new Audience.",
"type":"string"
},
"enabled":{
"description":"Indicates if this audience is enabled.",
"type":"boolean"
}
}
}
},
"startDate":{
"description":"Start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region",
"type":"integer"
},
"height":{
"description":"The height of the region",
"type":"string"
}
}
}
},
"displayName":{
"description":"The display name of the layout",
"type":"string"
},
"repositoryId":{
"description":"The repository ID of the layout",
"type":"string"
},
"name":{
"description":"The name of the region",
"type":"string"
}
},
"example":{
"regions":[
{
"deviceType":null,
"metadata":null,
"components":[
],
"endDate":null,
"displayName":null,
"roles":[
],
"type":101,
"widgets":[
],
"structure":100,
"cssClass":null,
"repositoryId":"re1200004",
"name":null,
"width":12,
"audiences":[
],
"startDate":null,
"mobileWidth":0,
"height":null
}
],
"displayName":"Test Container",
"repositoryId":"pl1100004",
"name":null,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/layouts/component/700005"
}
]
}
}
Example:
{
"regions":[
{
"deviceType":null,
"metadata":null,
"components":[
],
"endDate":null,
"displayName":null,
"roles":[
],
"type":101,
"widgets":[
],
"structure":100,
"cssClass":null,
"repositoryId":"re1200004",
"name":null,
"width":12,
"audiences":[
],
"startDate":null,
"mobileWidth":0,
"height":null
}
],
"displayName":"Test Container",
"repositoryId":"pl1100004",
"name":null,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/layouts/component/700005"
}
]
}
Nested Schema : regions
Type: array
The regions of the new layout.
Show Source
{
"description":"The regions of the new layout.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deviceType":{
"description":"The device type.",
"type":"string"
},
"metadata":{
"description":"The metadata for the region.",
"type":"string"
},
"components":{
"description":"Components in the region.",
"type":"array",
"items":{
"type":"object",
"properties":{
"isLatestVersion":{
"description":"Is this the latest version of the component.",
"type":"boolean"
},
"updatesAvailable":{
"description":"Are there any updates available for this component.",
"type":"boolean"
},
"slotType":{
"description":"If component type of slot, the type of slot.",
"type":"string"
},
"instances":{
"description":"The instances of the component.",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the component.",
"type":"string"
},
"widgetFamily":{
"description":"If component type of widget, the family the widget belongs to.",
"type":"string"
},
"global":{
"description":"Is the component global.",
"type":"boolean"
},
"source":{
"description":"Is this component out of the box (100) or uploaded (101).",
"type":"integer"
},
"type":{
"description":"The type of component.",
"type":"string"
},
"version":{
"description":"The current version of the component.",
"type":"integer"
},
"widgetType":{
"description":"If component type of widget, the type of widget.",
"type":"string"
},
"latestVersion":{
"description":"The latest version of the component.",
"type":"integer"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"hiddenFromSiteStudio":{
"description":"Is this component hidden from the site.",
"type":"boolean"
},
"stackType":{
"description":"If component type of stack, the type of stack.",
"type":"string"
}
}
}
},
"endDate":{
"description":"End date of the region (slot-variant-specific).",
"type":"string"
},
"displayName":{
"description":"The display name of the region",
"type":"string"
},
"roles":{
"description":"The roles of the region.",
"type":"array",
"items":{
"type":"string"
}
},
"type":{
"description":"Type of region.",
"type":"integer"
},
"widgets":{
"description":"Widgets",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the widget instance",
"type":"string"
},
"repositoryId":{
"description":"the repository id of the widget instance",
"type":"string"
},
"descriptor":{
"description":"Descriptor",
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the widget type",
"type":"string"
},
"minWidth":{
"description":"The minimum width of the widget type",
"type":"number"
},
"editableWidget":{
"description":"Whether or not this widget type can be edited",
"type":"boolean"
}
}
}
}
}
},
"structure":{
"description":"The structure of the region",
"type":"integer"
},
"cssClass":{
"description":"the custom CSS class for the region",
"type":"string"
},
"repositoryId":{
"description":"The repository ID of the region",
"type":"string"
},
"name":{
"description":"The name of the region",
"type":"string"
},
"width":{
"description":"The width of the region",
"type":"integer"
},
"audiences":{
"description":"Region audiences (slot-variant-specific).",
"type":"array",
"items":{
"type":"object",
"properties":{
"useInReports":{
"description":"Indicates if this audience will be used in reporting.",
"type":"boolean"
},
"deleted":{
"description":"Indicates if this audience is deleted.",
"type":"boolean"
},
"visitorType":{
"description":"Indicates the type of visitors the audience allows. visitorType must be one of the following: \"ANONYMOUS\" (users not authenticated or soft logged in), \"RECOGNIZED\" (users that were logged in before but, have not been authenticated in the current session), \"AUTHENTICATED\" (logged in users), \"ANONYMOUS_OR_RECOGNIZED\", \"ANONYMOUS_OR_AUTHENTICATED\", \"REGISTERED\", or \"ALL\". These correspond to various combinations of the options that appear in the UI (ANONYMOUS, RECOGNIZED, and AUTHENTICATED) where \"REGISTERED\" means the user selected RECOGNIZED and AUTHENTICATED and \"ALL\" means the user selected all three options.",
"type":"string"
},
"displayName":{
"description":"The display name for the Audience.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the Audience.",
"type":"string"
},
"ruleSet":{
"description":"The rule set for the Audience.",
"type":"object",
"properties":{
"rules":{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
},
"operator":{
"description":"The operator applied to all of the rules in the rule set.",
"type":"string"
}
}
},
"description":{
"description":"The Audience description.",
"type":"string"
},
"stateLastModified":{
"description":"The time the Audience state (i.e. created, deleted, or enabled) was last modified.",
"type":"integer"
},
"id":{
"description":"The id of the new Audience.",
"type":"string"
},
"enabled":{
"description":"Indicates if this audience is enabled.",
"type":"boolean"
}
}
}
},
"startDate":{
"description":"Start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region",
"type":"integer"
},
"height":{
"description":"The height of the region",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"deviceType":{
"description":"The device type.",
"type":"string"
},
"metadata":{
"description":"The metadata for the region.",
"type":"string"
},
"components":{
"description":"Components in the region.",
"type":"array",
"items":{
"type":"object",
"properties":{
"isLatestVersion":{
"description":"Is this the latest version of the component.",
"type":"boolean"
},
"updatesAvailable":{
"description":"Are there any updates available for this component.",
"type":"boolean"
},
"slotType":{
"description":"If component type of slot, the type of slot.",
"type":"string"
},
"instances":{
"description":"The instances of the component.",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the component.",
"type":"string"
},
"widgetFamily":{
"description":"If component type of widget, the family the widget belongs to.",
"type":"string"
},
"global":{
"description":"Is the component global.",
"type":"boolean"
},
"source":{
"description":"Is this component out of the box (100) or uploaded (101).",
"type":"integer"
},
"type":{
"description":"The type of component.",
"type":"string"
},
"version":{
"description":"The current version of the component.",
"type":"integer"
},
"widgetType":{
"description":"If component type of widget, the type of widget.",
"type":"string"
},
"latestVersion":{
"description":"The latest version of the component.",
"type":"integer"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"hiddenFromSiteStudio":{
"description":"Is this component hidden from the site.",
"type":"boolean"
},
"stackType":{
"description":"If component type of stack, the type of stack.",
"type":"string"
}
}
}
},
"endDate":{
"description":"End date of the region (slot-variant-specific).",
"type":"string"
},
"displayName":{
"description":"The display name of the region",
"type":"string"
},
"roles":{
"description":"The roles of the region.",
"type":"array",
"items":{
"type":"string"
}
},
"type":{
"description":"Type of region.",
"type":"integer"
},
"widgets":{
"description":"Widgets",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the widget instance",
"type":"string"
},
"repositoryId":{
"description":"the repository id of the widget instance",
"type":"string"
},
"descriptor":{
"description":"Descriptor",
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the widget type",
"type":"string"
},
"minWidth":{
"description":"The minimum width of the widget type",
"type":"number"
},
"editableWidget":{
"description":"Whether or not this widget type can be edited",
"type":"boolean"
}
}
}
}
}
},
"structure":{
"description":"The structure of the region",
"type":"integer"
},
"cssClass":{
"description":"the custom CSS class for the region",
"type":"string"
},
"repositoryId":{
"description":"The repository ID of the region",
"type":"string"
},
"name":{
"description":"The name of the region",
"type":"string"
},
"width":{
"description":"The width of the region",
"type":"integer"
},
"audiences":{
"description":"Region audiences (slot-variant-specific).",
"type":"array",
"items":{
"type":"object",
"properties":{
"useInReports":{
"description":"Indicates if this audience will be used in reporting.",
"type":"boolean"
},
"deleted":{
"description":"Indicates if this audience is deleted.",
"type":"boolean"
},
"visitorType":{
"description":"Indicates the type of visitors the audience allows. visitorType must be one of the following: \"ANONYMOUS\" (users not authenticated or soft logged in), \"RECOGNIZED\" (users that were logged in before but, have not been authenticated in the current session), \"AUTHENTICATED\" (logged in users), \"ANONYMOUS_OR_RECOGNIZED\", \"ANONYMOUS_OR_AUTHENTICATED\", \"REGISTERED\", or \"ALL\". These correspond to various combinations of the options that appear in the UI (ANONYMOUS, RECOGNIZED, and AUTHENTICATED) where \"REGISTERED\" means the user selected RECOGNIZED and AUTHENTICATED and \"ALL\" means the user selected all three options.",
"type":"string"
},
"displayName":{
"description":"The display name for the Audience.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the Audience.",
"type":"string"
},
"ruleSet":{
"description":"The rule set for the Audience.",
"type":"object",
"properties":{
"rules":{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
},
"operator":{
"description":"The operator applied to all of the rules in the rule set.",
"type":"string"
}
}
},
"description":{
"description":"The Audience description.",
"type":"string"
},
"stateLastModified":{
"description":"The time the Audience state (i.e. created, deleted, or enabled) was last modified.",
"type":"integer"
},
"id":{
"description":"The id of the new Audience.",
"type":"string"
},
"enabled":{
"description":"Indicates if this audience is enabled.",
"type":"boolean"
}
}
}
},
"startDate":{
"description":"Start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region",
"type":"integer"
},
"height":{
"description":"The height of the region",
"type":"string"
}
}
}
Nested Schema : audiences
Type: array
Region audiences (slot-variant-specific).
Show Source
{
"description":"Region audiences (slot-variant-specific).",
"type":"array",
"items":{
"type":"object",
"properties":{
"useInReports":{
"description":"Indicates if this audience will be used in reporting.",
"type":"boolean"
},
"deleted":{
"description":"Indicates if this audience is deleted.",
"type":"boolean"
},
"visitorType":{
"description":"Indicates the type of visitors the audience allows. visitorType must be one of the following: \"ANONYMOUS\" (users not authenticated or soft logged in), \"RECOGNIZED\" (users that were logged in before but, have not been authenticated in the current session), \"AUTHENTICATED\" (logged in users), \"ANONYMOUS_OR_RECOGNIZED\", \"ANONYMOUS_OR_AUTHENTICATED\", \"REGISTERED\", or \"ALL\". These correspond to various combinations of the options that appear in the UI (ANONYMOUS, RECOGNIZED, and AUTHENTICATED) where \"REGISTERED\" means the user selected RECOGNIZED and AUTHENTICATED and \"ALL\" means the user selected all three options.",
"type":"string"
},
"displayName":{
"description":"The display name for the Audience.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the Audience.",
"type":"string"
},
"ruleSet":{
"description":"The rule set for the Audience.",
"type":"object",
"properties":{
"rules":{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
},
"operator":{
"description":"The operator applied to all of the rules in the rule set.",
"type":"string"
}
}
},
"description":{
"description":"The Audience description.",
"type":"string"
},
"stateLastModified":{
"description":"The time the Audience state (i.e. created, deleted, or enabled) was last modified.",
"type":"integer"
},
"id":{
"description":"The id of the new Audience.",
"type":"string"
},
"enabled":{
"description":"Indicates if this audience is enabled.",
"type":"boolean"
}
}
}
}
Nested Schema : components
Type: array
Components in the region.
Show Source
{
"description":"Components in the region.",
"type":"array",
"items":{
"type":"object",
"properties":{
"isLatestVersion":{
"description":"Is this the latest version of the component.",
"type":"boolean"
},
"updatesAvailable":{
"description":"Are there any updates available for this component.",
"type":"boolean"
},
"slotType":{
"description":"If component type of slot, the type of slot.",
"type":"string"
},
"instances":{
"description":"The instances of the component.",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the component.",
"type":"string"
},
"widgetFamily":{
"description":"If component type of widget, the family the widget belongs to.",
"type":"string"
},
"global":{
"description":"Is the component global.",
"type":"boolean"
},
"source":{
"description":"Is this component out of the box (100) or uploaded (101).",
"type":"integer"
},
"type":{
"description":"The type of component.",
"type":"string"
},
"version":{
"description":"The current version of the component.",
"type":"integer"
},
"widgetType":{
"description":"If component type of widget, the type of widget.",
"type":"string"
},
"latestVersion":{
"description":"The latest version of the component.",
"type":"integer"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"hiddenFromSiteStudio":{
"description":"Is this component hidden from the site.",
"type":"boolean"
},
"stackType":{
"description":"If component type of stack, the type of stack.",
"type":"string"
}
}
}
}
Nested Schema : roles
Type: array
The roles of the region.
Show Source
{
"description":"The roles of the region.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : items
Type: object
Show Source
-
deleted(optional):
boolean
Indicates if this audience is deleted.
-
description(optional):
string
The Audience description.
-
displayName(optional):
string
The display name for the Audience.
-
enabled(optional):
boolean
Indicates if this audience is enabled.
-
id(optional):
string
The id of the new Audience.
-
repositoryId(optional):
string
The repository id of the Audience.
-
ruleSet(optional):
object ruleSet
The rule set for the Audience.
-
stateLastModified(optional):
integer
The time the Audience state (i.e. created, deleted, or enabled) was last modified.
-
useInReports(optional):
boolean
Indicates if this audience will be used in reporting.
-
visitorType(optional):
string
Indicates the type of visitors the audience allows. visitorType must be one of the following: "ANONYMOUS" (users not authenticated or soft logged in), "RECOGNIZED" (users that were logged in before but, have not been authenticated in the current session), "AUTHENTICATED" (logged in users), "ANONYMOUS_OR_RECOGNIZED", "ANONYMOUS_OR_AUTHENTICATED", "REGISTERED", or "ALL". These correspond to various combinations of the options that appear in the UI (ANONYMOUS, RECOGNIZED, and AUTHENTICATED) where "REGISTERED" means the user selected RECOGNIZED and AUTHENTICATED and "ALL" means the user selected all three options.
{
"type":"object",
"properties":{
"useInReports":{
"description":"Indicates if this audience will be used in reporting.",
"type":"boolean"
},
"deleted":{
"description":"Indicates if this audience is deleted.",
"type":"boolean"
},
"visitorType":{
"description":"Indicates the type of visitors the audience allows. visitorType must be one of the following: \"ANONYMOUS\" (users not authenticated or soft logged in), \"RECOGNIZED\" (users that were logged in before but, have not been authenticated in the current session), \"AUTHENTICATED\" (logged in users), \"ANONYMOUS_OR_RECOGNIZED\", \"ANONYMOUS_OR_AUTHENTICATED\", \"REGISTERED\", or \"ALL\". These correspond to various combinations of the options that appear in the UI (ANONYMOUS, RECOGNIZED, and AUTHENTICATED) where \"REGISTERED\" means the user selected RECOGNIZED and AUTHENTICATED and \"ALL\" means the user selected all three options.",
"type":"string"
},
"displayName":{
"description":"The display name for the Audience.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the Audience.",
"type":"string"
},
"ruleSet":{
"description":"The rule set for the Audience.",
"type":"object",
"properties":{
"rules":{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
},
"operator":{
"description":"The operator applied to all of the rules in the rule set.",
"type":"string"
}
}
},
"description":{
"description":"The Audience description.",
"type":"string"
},
"stateLastModified":{
"description":"The time the Audience state (i.e. created, deleted, or enabled) was last modified.",
"type":"integer"
},
"id":{
"description":"The id of the new Audience.",
"type":"string"
},
"enabled":{
"description":"Indicates if this audience is enabled.",
"type":"boolean"
}
}
}
Nested Schema : ruleSet
Type: object
The rule set for the Audience.
Show Source
{
"description":"The rule set for the Audience.",
"type":"object",
"properties":{
"rules":{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
},
"operator":{
"description":"The operator applied to all of the rules in the rule set.",
"type":"string"
}
}
}
Nested Schema : rules
Type: array
An array of rules that make up the rule set.
Show Source
{
"description":"An array of rules that make up the rule set.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
-
category(optional):
string
The category of the property, i.e. the user profile.
-
operator(optional):
string
The operator applied to the rule property.
-
property(optional):
string
The property to be evaluated.
-
value(optional):
string
The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.
{
"type":"object",
"properties":{
"property":{
"description":"The property to be evaluated.",
"type":"string"
},
"category":{
"description":"The category of the property, i.e. the user profile.",
"type":"string"
},
"value":{
"description":"The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint. When mapping this field in Integration Cloud Service(ICS), the operators which expect string values alone can be used.",
"type":"string"
},
"operator":{
"description":"The operator applied to the rule property.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"isLatestVersion":{
"description":"Is this the latest version of the component.",
"type":"boolean"
},
"updatesAvailable":{
"description":"Are there any updates available for this component.",
"type":"boolean"
},
"slotType":{
"description":"If component type of slot, the type of slot.",
"type":"string"
},
"instances":{
"description":"The instances of the component.",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the component.",
"type":"string"
},
"widgetFamily":{
"description":"If component type of widget, the family the widget belongs to.",
"type":"string"
},
"global":{
"description":"Is the component global.",
"type":"boolean"
},
"source":{
"description":"Is this component out of the box (100) or uploaded (101).",
"type":"integer"
},
"type":{
"description":"The type of component.",
"type":"string"
},
"version":{
"description":"The current version of the component.",
"type":"integer"
},
"widgetType":{
"description":"If component type of widget, the type of widget.",
"type":"string"
},
"latestVersion":{
"description":"The latest version of the component.",
"type":"integer"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"hiddenFromSiteStudio":{
"description":"Is this component hidden from the site.",
"type":"boolean"
},
"stackType":{
"description":"If component type of stack, the type of stack.",
"type":"string"
}
}
}
Nested Schema : instances
Type: array
The instances of the component.
Show Source
{
"description":"The instances of the component.",
"type":"array",
"items":{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"updateAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
Nested Schema : layoutAssociations
Type: array
The layouts the component instances are associated with.
Show Source
{
"description":"The layouts the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
}