Root Schema : getApplicationPage_response
Type: object
Show Source
{
"properties":{
"layout":{
"description":"The layout of the page.",
"type":"object",
"properties":{
"regions":{
"description":"The regions of the page layout.",
"type":"array",
"items":{
"type":"object",
"properties":{
"components":{
"description":"The 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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"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 componet.",
"type":"integer"
},
"repositoryId":{
"description":"The repository ID of the component.",
"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":"The 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"
},
"structure":{
"description":"The structure of the region.",
"type":"integer"
},
"ccsClass":{
"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":"The start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the layout.",
"type":"string"
},
"repositoryId":{
"description":"The repository ID for the layout.",
"type":"string"
},
"name":{
"description":"The name of the layout.",
"type":"string"
}
}
},
"metadata":{
"description":"The metadata of the page.",
"type":"object",
"properties":{
"layout":{
"description":"The layout ID.",
"type":"string"
},
"route":{
"description":"The route of the page.",
"type":"string"
},
"noindex":{
"description":"Whether a noindex meta tag should be added for this page to disallow search engines from showing this page in their results.",
"type":"boolean"
},
"isPreview":{
"description":"Can this application be previewed.",
"type":"boolean"
},
"keywords":{
"description":"The keywords for the page",
"type":"string"
},
"viewports":{
"description":"The viewports selected for the page.",
"type":"string"
},
"metaTags":{
"description":"The meta tags for the application page.",
"type":"array",
"items":{
"type":"object",
"properties":{
"contentValue":{
"description":"The meta tag content value.",
"type":"string"
},
"attributeValue":{
"description":"The meta tag attribute value.",
"type":"string"
},
"attributeName":{
"description":"The meta tag attribute name.",
"type":"string"
}
}
}
},
"description":{
"description":"Metadata description.",
"type":"string"
},
"title":{
"description":"The site title.",
"type":"string"
},
"alternates":{
"description":"Metadata alternates.",
"type":"array",
"items":{
"type":"object",
"properties":{
"hrefLang":{
"description":"The href language.",
"type":"string"
},
"href":{
"description":"The href.",
"type":"string"
}
}
}
},
"layoutName":{
"description":"The layout's display name.",
"type":"string"
}
}
},
"context":{
"description":"The application page's context.",
"type":"object",
"properties":{
"symbol":{
"description":"The currency symbol.",
"type":"string"
},
"productionURL":{
"description":"The production URL of the site.",
"type":"string"
},
"baseCatalogId":{
"description":"The ID of the base catalog.",
"type":"string"
},
"displayName":{
"description":"The display name of the application page.",
"type":"string"
},
"canonicalRoute":{
"description":"The canonical route of the application page.",
"type":"string"
},
"contextId":{
"description":"The context ID.",
"type":"string"
},
"locale":{
"description":"The locale of the application page.",
"type":"string"
},
"currentPriceGroupId":{
"description":"The ID of the current price group.",
"type":"string"
},
"path":{
"description":"The path of the application page.",
"type":"string"
},
"pageType":{
"description":"The application page type.",
"type":"string"
},
"route":{
"description":"The route of the application page.",
"type":"string"
},
"catalogId":{
"description":"The ID of the default catalog.",
"type":"string"
},
"siteId":{
"description":"The ID of the site.",
"type":"string"
},
"currencyCode":{
"description":"The currency code of the application page.",
"type":"string"
}
}
},
"stylesheetURIs":{
"description":"The stylesheet URIs for the application page.",
"type":"array",
"items":{
"type":"string"
}
},
"status":{
"description":"The status of the response",
"type":"object",
"properties":{
"status":{
"description":"The status code of the response",
"type":"integer"
}
}
}
}
}
Nested Schema : context
Type: object
The application page's context.
Show Source
{
"description":"The application page's context.",
"type":"object",
"properties":{
"symbol":{
"description":"The currency symbol.",
"type":"string"
},
"productionURL":{
"description":"The production URL of the site.",
"type":"string"
},
"baseCatalogId":{
"description":"The ID of the base catalog.",
"type":"string"
},
"displayName":{
"description":"The display name of the application page.",
"type":"string"
},
"canonicalRoute":{
"description":"The canonical route of the application page.",
"type":"string"
},
"contextId":{
"description":"The context ID.",
"type":"string"
},
"locale":{
"description":"The locale of the application page.",
"type":"string"
},
"currentPriceGroupId":{
"description":"The ID of the current price group.",
"type":"string"
},
"path":{
"description":"The path of the application page.",
"type":"string"
},
"pageType":{
"description":"The application page type.",
"type":"string"
},
"route":{
"description":"The route of the application page.",
"type":"string"
},
"catalogId":{
"description":"The ID of the default catalog.",
"type":"string"
},
"siteId":{
"description":"The ID of the site.",
"type":"string"
},
"currencyCode":{
"description":"The currency code of the application page.",
"type":"string"
}
}
}
Nested Schema : layout
Type: object
The layout of the page.
Show Source
{
"description":"The layout of the page.",
"type":"object",
"properties":{
"regions":{
"description":"The regions of the page layout.",
"type":"array",
"items":{
"type":"object",
"properties":{
"components":{
"description":"The 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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"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 componet.",
"type":"integer"
},
"repositoryId":{
"description":"The repository ID of the component.",
"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":"The 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"
},
"structure":{
"description":"The structure of the region.",
"type":"integer"
},
"ccsClass":{
"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":"The start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region.",
"type":"integer"
}
}
}
},
"displayName":{
"description":"The display name for the layout.",
"type":"string"
},
"repositoryId":{
"description":"The repository ID for the layout.",
"type":"string"
},
"name":{
"description":"The name of the layout.",
"type":"string"
}
}
}
Nested Schema : metadata
Type: object
The metadata of the page.
Show Source
{
"description":"The metadata of the page.",
"type":"object",
"properties":{
"layout":{
"description":"The layout ID.",
"type":"string"
},
"route":{
"description":"The route of the page.",
"type":"string"
},
"noindex":{
"description":"Whether a noindex meta tag should be added for this page to disallow search engines from showing this page in their results.",
"type":"boolean"
},
"isPreview":{
"description":"Can this application be previewed.",
"type":"boolean"
},
"keywords":{
"description":"The keywords for the page",
"type":"string"
},
"viewports":{
"description":"The viewports selected for the page.",
"type":"string"
},
"metaTags":{
"description":"The meta tags for the application page.",
"type":"array",
"items":{
"type":"object",
"properties":{
"contentValue":{
"description":"The meta tag content value.",
"type":"string"
},
"attributeValue":{
"description":"The meta tag attribute value.",
"type":"string"
},
"attributeName":{
"description":"The meta tag attribute name.",
"type":"string"
}
}
}
},
"description":{
"description":"Metadata description.",
"type":"string"
},
"title":{
"description":"The site title.",
"type":"string"
},
"alternates":{
"description":"Metadata alternates.",
"type":"array",
"items":{
"type":"object",
"properties":{
"hrefLang":{
"description":"The href language.",
"type":"string"
},
"href":{
"description":"The href.",
"type":"string"
}
}
}
},
"layoutName":{
"description":"The layout's display name.",
"type":"string"
}
}
}
Nested Schema : status
Type: object
The status of the response
Show Source
{
"description":"The status of the response",
"type":"object",
"properties":{
"status":{
"description":"The status code of the response",
"type":"integer"
}
}
}
Nested Schema : stylesheetURIs
Type: array
The stylesheet URIs for the application page.
Show Source
{
"description":"The stylesheet URIs for the application page.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : regions
Type: array
The regions of the page layout.
Show Source
{
"description":"The regions of the page layout.",
"type":"array",
"items":{
"type":"object",
"properties":{
"components":{
"description":"The 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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"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 componet.",
"type":"integer"
},
"repositoryId":{
"description":"The repository ID of the component.",
"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":"The 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"
},
"structure":{
"description":"The structure of the region.",
"type":"integer"
},
"ccsClass":{
"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":"The start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region.",
"type":"integer"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"components":{
"description":"The 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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"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 componet.",
"type":"integer"
},
"repositoryId":{
"description":"The repository ID of the component.",
"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":"The 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"
},
"structure":{
"description":"The structure of the region.",
"type":"integer"
},
"ccsClass":{
"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":"The start date of the region (slot-variant-specific).",
"type":"string"
},
"mobileWidth":{
"description":"The mobile width of the region.",
"type":"integer"
}
}
}
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
The components in the region.
Show Source
{
"description":"The 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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"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 componet.",
"type":"integer"
},
"repositoryId":{
"description":"The repository ID of the component.",
"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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"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 componet.",
"type":"integer"
},
"repositoryId":{
"description":"The repository ID of the component.",
"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":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"updatesAvailable":{
"description":"Is there an update available for this component instance.",
"type":"boolean"
},
"displayName":{
"description":"The name displayed for the component instance.",
"type":"string"
},
"repositoryId":{
"description":"The component's repository ID.",
"type":"string"
},
"layoutAssociations":{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
},
"version":{
"description":"The current version of the component instance.",
"type":"integer"
}
}
}
Nested Schema : layoutAssociations
Type: array
The layout the component instances are associated with.
Show Source
{
"description":"The layout the component instances are associated with.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : alternates
Type: array
Metadata alternates.
Show Source
{
"description":"Metadata alternates.",
"type":"array",
"items":{
"type":"object",
"properties":{
"hrefLang":{
"description":"The href language.",
"type":"string"
},
"href":{
"description":"The href.",
"type":"string"
}
}
}
}
Nested Schema : metaTags
Type: array
The meta tags for the application page.
Show Source
{
"description":"The meta tags for the application page.",
"type":"array",
"items":{
"type":"object",
"properties":{
"contentValue":{
"description":"The meta tag content value.",
"type":"string"
},
"attributeValue":{
"description":"The meta tag attribute value.",
"type":"string"
},
"attributeName":{
"description":"The meta tag attribute name.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"hrefLang":{
"description":"The href language.",
"type":"string"
},
"href":{
"description":"The href.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"contentValue":{
"description":"The meta tag content value.",
"type":"string"
},
"attributeValue":{
"description":"The meta tag attribute value.",
"type":"string"
},
"attributeName":{
"description":"The meta tag attribute name.",
"type":"string"
}
}
}