Type object
File match **/webapp/manifest.json **/src/main/webapp/manifest.json **/src/manifest.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/ui5-manifest/latest.json
Source https://raw.githubusercontent.com/UI5/manifest/main/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

_version string required

Represents Application Descriptor format version. It is managed by schema owner

Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0" "1.6.0" "1.7.0" "1.8.0" "1.9.0" "1.10.0" "1.11.0" "1.12.0" "1.13.0" "1.14.0" "1.15.0" "1.16.0" "1.17.0" "1.18.0" "1.19.0" "1.20.0" "1.21.0" "1.22.0" "1.23.0" "1.24.0" "1.25.0" "1.26.0" "1.27.0" "1.28.0" "1.29.0" "1.30.0" "1.31.0" "1.32.0" "1.33.0" "1.34.0" "1.35.0" "1.36.0" "1.37.0" "1.38.0" "1.39.0" "1.40.0" "1.41.0" "1.42.0" "1.43.0" "1.44.0" "1.45.0" "1.46.0" "1.47.0" "1.48.0" "1.49.0" "1.50.0" "1.51.0" "1.52.0" "1.53.0" "1.54.0" "1.55.0" "1.56.0" "1.57.0" "1.58.0" "1.59.0" "1.60.0" "1.61.0" "1.62.0" "1.63.0" "1.64.0" "1.65.0" "1.66.0" "1.67.2" "1.68.0" "1.69.0" "1.70.1" "1.71.0" "1.72.0" "1.73.1" "1.75.1" "1.76.0" "1.77.0" "1.78.0" "1.79.0" "1.80.0" "1.80.1" "1.81.0" "1.81.1" "1.82.0" "1.83.0" "1.83.1" "1.84.0"
sap.app object required

Represents general application attributes

23 nested properties
id string required
maxLength=70
type string required

Represents type of an application and can be application or component or library or card

Values: "application" "component" "library" "card"
applicationVersion object required

Represents mandatory version of the app

1 nested properties
version string required
title string | string required
_version string

Application attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0" "1.6.0" "1.7.0" "1.8.0" "1.9.0" "1.10.0" "1.11.0" "1.12.0" "1.13.0" "1.14.0" "1.15.0" "1.16.0" "1.17.0" "1.18.0" "1.19.0" "1.20.0" "1.21.0" "1.21.1"
sourceTemplate object

Represents the template from which the app was generated

3 nested properties
id string required

Represents id of the template from which the app was generated

version string required

Represents the version of the template from which the app was generated

toolsId string

Represents an Id generated by SAP Fiori tools

i18n string | object | object

Represents path inside the app to the properties file containing text symbols for the Descriptor or properties file specific settings (including supportedLocales, fallbackLocale, terminologies and enhanceWith)

Default: "i18n/i18n.properties"
embeds string[]

Represents array of relative paths to the nested manifest.json's (mandatory if it contains nested 'manifest.json')

embeddedBy string

Represents relative path back to the manifest.json of an embedding component or library (mandatory for nested 'manifest.json')

subTitle string | string
shortTitle string | string
info string | string
description string | string
tags object

Represents array of keywords

2 nested properties
keywords i18n_key_string[] required
technicalAttributes string[]
ach string

Represents application component hierarchy

pattern=^([a-zA-Z0-9]{2,3})(-[a-zA-Z0-9]{1,6})*$
dataSources object

Represents used data sources with a unique key/alias

cdsViews string[]

Represents array of directly used CDS views, which only to be added if directly used via INA protocol and not if used via OData service

resources string

Represents reference to a file (naming convention is resources.json) which contains list with all resources which the app needs

Values: "resources.json"
destination object

Represents a system alias

1 nested properties
name string required

Represents an alias for the system

openSourceComponents openSource[]

Represents a collection of directly used open source libs (not when used via UI5 capsulation)

provider string

Represents the name of the provider which owns the application

Values: "sfsf"
offline boolean

Represents indicator whether the app is running offline. Possible values are true or false (default)

Default: false
crossNavigation object

Represents cross navigation for inbound and outbound targets

3 nested properties
inbounds object required
scopes object

Represents scopes of a site

outbounds object
sap.ui object required

Represents general ui attributes

6 nested properties
technology string required

Represents UI technology. The possible values are UI5 (default), WDA, NWBC, GUI, URL and WCF

Default: "UI5"
Values: "UI5" "WDA" "NWBC" "GUI" "URL" "WCF"
deviceTypes required

Represents device types on which application is running. Supported device types are desktop, tablet and phone

All of: deviceType object, variant
_version string

Represents UI attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0"
icons object

Represents icons which used in application

6 nested properties
icon string

Represents icon of the app

favIcon string

Represents ICO file to be used inside the browser and for desktop shortcuts

phone string

Represents 57x57 pixel version for non-retina iPhones

phone@2 string

Represents 114x114 pixel version for non-retina iPhones

tablet string

Represents 72x72 pixel version for non-retina iPads

tablet@2 string

Represents 144x144 pixel version for non-retina iPads

supportedThemes string[]

[Deprecated] Represents array of supported SAP themes such as sap_hcb, sap_bluecrystal

fullWidth boolean

Indicates whether app should run in full screen mode: possible values: true or false

$schema string

The resource identifier for the JSON schema to be used. The value of this keyword MUST be a URI [RFC3986] (containing a scheme) and this URI MUST be normalized. The current schema MUST be valid against the meta-schema identified by this URI. If this URI identifies a retrievable resource, that resource SHOULD be of media type "application/schema+json".

format=uri
start_url string

Represents the URL that the developer would prefer the user agent load when the user launches the web application

sap.ui5

Represents sapui5 attributes

All of: object object, object | object object | object
sap.platform.abap object

Represents ABAP platform specific attributes

3 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0"
uri string

Represents the uri of the app in the ABAP system

uriNwbc string

Represents the alternative uri of the app in the ABAP system for starting the application

sap.platform.hcp object

Represents HANA Cloud Platform platform specific attributes

7 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0"
uri string

Represents the uri of the app in the HANA Cloud Platform

uriNwbc string

Represents the alternative uri of the app in the ABAP system for starting the application

providerAccount string

Represents the provider account of the HTML5 application

appName string

Represents the HTML5 application name

pattern=^[a-z][a-z0-9]{0,29}$
appVersion string

Represents the version of the HTML5 application

multiVersionApp boolean

Indicates that HCP application is multi-version enabled

sap.platform.cf object

Represents CF(Cloud Foundry) platform specific attributes

2 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0"
oAuthScopes string[]

Represents the authorization scope of the application

sap.platform.mobilecards object

Represents Mobile Cards platform specific attributes

2 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.0.0"
compatible boolean

Represents the compatibility of this app with the Mobile Cards platform.

sap.fiori object

Represents SAP Fiori specific attributes

5 nested properties
registrationIds string[] required

Represents array of registration ids, i.e. for Fiori apps fiori id(s)

archeType string required

Represents architecture type of an application. The supported types are transactional or analytical or factsheet or reusecomponent or fpmwebdynpro or designstudio

Values: "transactional" "analytical" "factsheet" "reusecomponent" "fpmwebdynpro" "designstudio"
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0"
abstract boolean

Indicator that app is an abstract (generic) app which may not be used directly, but needs to be specialized in the SAP Fiori launchpad content

cloudDevAdaptationStatus string

Represents the release status for the developer adaptation in the cloud (relevant for SAP internal only). The supported types are released, deprecated, obsolete, no value means not released

Values: "released" "deprecated" "obsolete"
sap.ui.generic.app object

Represents GENERIC APP specific attributes

3 nested properties
_version string
Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0" "1.6.0"
settings object

Represents global settings for the application controller

pages pages_array[] | object

Represents one ore more pages of an application. UI5 routing is created from the definitions in this section

sap.fe object

Represents specific attributes for Fiori Elements

sap.flp object

Represents FLP specific attributes

6 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0"
tileSize string

Represents size of the tile. Deprecated, use 'vizOptions' instead.

Values: "1x1" "1x2"
vizOptions object

Options a visualization (launchpad tile) is offering with regards to rendering, for example

1 nested properties
displayFormats object

Defines what display formats a visualization type can render itself in. The value 'default' is deprecated - please use 'standard' instead!

2 nested properties

Lists all display formats the visualization type is capable of rendering itself in. The order of items may be used as preference definition (most important first). The value 'default' is deprecated - please use 'standard' instead!

Default:
[
  "standard"
]
default string
Values: "standard" "standardWide" "flat" "flatWide" "compact"
type string

Represents the type of FLP entry. It must be 'application' or 'tile' or 'plugin'

Default: "application"
Values: "application" "tile" "plugin"
config object

Represents configuration parameters of the FLP entry

origin object

Represents the original tile and target mapping which resulted in this app. Deprecated.

2 nested properties
tileId string

Represents the original tile which resulted in this app

targetMappingId string

Represents the original target mapping which resulted in this app

sap.ovp object

Represents OVP specific attributes

23 nested properties
cards object required
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0" "1.6.0" "1.7.0" "1.8.0" "1.9.0" "1.10.0" "1.11.0" "1.12.0" "1.13.0"
globalFilterModel string

Represents the name of global filter OData model, which contains entities definition that are relevant for global filters

pattern=^[a-zA-Z0-9_\.\-\|@]*$
globalFilterEntityType string

Represents the entity to use as global filter in the smart filter bar control

pattern=^[a-zA-Z0-9_\.\-\|@]*$
globalFilterControlType string

Represents the control to be used for the filter bar

Default: "SmartFilterBar"
Values: "MacroFilterBar" "SmartFilterBar"
globalFilterEntitySet string

Represents the entity set to use as global filter in the smart filter bar control

pattern=^[a-zA-Z0-9_\.\-\|@]*$
showBasicSearch boolean

Represents a switch to include basic search in the global filters

Default: false
disableErrorPage boolean

Represents a switch to disable the error page shown on load of overview page when no data is retreived from the backend

Default: false
smartVariantRequired boolean

Represents a switch to activate smart variant management in the global filters

Default: true
bHeaderExpanded boolean

Represents a switch to show smart filter bar in expanded or collapsed mode

Default: false
containerLayout string

Represents the layout of the card container

Default: "resizable"
One of: const: "resizable" const: "resizable", const: "fixed" const: "fixed"
showDateInRelativeFormat boolean

Represents a switch to Enable or disable Relative or Normal date formating in ovp application

Default: true
disableTableCardFlexibility boolean

Represents a switch to Enable or Disable the Flexibility of Table cards

Default: false
enableLiveFilter boolean

Represents the switch to activate live update in the global filters, else manual update will be required

Default: true
enableLazyRendering boolean

Enable loading of cards when they enter viewport

Default: false
refreshStrategyOnAppRestore object
1 nested properties
entitySets object

Represents the map of entity sets configured for refresh strategies

considerAnalyticalParameters boolean

Flag to enable/disable analytical parameter support for Smart filter bar

Default: false
refreshIntervalInMinutes integer

Time interval in minutes to auto refresh the card models

Default: 1
useDateRangeType boolean

Flag to enable/disable semantic date range control for Smart filter bar

Default: false
chartSettings object

Represents the object to store analytical chart settings

1 nested properties
showDataLabel boolean

Flag to enable data labels on analytical charts

Default: false
filterSettings object

Represents the object to store filter bar configuration

1 nested properties
dateSettings object

Represents the object to store date type filter fields configuration

4 nested properties
useDateRange boolean

Flag to enable DateTimeRange setting for date type filter fields with filter restriction interval

Default: false
selectedValues string

Represents the semantic date values selected for the date filter field

exclude boolean

Flag to exclude values from the date picker

Default: false
fields object

Represents the filter field definition for each field

dataLoadSettings object

Represents the object to define data loading behaviour for an overview page application

1 nested properties
loadDataOnAppLaunch string

Data load behaviour options on application launch

Default: "always"
Values: "always" "never" "ifAnyFilterExist"
resizableLayout object
sap.insights object

Represents Insights attributes

12 nested properties
parentAppId string required

Represents mandatory unique app identifier of the app containing self manifest.

cardType string required

Represents the environment type of Insights card

Values: "DT" "RT"
_version string
Values: "1.0.0" "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0"
filterEntitySet string

Represents the entity to use as global filter in the filter bar control

pattern=^[a-zA-Z0-9_\.\-\|@]*$
templateName string

Represents the template name, from where manifest is generated

pattern=^[a-zA-Z0-9_\.\-\|@]*$
isDtCardCopy boolean

Represents the state of original or copied card

Default: false
isDeletedForUser boolean

Represents the deleted state for a user

Default: false
visible boolean

Represents the visibility type of Insights card

Default: true
rank integer

[Deprecated] Represents the display order of Insights card

versions object

Represents UI5 and card generator middleware version.

2 nested properties
ui5 string

Represents the version of UI5 used to generate the card.

dtMiddleware string

Represents the version of design time card generator

ranking string

New property representing the display order of Insights card

allowedChartTypes string[]

Array of all supported chart type allowed for transformation.

sap.wda object

Represents WDA specific attributes

5 nested properties
applicationId string required

Represents ID of an application

pattern=^[a-zA-Z0-9\/_]{1,30}$
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0"
configId string

Represents ID of an application configuration

pattern=^[a-zA-Z0-9\/\_]{1,32}$
flavorId string

Represents SAP Screen Personas Flavor ID

pattern=^[A-F0-9]{1,32}$
compatibilityMode boolean

Indicates that WebDynpro Application requires Compatibility Mode, while uses legacy shell services. Possible values are true or false (default)

Default: false
sap.apf object

Represents APF specific attributes

4 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0"
activateFilterReduction boolean

Represents a switch to activate filter reduction so that filters in OData requests can be represented as ABAP select options

Default: false
activateLrep boolean

Represents a switch to activate LREP as the persistence for configurations and texts

Default: false
useHeadRequestForXsrfToken boolean

Represents a switch to use HEAD-Requests instead of GET-Requests when fetching the XSRF-Security-Token

Default: false
sap.cloud.portal object

Represents Cloud Portal specific attributes

sap.gui object

Represents GUI specific attributes

3 nested properties
transaction string required

Represents transaction of an application

pattern=^[a-zA-Z0-9\/_]{1,20}$
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0"
flavorId string

Represents SAP Screen Personas Flavor ID

pattern=^[A-F0-9]{1,32}$
sap.integration object

Represents Application Integration specific attributes

3 nested properties
urlTemplateId string required

Reference to the desired URL Template

Examples: "template.sap.sfsf", "template.sap.ui5", "template.sap.wda"
parameters object[] required

Represents configuration parameters which will be used by Template Engine to compile URL Template

_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.0.0"
sap.wcf object

Represents WCF Application specific attributes

2 nested properties
wcf-target-id string required

Represents the target technical id for a WCF Application

pattern=^[a-zA-Z0-9\/_]{1,10}$
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0"
sap.ui.smartbusiness.app object

Represents specific attributes for Smart Business

sap.mobile object

Represents mobile specific attributes

2 nested properties
definingRequests object required

Represents mobile specific attributes

_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.1.0"
sap.copilot object

Represents specific attributes for SAP CoPilot

3 nested properties
_version string

Represents SAP.COPILOT attributes format version. It is managed by namespace owner

Values: "1.0.0" "1.1.0"
contextAnalysis object

Settings for the context analysis features of SAP CoPilot

2 nested properties
allowAddingObjectsFromAppScreenToCollection boolean

Enable/Disable the ability for SAP CoPilot to analyze your Application Screens and add the found objects to a Collection

Default: true
whitelistedEntityTypes string[]

A list of the whitelisted EntityTypes, prefixed with their namespace, that SAP CoPilot can display. The empty list is ignored, thus allowing all EntityTypes by default.

digitalAssistant object

Settings for the Digital Assistant features of SAP CoPilot

1 nested properties
intentDefinition object

A list of Intent

sap.map object

Represents specific attributes for SAP.MAP

sap.url object

Represents specific attributes for SAP URL

2 nested properties
uri string required

Represents URI of an application

_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.0.0"
sap.platform.sfsf object

Represents SFSF platform specific attributes

4 nested properties
appName string required

Represents the SFSF application name

_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.0.0"
uri string

Represents the uri inside the SFSF app

appVersion string

Represents the version of the SFSF application

sap.cloud object

Represents cloud platform specific attributes

3 nested properties
_version string

Represents attributes format version. It is managed by namespace owner

Values: "1.0.0" "1.1.0" "1.2.0"
service string

Unique Business Service Identifier

pattern=^[^- @#$%^&()!]+$
public boolean

Specify if the UI can be accessed from a different space than origin development space

Default: false
sap.card object

Represents general card attributes

All of: variant, variant, variant, variant, variant, variant, variant, variant, variant, variant
12 nested properties
type string required

Represents the type of the card's content

Values: "AdaptiveCard" "Analytical" "AnalyticsCloud" "Calendar" "Component" "List" "Object" "Table" "Timeline" "WebPage"
_version string

Represents SAP.CARD attributes format version. It is managed by namespace owner

Values: "1.1.0" "1.2.0" "1.3.0" "1.4.0" "1.5.0" "1.6.0" "1.7.0" "1.8.0" "1.9.0" "1.10.0" "1.11.0" "1.13.0" "1.14.0" "1.15.0" "1.16.0" "1.17.0" "1.18.0" "1.19.0" "1.20.0" "1.21.0" "1.22.0" "1.23.0" "1.24.0" "1.25.0" "1.26.0" "1.27.0" "1.28.0" "1.29.0" "1.30.0" "1.31.0" "1.32.0" "1.33.0" "1.34.0" "1.35.0" "1.36.0" "1.37.0" "1.38.0" "1.39.0" "1.40.0" "1.41.0" "1.42.0" "1.43.0" "1.44.0" "1.45.0" "1.46.0" "1.47.0" "1.48.0" "1.49.0" "1.50.0" "1.51.0" "1.52.0" "1.53.0" "1.54.0" "1.55.0" "1.56.0" "1.57.0" "1.58.0" "1.59.0" "1.60.0" "1.61.0"
designtime string

[Deprecated] The path to the design time folder with assets files

configuration object

General configuration of the card. Allows to define parameters, destinations, filters and more

14 nested properties
editor string

The path to the design time configuration file. Used for Configuration Editor

enableMarkdown boolean

Markdown enablement for Adaptive Content

helpId string

[Experimental] The help-id which will be rendered as data-help-id on the base element of the card

modelSizeLimit number | simpleBinding

[Experimental] Represents the maximum number of entries that are used for list bindings

Default: 1000
parameters Record<string, object>

Map of parameters

filters Record<string, Configuration.FilterType.Select | Configuration.FilterType.DateRange | Configuration.FilterType.Search | Configuration.FilterType.ComboBox>

Map of filters

destinations Record<string, object>

Specifies the destinations configured for use by the card

useMainDestinations boolean

Indicates if child cards should reference the main card's destinations. Must be set to true in child cards to use the main card's destinations

Default: false
csrfTokens Record<string, object>

Describes the CSRF tokens used by the card

actionHandlers object

Contains configuration settings for the default action handlers

1 nested properties
submit object

Configuration for the submit action handler

messages Record<string, object>

Describes the messages for the card

componentData object

[Experimental] Object which will be passed to the component as 'componentData'

loadingPlaceholders object

[Experimental] Object that will represent the loading placeholder of the card

1 nested properties
delay number

The delay of the loading placeholder

childCards Record<string, object>

[Experimental] Map of child cards

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

headerPosition string

Represents card header position - under or over the content

One of: enum enum, simpleBinding string
content

Represents card content attributes. Content type should be the same as card type e.g. if card type List is used the content type should also be List

extension string

A path to an Extension implementation. It is resolved relatively to the manifest

footer object

Represent card footer attributes

4 nested properties

Describes actions strip

paginator object

[Experimental] Describes the paginator

2 nested properties
pageSize number | simpleBinding

Represents the number of the items in one page

totalCount number | simpleBinding

Represents the total count of the items in all pages

visible boolean | simpleBinding
closeButton object

[Experimental] Represents attributes of the Close button

1 nested properties
visible boolean | simpleBinding
requiredHeight string

Represents card minimum required height

requiredWidth string

Represents card minimum required width

sap.package object

Represents general package attributes. Experimental, will be detailed in the future

19 nested properties
id string required
maxLength=70pattern=^[A-Za-z]{2,}.[A-Za-z]{2,}
packageVersion object required

Represents mandatory semantic version of the package information and optional the upgrade notification

2 nested properties
version string required

The version number of the schema in major.minor.patch format.

pattern=^[0-9]{1,}.[0-9]{1,}.[0-9]{1,}$
upgradeNotification string

Represents optional upgrade notification once the package is available. none - no notification, package will be installed automatically for any version. major - notification before a new major version is installed. major.minor - notification before a major and minor version is installed. all - notification before any new version is installed, including patches

Default: "all"
Values: "none" "major" "major.minor" "all"
title string | string required
description string | string required
vendor object required

Represents the vendor information

4 nested properties
id string required

Represents the vendor id

name string required

Represents the vendor name

url string required

Represents a target url

format=uri-template
lineOfBusiness string

Represents the vendor line of business within the vendors organization if any

support object required

Represents a link information with text and url

2 nested properties
url string required

Represents a target url

format=uri-template
text string required

Represents a descriptive text for the target

_version string

Represents SAP.PACKAGE attributes format version. It is managed by namespace owner

Values: "1.0.0" "1.1.0" "1.2.0"
i18n string

Represents path inside the package to the properties file containing text symbols for the packages texts

Default: "i18n/i18n.properties"
type string

Represents type of an package and can be card, workflow, workspace-template

Values: "card" "workflow" "workspace-template"
subTitle string | string
shortTitle string | string
info string | string
icon string

Represents icon name or source URL for the package

tags object

Represents array of keywords used to find the package

2 nested properties
keywords i18n_key_string[] required
technicalAttributes string[]
homepage object

Represents a link information with text and url

2 nested properties
url string required

Represents a target url

format=uri-template
text string required

Represents a descriptive text for the target

documentation object

Represents a link information with text and url

2 nested properties
url string required

Represents a target url

format=uri-template
text string required

Represents a descriptive text for the target

contents contentitem[]
consumption string[]

Represents list of product ids that are allowed to consume this package. if not defined all products that are capable of installing this package are allowed

dependencies object

Represents the products and service that the pacakge depends on

2 nested properties
products string[]

List of products that this package depends on

services string[]

List of services that this package depends on

sap.artifact object

Represents general artifact attributes.

12 nested properties
id string required
maxLength=70pattern=^[A-Za-z]{2,}.[A-Za-z]{2,}
artifactVersion object required

Represents mandatory semantic version of the artifact

1 nested properties
version string required

The version number of the schema in major.minor.patch format.

pattern=^[0-9]{1,}.[0-9]{1,}.[0-9]{1,}$
type string required

Represents type of an artifact and can be card, workflow, workspace-template

Values: "card" "workflow" "workspace-template"
title string | string required
description string | string required
_version string

Represents SAP.ARTIFACT attributes format version. It is managed by namespace owner

Values: "1.0.0" "1.1.0" "1.2.0"
i18n string

Represents path inside the artifact to the properties file containing text symbols for the artifacts texts

Default: "i18n/i18n.properties"
subTitle string | string
shortTitle string | string
info string | string
icon string

Represents icon name or source URL for the artifact

tags object

Represents array of keywords used to find the artifact

2 nested properties
keywords i18n_key_string[] required
technicalAttributes string[]
sap.bpa.task object

Represents SBPA Custom Task UI Attributes

One of: variant
6 nested properties
_version string required

Represents attributes format version. It is managed by namespace owner

Values: "1.0.0" "1.1.0"
category string required

Represents the category of the task ui

Values: "standard" "approval"
outcomes object[] required

Represents the outcomes of the task ui

minItems=1maxItems=5uniqueItems=true
inputs Latest Schema

Represents the inputs of the task ui

outputs Latest Schema

Represents the outputs of the task ui

preview object

Configuration for a preview of the application in SBPA

1 nested properties
src string

Relative path to an image. The path to the image is relative to the baseUrl of the application

sap.cards.ap object

Represents generated cards saved to the application repository

2 nested properties
_version string

Represents attributes format version.

Values: "1.0.0" "1.1.0"
embeds object

Represents an object with reference to the generated cards

1 nested properties
ObjectPage object

Represents the embeds settings

2 nested properties
default string

Represents the detault card

pattern=^[a-zA-Z0-9_]+$
manifests object

Definitions

manifestSettings object

Represents the manifest settings

localUri string

Represents the local uri of the generated card

hideActions boolean

Represents a switch to hide actions from the shared card

embedsSettings object

Represents the embeds settings

default string

Represents the detault card

pattern=^[a-zA-Z0-9_]+$
manifests object
tag_0 string[]
i18n_key_string string | string
semanticversion string

The version number of the schema in major.minor.patch format.

iddef string
contentitem object

Represents an item of the content list defining the sub manifest and baseurl

baseURL string

Relative url to the artifact within the folder in this package

manifest object

Wraps the child manifest

1 nested properties
sap.artifact object

The artifacts manifest

vendor object

Represents the vendor information

id string required

Represents the vendor id

name string required

Represents the vendor name

url string required

Represents a target url

format=uri-template
lineOfBusiness string

Represents the vendor line of business within the vendors organization if any

actionsStripItemBindingInfo object

[Experimental] Binding info for items of type actionsStripItem

template object

Attributes of actions strip item

10 nested properties
actions action[]

Action(s) which will be executed when button is pressed

type enum | simpleBinding

The type of the item

overflowPriority enum | simpleBinding

Defines items priority

icon string

The icon of the item

text string

The text of the item

tooltip string

The tooltip of the item

buttonType enum | simpleBinding

The type of the button

ariaHasPopup enum | simpleBinding

Use this property only when the item is related to a popover/popup

visible boolean | simpleBinding
preferIcon boolean | simpleBinding

Defines whether the button will shown icon only when placed in the visible area. This will save space in the actions strip. When in the overflow area, it will always show both icon and text

path string
MicroChart.StackedBar.Bar object
value number | simpleBinding

The actual value shown as a colored horizontal bar

displayValue string

The value, which will be displayed as a text in the tooltip of the bar

legendTitle string

Title, which will be displayed in the legend

color string

The color of the bar

One of: Enums.ValueColor enum, simpleBinding string
MicroChart.Bullet.Threshold object
value number | simpleBinding

The value of the threshold

color string

The state color of the threshold

One of: Enums.ValueColor enum, simpleBinding string
MicroChart.StackedBar object
type string required

Represents the type of the MicroChart

Constant: "StackedBar"
maxValue number | simpleBinding

The maximum scale value for the bar chart

displayValue string

The value, which will be displayed as a text next to the bar

displayZeroValue boolean | simpleBinding

Defines whether bars with zero values are displayed

The bars of the chart

visible boolean | simpleBinding
MicroChart.Bullet object
type string required

Represents the type of the MicroChart

Constant: "Bullet"
value number | simpleBinding

The actual value shown as a colored horizontal bar

minValue number | simpleBinding

The minimum scale value for the bar chart

maxValue number | simpleBinding

The maximum scale value for the bar chart

displayValue string

The actual value, which will be displayed as a text next to the bar

target number | simpleBinding

The target value - displayed as a vertical line (marker)

scale string

The scaling suffix that is appended to all values

color string

The state color of the bar

One of: Enums.ValueColor enum, simpleBinding string

The thresholds indicators of the bar

visible boolean | simpleBinding
MicroChart.Generic object
type string required

Represents the type of the MicroChart

Values: "Line" "Column" "HarveyBall" "Radial"
Configuration.Filter.ComboBoxItem object

A single Combo Box filter selection option

title string

The title of the filter option

key string

The unique key of the filter option. Mapped to the filter's value

additionalText string

The secondary value for the combo box item

Configuration.Filter.Item object

A single filter selection option

title string

The title of the filter option

key string

The unique key of the filter option. Mapped to the filter's value

Configuration.BasicDataType string

Basic data types for parameters and filters

ibnTarget object

The application identifier consisting of semanticObject and action or

semanticObject string required
action string required
hideCardActionParameters object

Parameters for HideCard action

showCardActionParameters object

Parameters for ShowCard action

childCardKey string

The key of the card to be shown

manifest string | object

[Deprecated] Child card manifest

parameters object
data object
width string
baseUrl string
resizable boolean | simpleBinding
submitActionParameters object

Parameters for Submit action

navigationActionIBParameters object

Parameters for Intent-Based Navigation action

ibnTarget object required

The application identifier consisting of semanticObject and action or

2 nested properties
semanticObject string required
action string required
ibnParams object

Key/value pairs for parameters of the target application

ibnAppSpecificRoute string

An application specific route that is passed to the target application

navigationActionParameters object

Parameters for Navigation action

url string required
target string
customActionParameters object

Parameters for Custom action

cache object

Cache control settings

maxAge number

The maximum age for which the cache is considered fresh

Default: 0
staleWhileRevalidate boolean

Should we show stale cache while revalidating

Default: false
noStore boolean

[Deprecated] Set to true to disable caching for this card

Default: false
enabled boolean

Set to false to disable caching for this card

Default: false
batchRequest object

Represents a request which is a part of a batch request

url string required

The URL to make the request to

method string required

The HTTP method

Values: "GET" "POST" "PUT" "PATCH" "DELETE"
headers object

Represents HTTP headers

body

Represents the request body

extension object

[Experimental] Represents attributes, needed to get data via extension

method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

service_0 string | object

Represents service that will be used for actions

request object

Represents request attributes

url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

4 nested properties
maxAge number

The maximum age for which the cache is considered fresh

Default: 0
staleWhileRevalidate boolean

Should we show stale cache while revalidating

Default: false
noStore boolean

[Deprecated] Set to true to disable caching for this card

Default: false
enabled boolean

Set to false to disable caching for this card

Default: false
statusTextFormatter object

Defines fields for dynamic status formatting

format object

Defines binding information

2 nested properties
translationKey string
parts array
iconBackgroundColor enum | simpleBinding
ContentType.Calendar.SpecialDate.Template object

The template for all specialDates

startDate string

The start date of the special date. The accepted date format is ISO 8601

endDate string

The end date of the special date. The accepted date format is ISO 8601

type enum | simpleBinding

The type of the special date - one of the types defined in the legend

ContentType.Calendar.LegendItem.Template object

The template for all legendItems

category string

Defines which card component describes the legend item. Available categories: "calendar" (represented as square) or "appointment" (circle)

text string

The describing information of the item

type enum | simpleBinding

The type of the legend item corresponding with the described component

ContentType.Calendar.Item.Template object

The template for all items

startDate string

The start date of the item. The accepted date format is ISO 8601

endDate string

The end date of the item. The accepted date format is ISO 8601

title string

The title of the item

text string

The additional information of the item

icon object

Represents simple icon attributes

2 nested properties
src string

Represents icon name or source URL

visible boolean | simpleBinding
type enum | simpleBinding

The type of the item - one of the types defined in the legend

actions action[]

Defines actions that can be applied on the item

ContentType.Calendar.SpecialDate object

Describes each specialDate

template object

The template for all specialDates

3 nested properties
startDate string

The start date of the special date. The accepted date format is ISO 8601

endDate string

The end date of the special date. The accepted date format is ISO 8601

type enum | simpleBinding

The type of the special date - one of the types defined in the legend

path string

Defines the path to the structure holding the data about the specialDates

ContentType.Calendar.LegendItem object

Describes each legendItem

template object

The template for all legendItems

3 nested properties
category string

Defines which card component describes the legend item. Available categories: "calendar" (represented as square) or "appointment" (circle)

text string

The describing information of the item

type enum | simpleBinding

The type of the legend item corresponding with the described component

path string

Defines the path to the structure holding the data about the legendItems

ContentType.Calendar.Item object

Describes each item

template object

The template for all items

7 nested properties
startDate string

The start date of the item. The accepted date format is ISO 8601

endDate string

The end date of the item. The accepted date format is ISO 8601

title string

The title of the item

text string

The additional information of the item

icon object

Represents simple icon attributes

2 nested properties
src string

Represents icon name or source URL

visible boolean | simpleBinding
type enum | simpleBinding

The type of the item - one of the types defined in the legend

actions action[]

Defines actions that can be applied on the item

path string

Defines the path to the structure holding the data about the items

progressIndicator object

Represents progress indicator attributes

Represents state color

percent number | simpleBinding

Represents progress indicator percent value

text string

Represents progress indicator text

identifier boolean | object

Represents identifier

textAlign string

Represents options for text alignments

ContentType.Table.Column object

Represents object item attributes

title string | string
width string

Defines the width of the column

Defines the horizontal alignment of the column content

value string

Represents the text value of the column

additionalText string

Represents the additional text for the identifier column

icon object

Represents icon attributes

9 nested properties
src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

size enum | simpleBinding

[Experimental] The size of the icon

fitType enum | simpleBinding

Defines how the image fits in the icon area

backgroundColor enum | simpleBinding
visible boolean | simpleBinding

Defines the state of the column

inverted boolean | simpleBinding

Specifies whether the background color reflects the set "state" instead of the control's text

url string

[Deprecated] Defines the URL string

target string

[Deprecated] Specifies where to open the 'url', if it is provided

One of: target object, simpleBinding string
identifier identifier | simpleBinding
progressIndicator object

Represents progress indicator attributes

3 nested properties

Represents state color

percent number | simpleBinding

Represents progress indicator percent value

text string

Represents progress indicator text

visible boolean | simpleBinding
actions action[]

Defines actions that can be applied on the group item

showStateIcon boolean | simpleBinding

Defines if a default state icon is shown

customStateIcon string

The custom state icon

ContentType.Object.Item.IconGroupIcon object

Definition for icons in the IconGroup

src string

Represents icon name or source URL

text string

[Deprecated] Represents text that will be displayed in the icon

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

alt string

Represents text that will be displayed as a tooltip

ContentType.Object.Item.Validation object

[Experimental] Defines the user input validation

message string

Defines custom validation message text

type enum | simpleBinding

Defines the validation type

required boolean | simpleBinding

Defines whether the user input is required

minLength number | simpleBinding

Defines the minimum number of characters

maxLength number | simpleBinding

Defines the maximum number of characters

restrictToPredefinedOptions boolean | simpleBinding

Defines whether the value is restricted to predefined options

pattern string

Sets the regular expression pattern that should match the value

validate string

An extension function used to validate the value

ContentType.Object.Item.RadioButtonItemTemplate object

Template for radio button group items

enabled boolean | simpleBinding required

Whether the radio button option is enabled

title string

The title of the radio button option

key string

The unique key of the radio button option

ContentType.Object.Item.ComboBoxItemTemplate object

Template for combo box items

title string

The title of the option

key string

The unique key of the option. Mapped to the input's value

ContentType.Object.Item.IconGroupTemplate object

Template definition for the icons in the group

icon object required

Definition for icons in the IconGroup

4 nested properties
src string

Represents icon name or source URL

text string

[Deprecated] Represents text that will be displayed in the icon

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

alt string

Represents text that will be displayed as a tooltip

actions action[]

Defines actions that can be applied on the icon

ContentType.Object.Item.MainIndicator object

Represents the main numeric indicator of the NumericData

number string

The value of the main indicator

unit string

The unit of the main indicator

trend string

The trend indicator (direction)

One of: enum enum, simpleBinding string
state string

The state color of the main indicator

One of: Enums.ValueColor enum, simpleBinding string
size enum | simpleBinding
target_0 string

Specifies where to open an URL

ContentType.Object.Item object

Represents a single item of information. It can contain label, value and image

icon object

Represents icon attributes

9 nested properties
src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

size enum | simpleBinding

[Experimental] The size of the icon

fitType enum | simpleBinding

Defines how the image fits in the icon area

backgroundColor enum | simpleBinding
visible boolean | simpleBinding
label string

Defines the label of the item

showColon boolean | simpleBinding

Defines whether the colon next to the label is shown

value string | number | object

Represents the text, which is associated with the label

tooltip string

Defines the tooltip of the link

type string

Defines the type of the displayed information. Some of the types are deprecated

One of: enum enum, simpleBinding string
url string

[Deprecated] Defines the URL string. Works only with items of type 'link'

[Deprecated] Specifies the target of the link - it works like the target property of the HTML 'a' tag. Works only with items of type 'link'

emailSubject string

[Deprecated] Represents the subject of the email. Works only with item of type 'email'

actions action[]

Defines actions that can be applied on the group item

visible boolean | simpleBinding
mainIndicator object

Represents the main numeric indicator of the NumericData

5 nested properties
number string

The value of the main indicator

unit string

The unit of the main indicator

trend string

The trend indicator (direction)

One of: enum enum, simpleBinding string
state string

The state color of the main indicator

One of: Enums.ValueColor enum, simpleBinding string
size enum | simpleBinding

[Experimental] Multiple side indicators that relate to the main numeric indicator

maxItems=2
sideIndicatorsAlignment string

[Experimental] The alignment of the side indicators

One of: enum enum, simpleBinding string
template object

Template definition for the icons in the group

2 nested properties
icon object required

Definition for icons in the IconGroup

4 nested properties
src string

Represents icon name or source URL

text string

[Deprecated] Represents text that will be displayed in the icon

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

alt string

Represents text that will be displayed as a tooltip

actions action[]

Defines actions that can be applied on the icon

path string

[Experimental] Binding path to the icon data

size enum | simpleBinding

[Experimental] The size of the icons in an IconGroup

maxLines number | simpleBinding

Maximum number of lines

details string

Represents additional information about the numeric indicators

state string

Represents state of an entity

Default: "None"
Values: "Error" "Success" "Warning" "None" "Information"
showStateIcon boolean | simpleBinding

Defines if a default state icon is shown

customStateIcon string

The custom state icon

inverted boolean | simpleBinding

Specifies whether the background color reflects the set "state" instead of the control's text

id string

ID for input fields

selectedKey string

Defines the initially selected key from the given options for combo box or radio button group

selectedIndex number | simpleBinding

Defines the initially selected index for radio button group

placeholder string

Placeholder for items of type 'Input', 'TextArea', 'ComboBox', 'Duration' and 'DateRange'

rows number

Property rows for TextArea

item object

Binding info for combo box or radio button group items

2 nested properties
path string

Defines the path to the structure holding the data about the items

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
maxValue number | simpleBinding

The number of displayed symbols for RatingIndicator

visualMode enum | simpleBinding

Defines how float values are visualized for RatingIndicator: Full (values are rounded to the nearest integer value (e.g. 1.7 -> 2)) or Half (values are rounded to the nearest half value (e.g. 1.7 -> 1.5))

src string

Represents image source URL

fallbackSrc string

Represents fallback image source URL

alt string

The alternative text that is displayed in case the image is not available, or cannot be displayed

fullWidth boolean | simpleBinding

Defines if the image will take the full width of the group, including the paddings. If set to false there will be padding. For best result use together with 'alignment': 'Stretched' for the group

height string

The height of the image

imageFit string

This property is for adjusting the image size using the CSS style background-size

imagePosition string

This property is for adjusting the image position using the CSS style background-position

overlay object

Overlay on the Image

11 nested properties
supertitle string

The text before the title

title string

The title

subtitle string

The subtitle

subTitle string

The subtitle

verticalPosition string

The vertical alignment of the texts

horizontalPosition string

The horizontal alignment of the texts

padding string

Set to 'MediumStart' to have medium size padding in the beginning of the texts

textColor string

The color of the texts

textFilter string

The CSS filter which will be applied to the text

background string

The background behind the texts and over the image

animation string

Defines the animation that should be used to show up the overlay

ContentType.Object.Group object

Represents a group of information for an object

items ContentType.Object.Item[] required

Represents items of information

title string | string
titleMaxLines number | simpleBinding

[Experimental] Limits the number of lines for wrapping the group title

Default: 1
labelWrapping boolean | simpleBinding

[Experimental] Determines whether the labels of the group items will be wrapped

Default: false
visible boolean | simpleBinding
alignment enum

[Experimental] Alignment of the group

Default: "Default"
Values: "Default" "Stretch"
simpleIcon object

Represents simple icon attributes

src string

Represents icon name or source URL

visible boolean | simpleBinding
ContentType.Timeline.Item object

Represents a single timeline item

title object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
description object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
dateTime object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
owner object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
ownerImage

The owner image of the timeline item

1 nested properties
value string
icon object

Represents simple icon attributes

2 nested properties
src string

Represents icon name or source URL

visible boolean | simpleBinding
actions action[]

Defines actions that can be applied on the item level

ContentType.Analytical.Field object
type enum | simpleBinding

The type of the feed

uid string

The uid of the feed

values string[]

The names of the measures or dimensions that are used for this feed

ContentType.Analytical.Measure object

Measure for the dataset

name string

The name of the measure

label string

[Deprecated] Label for the measure

value string

Binding path to the data

ContentType.Analytical.Dimension object

Dimension for the dataset

name string

The name of the dimension

label string

[Deprecated] Label for the dimension

value string

Binding path to the data

displayValue string

Display value for the dimension. It doesn't work with 'waterfallType'

dataType string

Data type of the dimension as displayed in the chart. Currently only in time series chart, it is required to set data type to 'date' if this column is going to feed the 'timeAxis'

One of: enum enum, simpleBinding string
ContentType.Analytical.AxisText object

Represents descriptive text of the axis

visible boolean | simpleBinding
ContentType.Analytical.DataLabel object

Represents value attributes in the plot area

visible boolean | simpleBinding
showTotal boolean | simpleBinding
ContentType.Analytical.Legend object

[Deprecated] Represents chart legend attributes

visible boolean | simpleBinding
position string

Defines where the legend will be positioned

One of: enum enum, simpleBinding string
alignment string

Defines how the legend will be aligned

One of: enum enum, simpleBinding string
icon object

Represents icon attributes

src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

size enum | simpleBinding

[Experimental] The size of the icon

fitType enum | simpleBinding

Defines how the image fits in the icon area

backgroundColor enum | simpleBinding
visible boolean | simpleBinding
state string

Represents state of an entity

field object
label string | string
value string

The value of the field

visible boolean | simpleBinding
group object

Represents group of items

title string

The title of the group

order object

The order by which the group will be sorted

2 nested properties
path string

Defines the path to the structure holding the data about the group order

dir enum

The sorting direction in which the group items will be ordered

ContentType.List.Item object

The template for all items

title field | string

The title of the item

description field | string

The description of the item

info object

Represents value and state information for an object

9 nested properties
type string

Represents the type of the object

Values: "Status"
value string

The value of the field

The state of the field

showStateIcon boolean | simpleBinding

Defines if a default state icon is shown

customStateIcon string

The custom state icon

visible boolean | simpleBinding
title string

Title of the data point. This is just a placeholder to store the title, title will not be rendered on the screen. This is needed to prevent the loss of column names while transforming table card to list card

inverted boolean | simpleBinding

Specifies whether the background color reflects the set "state" instead of the control's text

actions action[]

Actions that can be applied on the status

highlight string

The highlight state of the item

One of: state string, simpleBinding string
highlightText string

Defines the semantics of the 'highlight' property. It is used for accessibility purposes

icon object

Represents icon attributes

9 nested properties
src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

size enum | simpleBinding

[Experimental] The size of the icon

fitType enum | simpleBinding

Defines how the image fits in the icon area

backgroundColor enum | simpleBinding
visible boolean | simpleBinding
attributesLayoutType enum | simpleBinding

Defines the layout type of the attributes

attributes objectStatus[]

Defines the attributes

actions action[]

Defines actions that can be applied on the item

[Experimental] Describes MicroChart attributes

Describes actions strip

minHeight string

Defines the min-height of the Content as a CSS value

HeaderType.InfoSection.Item objectStatus

Represents an info section item

HeaderType.InfoSection.Column object

Represents a column of the info section

Represents the rows of the column

Represents the items of the column

justifyContent string

Defines how the space is distributed between and around content items

objectStatus object

Represents value and state information for an object

type string

Represents the type of the object

Values: "Status"
value string

The value of the field

The state of the field

showStateIcon boolean | simpleBinding

Defines if a default state icon is shown

customStateIcon string

The custom state icon

visible boolean | simpleBinding
title string

Title of the data point. This is just a placeholder to store the title, title will not be rendered on the screen. This is needed to prevent the loss of column names while transforming table card to list card

inverted boolean | simpleBinding

Specifies whether the background color reflects the set "state" instead of the control's text

actions action[]

Actions that can be applied on the status

HeaderType.InfoSection.Row object

Represents a row of the info section

justifyContent string

Defines how the space is distributed between and around content items

One of: enum enum, simpleBinding string

Represents the columns of the row

Represents the items of the row

Enums.ValueColor enum
MicroChart MicroChart.Generic | MicroChart.Bullet | MicroChart.StackedBar

[Experimental] Describes MicroChart attributes

HeaderType.Numeric.SideIndicator object

Represents side indicator attributes which are used for additional information about the main indicator

title string

Represents a title of the side indicator

number string

Represents value of the side indicator

unit string

Represents unit of measurement of the side indicator

state string

The state color of the side indicator

One of: Enums.ValueColor enum, simpleBinding string
visible boolean | simpleBinding
HeaderType.Numeric.MainIndicator object

Represents the main numeric indicator of the header

number string

The value of the main indicator

unit string

The unit of the main indicator

trend string

The trend indicator (direction)

One of: enum enum, simpleBinding string
state string

The state color of the main indicator

One of: Enums.ValueColor enum, simpleBinding string
visible boolean | simpleBinding
HeaderType.InfoSection object

Represents the info section of the header

Represents the rows of the info section

wrappingType string

The wrapping type for texts

status object

Represents status attributes

text string | statusTextFormatter

Represents status text

visible boolean | simpleBinding
iconWithoutSize object

Represents icon attributes

src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

backgroundColor enum | simpleBinding
fitType enum | simpleBinding

Defines how the image fits in the icon area

Defines the state of the icon

visible boolean | simpleBinding
action object

Represents actions that can be applied on card elements

type string required

The type of the action

One of: enum enum, simpleBinding string
enabled boolean | simpleBinding

Represents the state of the action

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
url string

[Deprecated] Represents the URL that will be used as navigation target if no service is provided

parameters

Parameters passed to the navigation action handler

target string

[Deprecated] Specifies where to open the 'url', if it is provided

One of: target object, simpleBinding string
HeaderType.Numeric object

Represents header with numeric data

type string required

Represents the type of the header

Values: "Numeric"
title string | string
titleMaxLines number | simpleBinding

[Experimental] Limit the number of lines for the title

Default: 3
subtitle string | string
subTitle string | string
subtitleMaxLines number | simpleBinding

[Experimental] Limit the number of lines for the sub title

Default: 2
subTitleMaxLines number | simpleBinding

[Deprecated] Limit the number of lines for the sub title

Default: 2
actions action[]

Represents a description of the actions that can be applied on a part of a card

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

unitOfMeasurement string

Represents unit of measurement for the whole numeric header

mainIndicator object

Represents the main numeric indicator of the header

5 nested properties
number string

The value of the main indicator

unit string

The unit of the main indicator

trend string

The trend indicator (direction)

One of: enum enum, simpleBinding string
state string

The state color of the main indicator

One of: Enums.ValueColor enum, simpleBinding string
visible boolean | simpleBinding
sideIndicatorsAlignment string

The alignment of the side indicators

One of: enum enum, simpleBinding string
details string

Represents additional information about the numeric header

detailsMaxLines number | simpleBinding

[Experimental] Limit the number of lines for the details text

Default: 1

Multiple side indicators that relate to the main numeric indicator

maxItems=2
status object

Represents status attributes

2 nested properties
text string | statusTextFormatter

Represents status text

visible boolean | simpleBinding
closeButton object

[Experimental] Represents attributes of the Close button

1 nested properties
visible boolean | simpleBinding
wrappingType string

The wrapping type for texts

One of: enum enum, simpleBinding string
visible boolean | simpleBinding
infoSection object

Represents the info section of the header

1 nested properties

Represents the rows of the info section

[Experimental] Describes MicroChart attributes

HeaderType.Default object

Represents default header attributes

type string

Represents the type of the header

Values: "Default"
title string | string
titleMaxLines number | simpleBinding

[Experimental] Limit the number of lines for the title

Default: 3
subTitle string | string
subtitle string | string
subTitleMaxLines number | simpleBinding

[Deprecated] Limit the number of lines for the sub title

Default: 2
subtitleMaxLines number | simpleBinding

[Experimental] Limit the number of lines for the sub title

Default: 2
actions action[]

Represents a description of the actions that can be applied on a part of a card

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

icon object

Represents icon attributes

All of: variant, variant
9 nested properties
src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

backgroundColor enum | simpleBinding
fitType enum | simpleBinding

Defines how the image fits in the icon area

Defines the state of the icon

visible boolean | simpleBinding
status object

Represents status attributes

2 nested properties
text string | statusTextFormatter

Represents status text

visible boolean | simpleBinding
closeButton object

[Experimental] Represents attributes of the Close button

1 nested properties
visible boolean | simpleBinding
wrappingType string

The wrapping type for texts

One of: enum enum, simpleBinding string
visible boolean | simpleBinding
infoSection object

Represents the info section of the header

1 nested properties

Represents the rows of the info section

ContentType.WebPage object

WebPage content is used to embed HTML page

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

minHeight string

Defines the min-height of the Content as a CSS value

src string

URL of the web page to be embedded

sandbox string

Sandbox attribute of the iframe

allow string

Allow attribute of the iframe

allowFullscreen boolean | simpleBinding

AllowFullscreen attribute of the iframe

omitSandbox boolean | simpleBinding

If set to 'true' the 'sandbox' attribute will not be added to the iframe

ContentType.AdaptiveCard AdaptiveCard

Represents AdaptiveCard content

ContentType.Calendar object

The calendar card is used to display a schedule of a single entity (such as person, resource) for a selected time interval

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

item object

Describes each item

2 nested properties
template object

The template for all items

7 nested properties
startDate string

The start date of the item. The accepted date format is ISO 8601

endDate string

The end date of the item. The accepted date format is ISO 8601

title string

The title of the item

text string

The additional information of the item

icon object

Represents simple icon attributes

type enum | simpleBinding

The type of the item - one of the types defined in the legend

actions action[]

Defines actions that can be applied on the item

path string

Defines the path to the structure holding the data about the items

legendItem object

Describes each legendItem

2 nested properties
template object

The template for all legendItems

3 nested properties
category string

Defines which card component describes the legend item. Available categories: "calendar" (represented as square) or "appointment" (circle)

text string

The describing information of the item

type enum | simpleBinding

The type of the legend item corresponding with the described component

path string

Defines the path to the structure holding the data about the legendItems

specialDate object

Describes each specialDate

2 nested properties
template object

The template for all specialDates

3 nested properties
startDate string

The start date of the special date. The accepted date format is ISO 8601

endDate string

The end date of the special date. The accepted date format is ISO 8601

type enum | simpleBinding

The type of the special date - one of the types defined in the legend

path string

Defines the path to the structure holding the data about the specialDates

date string | simpleBinding

The initial date of the calendar which appointments are initially shown. The accepted date format is ISO 8601

maxItems number | simpleBinding

Represents number of items displayed

maxLegendItems number | simpleBinding

Represents number of legendItems displayed

noItemsText string | simpleBinding

The text shown when there are no items for the selected day

use12HourFormat boolean | simpleBinding

Displays the time for calendar appointments in either 12h or 24h formats. By default, time is displayed in 24h format

calendarWeekNumbering enum | simpleBinding

Set the first day of week based on one of the available options Default, ISO_8601, MiddleEastern, or WesternTraditional

moreItems object

Defines actions that can be applied on the button showing there are more items than the shown

1 nested properties
actions action[]

Represents an action that can be applied on he button showing there are more items than the shown

ContentType.Component object

Represents the configuration for a component card's content

minHeight string

Defines the min-height of the Content as a CSS value

ContentType.Object object

Represents object content attributes

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

Represents groups of information for an object

actions action[]

[Deprecated] Defines actions that can be applied on the content

hasData boolean | object | array | simpleBinding

Represents flag for no data

Default: true
ContentType.Table object

Represents table content attributes

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

row object

The template for all rows

4 nested properties

Defines the columns attributes

actions action[]

Defines actions that can be applied on the item

highlight string

The highlight state of the row

One of: state string, simpleBinding string
highlightText string

Defines the semantics of the 'highlight' property. It is used for accessibility purposes

maxItems number | simpleBinding

Represents number of items

minItems number | simpleBinding

Represents the minimum expected number of items

group object

Represents group of items

2 nested properties
title string

The title of the group

order object

The order by which the group will be sorted

2 nested properties
path string

Defines the path to the structure holding the data about the group order

dir enum

The sorting direction in which the group items will be ordered

ContentType.Timeline object

Represents time related content

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

item object

Represents a single timeline item

7 nested properties
title object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
description object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
dateTime object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
owner object
3 nested properties
label string | string
value string

The value of the field

visible boolean | simpleBinding
ownerImage

The owner image of the timeline item

1 nested properties
value string
icon object

Represents simple icon attributes

2 nested properties
src string

Represents icon name or source URL

visible boolean | simpleBinding
actions action[]

Defines actions that can be applied on the item level

maxItems number | simpleBinding

Represents number of items

minItems number | simpleBinding

Represents the minimum expected number of items

ContentType.AnalyticsCloud object

Represents SAP Analytics Cloud content attributes

ContentType.Analytical object

Represents analytical content attributes

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

chartType string

The type of the chart

One of: string string, simpleBinding string
chartProperties object | simpleBinding

[Experimental] Chart configuration

minHeight string

Defines the min-height of the Content as a CSS value

legend object

[Deprecated] Represents chart legend attributes

3 nested properties
visible boolean | simpleBinding
position string

Defines where the legend will be positioned

One of: enum enum, simpleBinding string
alignment string

Defines how the legend will be aligned

One of: enum enum, simpleBinding string
plotArea object

[Deprecated] Describes the plotArea properties

3 nested properties
dataLabel object

Represents value attributes in the plot area

2 nested properties
visible boolean | simpleBinding
showTotal boolean | simpleBinding
categoryAxisText object

Represents descriptive text of the axis

1 nested properties
visible boolean | simpleBinding
valueAxisText object

Represents descriptive text of the axis

1 nested properties
visible boolean | simpleBinding
title object

[Deprecated] Represents title attributes

3 nested properties
visible boolean | simpleBinding
text string

Represents a title text

alignment enum | simpleBinding

Represents the title alignment

measureAxis string

[Deprecated] Represents the value set for measure axis

dimensionAxis string

[Deprecated] Represents the value set for dimension axis

Feeds for the chart

actions action[]

Defines actions that can be applied on the content

actionableArea enum | simpleBinding
popover object

Configuration for a popover, which will open while pressing chart points

2 nested properties
active boolean | simpleBinding

Whether the popover is connected to the chart. If it's not it won't open

actionsStrip object[]

Defines actions items that can be triggered when the action button is pressed

maxItems=1
tooltips boolean | simpleBinding

Visualize the tooltips that are generated by Viz charts.

ContentType.List object

Represents list content attributes

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

item object

The template for all items

11 nested properties
title field | string

The title of the item

description field | string

The description of the item

info object

Represents value and state information for an object

9 nested properties
type string

Represents the type of the object

Values: "Status"
value string

The value of the field

The state of the field

showStateIcon boolean | simpleBinding

Defines if a default state icon is shown

customStateIcon string

The custom state icon

visible boolean | simpleBinding
title string

Title of the data point. This is just a placeholder to store the title, title will not be rendered on the screen. This is needed to prevent the loss of column names while transforming table card to list card

inverted boolean | simpleBinding

Specifies whether the background color reflects the set "state" instead of the control's text

actions action[]

Actions that can be applied on the status

highlight string

The highlight state of the item

One of: state string, simpleBinding string
highlightText string

Defines the semantics of the 'highlight' property. It is used for accessibility purposes

icon object

Represents icon attributes

9 nested properties
src string

Represents icon name or source URL

alt string

Alternative text for the icon

shape string

Represents the shape of the icon

One of: enum enum, simpleBinding string
text string

[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown

initials string

Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed

size enum | simpleBinding

[Experimental] The size of the icon

fitType enum | simpleBinding

Defines how the image fits in the icon area

backgroundColor enum | simpleBinding
visible boolean | simpleBinding
attributesLayoutType enum | simpleBinding

Defines the layout type of the attributes

attributes objectStatus[]

Defines the attributes

actions action[]

Defines actions that can be applied on the item

[Experimental] Describes MicroChart attributes

Describes actions strip

maxItems number | simpleBinding

Represents number of items

minItems number | simpleBinding

Represents the minimum expected number of items

group object

Represents group of items

2 nested properties
title string

The title of the group

order object

The order by which the group will be sorted

2 nested properties
path string

Defines the path to the structure holding the data about the group order

dir enum

The sorting direction in which the group items will be ordered

closeButton object

[Experimental] Represents attributes of the Close button

visible boolean | simpleBinding
visibility boolean | simpleBinding
actionsStrip object
item object

[Experimental] Binding info for items of type actionsStripItem

2 nested properties
template object

Attributes of actions strip item

10 nested properties
actions action[]

Action(s) which will be executed when button is pressed

type enum | simpleBinding

The type of the item

overflowPriority enum | simpleBinding

Defines items priority

icon string

The icon of the item

text string

The text of the item

tooltip string

The tooltip of the item

buttonType enum | simpleBinding

The type of the button

ariaHasPopup enum | simpleBinding

Use this property only when the item is related to a popover/popup

visible boolean | simpleBinding
preferIcon boolean | simpleBinding

Defines whether the button will shown icon only when placed in the visible area. This will save space in the actions strip. When in the overflow area, it will always show both icon and text

path string
actionsStripItem object

Attributes of actions strip item

actions action[]

Action(s) which will be executed when button is pressed

type enum | simpleBinding

The type of the item

overflowPriority enum | simpleBinding

Defines items priority

icon string

The icon of the item

text string

The text of the item

tooltip string

The tooltip of the item

buttonType enum | simpleBinding

The type of the button

ariaHasPopup enum | simpleBinding

Use this property only when the item is related to a popover/popup

visible boolean | simpleBinding
preferIcon boolean | simpleBinding

Defines whether the button will shown icon only when placed in the visible area. This will save space in the actions strip. When in the overflow area, it will always show both icon and text

HeaderType HeaderType.Default | HeaderType.Numeric
data object

Represents request and response attributes

request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

4 nested properties
maxAge number

The maximum age for which the cache is considered fresh

Default: 0
staleWhileRevalidate boolean

Should we show stale cache while revalidating

Default: false
noStore boolean

[Deprecated] Set to true to disable caching for this card

Default: false
enabled boolean

Set to false to disable caching for this card

Default: false
path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

Configuration.ChildCard object

Represents a configuration for a child card

manifest string required

The manifest of the child card

Configuration.NoData object

Represents a configuration for a NoData

title string

Title shown in the illustrated message of the card

description string

Description shown in the illustrated message of the card

size string

Defines the size predefined from sap.m.IllustratedMessage

type string

Defines the image predefined from sap.m.IllustratedMessage

Configuration.CSRFToken object

Represents a configuration for a CSRF token

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

Configuration.Destinations object

Represents a configuration for a cloud platform destination

name string

The name of the destination. Use the same name which is used in Cloud Platform

label string

Label for the destination for user-friendly visualization in the design-time editor

description string

Description of the destination for user-friendly visualization in the design-time editor

defaultUrl string

A default url which will be used if there is no Host associated with the card

Configuration.FilterType.ComboBox object

[Experimental] ComboBox filter

type const: "ComboBox" | simpleBinding

The type of the filter

value

The value of the filter

selectedKey string

Defines the initially selected key from the given options for combo box

selectedIndex number | simpleBinding

Specifies the index of the selected item. Index value for no selection is -1

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

label string

Label for the filter. Used by screen readers

placeholder string

The placeholder of the filter

item object
2 nested properties
template object required

A single Combo Box filter selection option

3 nested properties
title string

The title of the filter option

key string

The unique key of the filter option. Mapped to the filter's value

additionalText string

The secondary value for the combo box item

path string

Defines the path to the structure holding the data about the items

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
group object

Represents group of items

2 nested properties
title string

The title of the group

order object

The order by which the group will be sorted

2 nested properties
path string

Defines the path to the structure holding the data about the group order

dir enum

The sorting direction in which the group items will be ordered

visible boolean | simpleBinding
Configuration.FilterType.Search object

Search filter

type const: "Search" | simpleBinding

The type of the filter

label string

Label for the filter. Used by screen readers

value string

The value of the filter

placeholder string

The placeholder of the filter

visible boolean | simpleBinding
Configuration.FilterType.DateRange object

Date range filter

type const: "DateRange" | simpleBinding

The type of the filter

label string

Label for the filter. Used by screen readers

placeholder string

Placeholder for the filter's input

value object
2 nested properties
option string

The date range option

values array
options string[]

Options that will appear in the dropdown

visible boolean | simpleBinding
Configuration.FilterType.Select object

Select filter

type const: "Select" | simpleBinding

The type of the filter

value

The value of the filter

data object

Represents request and response attributes

8 nested properties
request object

Represents request attributes

10 nested properties
url string required

The URL to make the request to

mode string

The mode of the request

One of: enum enum, simpleBinding string
method string

The HTTP method

One of: enum enum, simpleBinding string
parameters object

Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request

headers object

Represents HTTP headers

retryAfter number | simpleBinding

Number of seconds before the request is retried if it failed the previous time

timeout number | simpleBinding

A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout

withCredentials boolean | simpleBinding

Indicates whether cross-site requests should be made using credentials

batch Record<string, object>

Map of requests to be batched

cache object

Cache control settings

path string

The path from the JSON to be used as root

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
json object | array

The data to be used directly. Without making requests

service object

Represents the definition of each service

2 nested properties
factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
updateInterval number | simpleBinding

Represents interval in seconds, after which a new data request will be triggered

extension object

[Experimental] Represents attributes, needed to get data via extension

2 nested properties
method string required

The method of the extension, which fetches data

args array

The arguments, with which the method will be called

name string

[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card

mockData object

[Experimental] Mock data attributes

3 nested properties
request object

Represents request attributes

json object | array

The data to be used directly. Without making requests

extension object

[Experimental] Represents attributes, needed to get data via extension

label string

Label for the filter. Used by screen readers

item object
2 nested properties
template object required

A single filter selection option

2 nested properties
title string

The title of the filter option

key string

The unique key of the filter option. Mapped to the filter's value

path string

Defines the path to the structure holding the data about the items

Default: "/"
pattern=^[a-zA-Z0-9_\.\-/|@#]*$
visible boolean | simpleBinding
Configuration.Parameter object

Represents configuration parameter

value

The value of the parameter

type string

Basic data types for parameters and filters

Values: "string" "integer" "number" "boolean" "date" "datetime"
label string

Label for the parameter for user-friendly visualization in the design-time editor

description string

Description of the parameter for user-friendly visualization in the design-time editor

simpleBinding string
definingRequest object
dataSource string required

Represents reference to dataSource under sap.app

path string required

Represents path to the title collection

retrieveStreams boolean

Represents indicator whether streams should be retrieved

Default: false
levelsDef array

Plot area is a parent property which defines multiple other properties for smoothness and marker size

resizableLayoutVariantCardProperties object

Represents the card properties is a layout variant

col integer required

Represents the grid column

row integer required

Represents the grid row

colSpan integer required

Represents the column span

rowSpan integer required

Represents the row span

visible boolean

Represents the visibility of the card

Default: true
customActionsSetting object

Represents the properties for the custom actions in the Quick View Cards

text string

Text displayed for extended actions in Quick View

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
press string

Name of the press handler for extended actions in Quick View

pattern=^[^\W\.\-][\w\.\-]*$
position integer

Position of extended actions in Quick View

timeAxisDef object

Represents the configuration to customize the time axis

levels array

Plot area is a parent property which defines multiple other properties for smoothness and marker size

plotAreaDef object

Plot area is a parent property which defines multiple other properties for smoothness and marker size

isSmoothed boolean

Represents whether smoother curves are required or not

Default: false
markerSize integer

Represents the size of the markers in scatter plots

dataLabel object

dataLabel is a parent property that defines other properties for type

1 nested properties
type string

Defines whether to display percentage values or actual counts in the donut chart

Default: "value"
Values: "value" "percentage"
objectStreamCardsSettingsDef object

Represents the Object Stream properties - properties that are passed to the Object Stream cards

showFirstActionInFooter boolean

Represents the flag to show first action in footer of the Quickview cards

Default: false
customActions customActionsSetting[]

Represents the custom actions in the Quick View Cards

minItems=1
defaultSpanDef object | string

Represents the card default grid size in columns and rows

tab_setting object

Represents the tab specific properties - properties that are passed to a particular tab in a card

annotationPath string

Represents the annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
selectionAnnotationPath string

Represents the selection annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
chartAnnotationPath string

Represents the chart annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
presentationAnnotationPath string

Represents the presentation annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
dataPointAnnotationPath string

Represents the data point annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
identificationAnnotationPath string

Represents the identification annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
dynamicSubtitleAnnotationPath string

Represents the dynamic subtitle annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
value string

Represents the drop down value to be shown

chartProperties object

This property is responsible for setting specific chart settings

2 nested properties
plotArea object

Plot area is a parent property which defines multiple other properties for smoothness and marker size

3 nested properties
isSmoothed boolean

Represents whether smoother curves are required or not

Default: false
markerSize integer

Represents the size of the markers in scatter plots

dataLabel object

dataLabel is a parent property that defines other properties for type

timeAxis object

Represents the configuration to customize the time axis

1 nested properties
levels array

Plot area is a parent property which defines multiple other properties for smoothness and marker size

colorPalette object[] | object

Represents the configuration to customize the column stacked chart

card_setting object

Represents the card specific properties - properties that are passed to the card

title string required

Represents language-dependent title of the card - used in the card header

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
category string

Represents the category of the card- used in the card header

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
itemText string

Represents the user defined string in placeholder card

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
subTitle string

Represents language-dependent subtitle of the card - used in the card header

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
showTimeAxis boolean

[Deprecated] Represents the flag to enable/disable time axis for analytical timeseries cards

Default: true
Any of: const: true const: true, const: false const: false
valueSelectionInfo string

Represents things like people, number of items

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
entitySet string

Represents the entity set that will be displayed in this card

pattern=^[a-zA-Z0-9_]+$
staticContent object[]

Represents the static content that will be displayed in this card

listFlavor string

Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard

Values: "standard" "bar" "carousel"
listType string

Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card

Values: "extended" "condensed"
sortBy string

Represents the sort key for the entity set

sortOrder string

Represents the sort order for the entity set

Values: "ascending" "descending"
annotationPath string

Represents the annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
selectionAnnotationPath string

Represents the selection annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
chartAnnotationPath string

Represents the chart annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
presentationAnnotationPath string

Represents the presentation annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
dataPointAnnotationPath string

Represents the data point annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
identificationAnnotationPath string

Represents the identification annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#,]*$
kpiAnnotationPath string

Represents the KPI annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
selectionPresentationAnnotationPath string

Represents the selection presentation annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
dynamicSubtitleAnnotationPath string

Represents the dynamic subtitle annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
ignoreSapText boolean

Represents the flag to indicate priority of number formatting over sap text

Default: false
enableAddToInsights boolean

Represents the flag to enable/disable individual card's functionality to add them to insight

Default: true
showRefresh boolean

Represents the flag to show/hide individual card's functionality to refresh the card

Default: true
defaultSpan object | string

Represents the card default grid size in columns and rows

requireAppAuthorization string

Represents the cards for which authorization is required

objectStreamCardsSettings object

Represents the Object Stream properties - properties that are passed to the Object Stream cards

2 nested properties
showFirstActionInFooter boolean

Represents the flag to show first action in footer of the Quickview cards

Default: false
customActions customActionsSetting[]

Represents the custom actions in the Quick View Cards

minItems=1
enableLocaleCurrencyFormatting boolean

Represents the flag to indicate the use of object number/smart field

Default: false
navigation string

Represents the configuration to alter the navigation mode in OVP Analytical Cards

Values: "dataPointNav" "chartNav" "headerNav" "noHeaderNav"
showFilterInHeader boolean

Represents a switch to Show or Hide Filters in Cards Headers in OVP application

Default: false
showSortingInHeader boolean

Represents a switch to Show or Hide Sorting in Cards Headers in OVP application

Default: false
imageSupported boolean

Flag for enabling images in a condensed list card

Default: false
showLineItemDetail boolean

Flag for show line item detail in list and table card

Default: false
showLabelText boolean

This property is responsible for showing and hiding text labels on the geo spots

Default: false
customParams string

This property is responsible for passing custom parameters present in the entity set to the navigating application

pattern=^[^\W\.\-][\w\.\-]*$
chartProperties object

This property is responsible for setting specific chart settings

2 nested properties
plotArea object

Plot area is a parent property which defines multiple other properties for smoothness and marker size

3 nested properties
isSmoothed boolean

Represents whether smoother curves are required or not

Default: false
markerSize integer

Represents the size of the markers in scatter plots

dataLabel object

dataLabel is a parent property that defines other properties for type

timeAxis object

Represents the configuration to customize the time axis

1 nested properties
levels array

Plot area is a parent property which defines multiple other properties for smoothness and marker size

colorPalette object[] | object

Represents the configuration to customize the column stacked chart

resizableLayoutVariant object

Represents the resizable layout variant

card object

Represents the card attributes

template string required

Represents the card component path to use for this card

pattern=^[a-zA-Z0-9\.]+$
sequencePos integer

Represents the position of the card in the sequence

model string

Represents the model for the card

pattern=^[a-zA-Z0-9_\.\-\|@]*$
settings object

Represents the card specific properties - properties that are passed to the card

37 nested properties
title string required

Represents language-dependent title of the card - used in the card header

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
category string

Represents the category of the card- used in the card header

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
itemText string

Represents the user defined string in placeholder card

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
subTitle string

Represents language-dependent subtitle of the card - used in the card header

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
showTimeAxis boolean

[Deprecated] Represents the flag to enable/disable time axis for analytical timeseries cards

Default: true
Any of: const: true const: true, const: false const: false
valueSelectionInfo string

Represents things like people, number of items

pattern=^\{\{[^\W\.\-][\w\.\-]*\}\}$
entitySet string

Represents the entity set that will be displayed in this card

pattern=^[a-zA-Z0-9_]+$
staticContent object[]

Represents the static content that will be displayed in this card

listFlavor string

Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard

Values: "standard" "bar" "carousel"
listType string

Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card

Values: "extended" "condensed"
sortBy string

Represents the sort key for the entity set

sortOrder string

Represents the sort order for the entity set

Values: "ascending" "descending"
annotationPath string

Represents the annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
selectionAnnotationPath string

Represents the selection annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
chartAnnotationPath string

Represents the chart annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
presentationAnnotationPath string

Represents the presentation annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
dataPointAnnotationPath string

Represents the data point annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
identificationAnnotationPath string

Represents the identification annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#,]*$
kpiAnnotationPath string

Represents the KPI annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
selectionPresentationAnnotationPath string

Represents the selection presentation annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
dynamicSubtitleAnnotationPath string

Represents the dynamic subtitle annotation path

pattern=^[a-zA-Z0-9_\.\-\|@#]*$
ignoreSapText boolean

Represents the flag to indicate priority of number formatting over sap text

Default: false
enableAddToInsights boolean

Represents the flag to enable/disable individual card's functionality to add them to insight

Default: true
showRefresh boolean

Represents the flag to show/hide individual card's functionality to refresh the card

Default: true
defaultSpan object | string

Represents the card default grid size in columns and rows

requireAppAuthorization string

Represents the cards for which authorization is required

objectStreamCardsSettings object

Represents the Object Stream properties - properties that are passed to the Object Stream cards

2 nested properties
showFirstActionInFooter boolean

Represents the flag to show first action in footer of the Quickview cards

Default: false
customActions customActionsSetting[]

Represents the custom actions in the Quick View Cards

minItems=1
enableLocaleCurrencyFormatting boolean

Represents the flag to indicate the use of object number/smart field

Default: false
navigation string

Represents the configuration to alter the navigation mode in OVP Analytical Cards

Values: "dataPointNav" "chartNav" "headerNav" "noHeaderNav"
showFilterInHeader boolean

Represents a switch to Show or Hide Filters in Cards Headers in OVP application

Default: false
showSortingInHeader boolean

Represents a switch to Show or Hide Sorting in Cards Headers in OVP application

Default: false
imageSupported boolean

Flag for enabling images in a condensed list card

Default: false
showLineItemDetail boolean

Flag for show line item detail in list and table card

Default: false
showLabelText boolean

This property is responsible for showing and hiding text labels on the geo spots

Default: false
customParams string

This property is responsible for passing custom parameters present in the entity set to the navigating application

pattern=^[^\W\.\-][\w\.\-]*$
chartProperties object

This property is responsible for setting specific chart settings

2 nested properties
plotArea object

Plot area is a parent property which defines multiple other properties for smoothness and marker size

timeAxis object

Represents the configuration to customize the time axis

colorPalette object[] | object

Represents the configuration to customize the column stacked chart

Represents the card with view switch control

minItems=1
filterFieldName object

Represents the configuration object for each date filter field

defaultValue object

Represents the configuration for setting default value for the date filter field

1 nested properties
operation string

Represents the default semantic date value to be set on the filter field

selectedValues string

Represents the semantic date values selected for the date filter field

customDateRangeImplementation string

Represents the custom implementation for semantic date filter field

exclude boolean

Flag to exclude values from the date picker

Default: false
refreshStrategies_prop_def object
entitySets object

Represents the map of entity sets configured for refresh strategies

displayFormatEnum string
defaultLayoutType_def string
implementingComponent_def object | object
routingSpec_def object
routeName string required

Represents the name of the route

noOData boolean

Represents the switch to indicate, that this route is not related to the OData service

binding string

Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute

headerTitle string

Represents the the title to be shown on the page

typeImageUrl string

Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page

noKey boolean

Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation

semanticKey string

Name of a semantic key field which can be used to identify an instance of this page. Only relevant if nKey is false.

navigation_def object

Represents ...

display object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
1 nested properties
entitySets object

Represents the map of entity sets configured for refresh strategies

create object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
1 nested properties
entitySets object

Represents the map of entity sets configured for refresh strategies

edit object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
1 nested properties
entitySets object

Represents the map of entity sets configured for refresh strategies

component_def object
name string required

The name of the component

pattern=^([a-zA-Z][a-zA-Z0-9]{0,39})(\.[a-zA-Z][a-zA-Z0-9]{0,39})*$
list boolean

Switch to create a route for a list (aggregation) if true and routing for an entity if not set or false

settings object

Represents the settings specific to one component

component_pages_def object
component_binding_def string

Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute

component_setting_def object

Represents the settings specific to one component

embeddedComponent object
action_prop_def object
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
1 nested properties
entitySets object

Represents the map of entity sets configured for refresh strategies

pages_map object
component object required
3 nested properties
name string required

The name of the component

pattern=^([a-zA-Z][a-zA-Z0-9]{0,39})(\.[a-zA-Z][a-zA-Z0-9]{0,39})*$
list boolean

Switch to create a route for a list (aggregation) if true and routing for an entity if not set or false

settings object

Represents the settings specific to one component

navigationProperty string

Represents the navigation property that leads to this page. The navigation links of the previous page (the page that calls this one) are determined through this property

entitySet string

Represents the entity set that defines either the aggregation or the root object of the component

navigation object

Represents ...

3 nested properties
display object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
create object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
edit object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
embeddedComponents object
routingSpec object
7 nested properties
routeName string required

Represents the name of the route

noOData boolean

Represents the switch to indicate, that this route is not related to the OData service

binding string

Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute

headerTitle string

Represents the the title to be shown on the page

typeImageUrl string

Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page

noKey boolean

Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation

semanticKey string

Name of a semantic key field which can be used to identify an instance of this page. Only relevant if nKey is false.

implementingComponent object | object
defaultLayoutType string
defaultLayoutTypeIfExternalNavigation string
pages object
pages_array object
component object required
3 nested properties
name string required

The name of the component

pattern=^([a-zA-Z][a-zA-Z0-9]{0,39})(\.[a-zA-Z][a-zA-Z0-9]{0,39})*$
list boolean

Switch to create a route for a list (aggregation) if true and routing for an entity if not set or false

settings object

Represents the settings specific to one component

navigationProperty string

Represents the navigation property that leads to this page. The navigation links of the previous page (the page that calls this one) are determined through this property

entitySet string

Represents the entity set that defines either the aggregation or the root object of the component

navigation object

Represents ...

3 nested properties
display object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
create object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
edit object
3 nested properties
path string required

Represents the path in the manifest to the target to which the navigation is bound

target string required

Represents the pointer to a semantic object

refreshStrategyOnAppRestore object
embeddedComponents object
routingSpec object
7 nested properties
routeName string required

Represents the name of the route

noOData boolean

Represents the switch to indicate, that this route is not related to the OData service

binding string

Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute

headerTitle string

Represents the the title to be shown on the page

typeImageUrl string

Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page

noKey boolean

Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation

semanticKey string

Name of a semantic key field which can be used to identify an instance of this page. Only relevant if nKey is false.

implementingComponent object | object
defaultLayoutType string
defaultLayoutTypeIfExternalNavigation string
setting_def object

Represents global settings for the application controller

routeTargetObject object

Represents the definition of a target of a route as object.

name string

Represents the name of the routing target

prefix string

The prefix of the routing target

propagateTitle boolean

Indicates whether this 'Component' target should propagate it's title to this component or not

Default: "#/$defs/routing/config/propagateTitle"
actualTargetAdditionComponentUsage object

Represents target configuration properties for component usage routing scenarios where targets reference reusable components

usage string required

Represents the componentUsage of the component that will be created

type string required

Represents the type of the type Component

Values: "Component"
id string

Represents the id of the created view or component

level number

Represents the level of the current component which is used to define the transition direction when navigate to this component

multipleOf=1
actualTargetAdditionStandard object

Represents the target configuration properties for modern routing implementations with view or component targets

name string required

Represents the name of a view or component that will be created

id string

Represents the id of the created view or component

path string

Represents a prefix that is prepended in front of the view or component name

type string

Represents the type of the target: View or Component

Values: "View" "Component"
level number

Represents the level of the current view/component which is used to define the transition direction when navigate to this view/component

multipleOf=1
legacyTargetAddition object

Represents legacy target configuration properties for backward compatibility with older routing implementations

viewName string required

[Deprecated] Represents the name of a view that will be created. Please use 'name' property instead together with the 'type' property set to 'View'. The same applies to 'viewId', 'viewPath', 'viewLevel' as well.

viewId string

[Deprecated] Represents the id of the created view. Please use 'id' property instead together with the 'type' property set to 'View'. The same applies to 'viewName', 'viewPath', 'viewLevel' as well.

viewPath string

[Deprecated] Represents a prefix that is prepended in front of the viewName. Please use 'path' property instead together with the 'type' property set to 'View'. The same applies to 'viewId', 'viewName', 'viewLevel' as well.

viewLevel number

[Deprecated] Represents the level of the current view which is used to define the transition direction when navigate to this view. Please use 'level' property instead together with the 'type' property set to 'View'. The same applies to 'viewId', 'viewName', 'viewPath' as well.

multipleOf=1
routeWithoutName object

Represents the definition of route without the option 'name'. This is used when routes are defined in an object.

pattern string

Represents the url pattern that the route is matched against

greedy boolean

Whether the route should be matched when another route is already matched

target string | routeTargetObject[] | string | routeTargetObject

Represents the definition of a target of a route.

titleTarget string

Represents the name of the target where the 'title' information should be taken

route

Represents the definition of each route

actualTargetAdditionStandardWithoutRequiredProp object
name string

Represents the name of a view or component that will be created

id string

Represents the id of the created view or component

path string

Represents a prefix that is prepended in front of the view or component name

type string

Represents the type of the type View or Component

Values: "View" "Component"
level number

Represents the level of the current view/component which is used to define the transition direction when navigate to this view/component

multipleOf=1
legacyTargetAdditionWithoutRequiredProp object

Represents legacy target configuration properties without required properties for more flexible backward compatibility scenarios

viewName string

[Deprecated] Represents the name of a view that will be created. Please use 'name' property instead together with the 'type' property set to 'View'. The same applies to 'viewId', 'viewPath', 'viewLevel' as well.

viewId string

[Deprecated] Represents the id of the created view. Please use 'id' property instead together with the 'type' property set to 'View'. The same applies to 'viewName', 'viewPath', 'viewLevel' as well.

viewPath string

[Deprecated] Represents a prefix that is prepended in front of the viewName. Please use 'path' property instead together with the 'type' property set to 'View'. The same applies to 'viewId', 'viewName', 'viewLevel' as well.

viewLevel number

[Deprecated] Represents the level of the current view which is used to define the transition direction when navigate to this view. Please use 'level' property instead together with the 'type' property set to 'View'. The same applies to 'viewId', 'viewName', 'viewPath' as well.

multipleOf=1
target object

Represents the definition of each target

title string

Represents the information which is included as a parameter of the 'titleChanged' event fired on Router when this target is displayed. The title can be set with static text and can also be set with a valid property binding syntax which will be resolved under the scope of the view in the target where the title property is defined.

viewType string

Represents the type of view that is going to be created

One of: const: "XML" const: "XML", const: "JSON" const: "JSON", const: "JS" const: "JS", const: "HTML" const: "HTML", const: "Template" const: "Template"
targetParent string

Represents the id of the view that contains the control specified by the 'controlId'

controlId string

Represents the id of the control where you want to place the view created by the target

controlAggregation string

Represents the name of an aggregation of the controlId that contains the views

clearControlAggregation boolean

Whether the aggregation of the control should be cleared before adding the view

parent string

Represents the name of another target which will also be displayed once this target is displayed

transition string | string

Represents the type of transition when navigating from previous view to this view

transitionParameters object

Represents the transition parameters that are passed to the event handlers

routeTarget string | routeTargetObject[] | string | routeTargetObject

Represents the definition of a target of a route.

viewTypeDefinition string

Represents the type of view that is going to be created

ui5setting object

Represents UI5-specific settings and configuration options that can be applied to models.

defaultBindingMode string

Represents default binding mode and must be a string value from sap.ui.model.BindingMode. Possible values: Default, OneTime, OneWay, TwoWay

Default: "Default"
Values: "Default" "OneTime" "OneWay" "TwoWay"
bundleName string

Represents the alternative for bundleUrl

bundleUrl string

Represents the URL for the resource bundle

bundleUrlRelativeTo string

Indicates whether url is relative to component (default) or manifest

Default: "component"
Values: "manifest" "component"
fallbackLocale string

Represents the fallback locale

supportedLocales array

Represents the list of supported locales

terminologies object

Represents terminologies with additional properties files

enhanceWith object[]

Represents enhancement of UI5 resource model with additional properties files

rootView_def string | object

Represents the root view definition being either the name of the view or the view definition object

routing object

Represents the configuration of routing

config

Represents the default properties defined for route and target

routes route[] | object
targets object

Represents the definition of targets

rootView_def_flexEnabled object

Represents the root view definition when flex is enabled (requires a view id)

viewName string required

Represents the name of the view

id string required

Represents the id of the view

type string

Represents the type of view that is going to be created

One of: const: "XML" const: "XML", const: "JSON" const: "JSON", const: "JS" const: "JS", const: "HTML" const: "HTML", const: "Template" const: "Template"
async boolean

Configure the targets for asynchronous loading

Default: false
One of: const: true const: true, const: false const: false
routing_flexEnabled object

Represents the configuration of routing

config

Represents the default properties defined for route and target

routes route[] | object
targets object

Represents the definition of targets

command object

Represents a UI5 shortcut command.

shortcut string

A string describing a shortcut key combination that, when used by the user, will trigger the command.

pattern=^(([Cc][Tt][Rr][Ll]|[Ss][Hh][Ii][Ff][Tt]|[Aa][Ll][Tt])(\+)?){0,3}([A-Za-z0-9\.,\-\*\/=]|[Pp][Ll][Uu][Ss]|[Tt][Aa][Bb]|[Ss][Pp][Aa][Cc][Ee]|[Ee][Nn][Tt][Ee][Rr]|[Bb][Aa][Cc][Kk][Ss][Pp][Aa][Cc][Ee]|[Hh][Oo][Mm][Ee]|[Dd][Ee][Ll][Ee][Tt][Ee]|[Ee][Nn][Dd]|[Pp][Aa][Gg][Ee][Uu][Pp]|[Pp][Aa][Gg][Ee][Dd][Oo][Ww][Nn]|[Ee][Ss][Cc][Aa][Pp][Ee]|[Aa][Rr][Rr][Oo][Ww][Uu][Pp]|[Aa][Rr][Rr][Oo][Ww][Dd][Oo][Ww][Nn]|[Aa][Rr][Rr][Oo][Ww][Ll][Ee][Ff][Tt]|[Aa][Rr][Rr][Oo][Ww][Rr][Ii][Gg][Hh][Tt]|F[1-9]|F1[0-2])$
ref string

A string referencing a predefined shortcut command. Must start with 'sap:'.

pattern=^sap:[a-zA-Z0-9_-]+$
description string

A string containing a placeholder that follows the format {{someKey}}.

pattern=^\{\{[a-zA-Z0-9_]+\}\}$
booleanOrString boolean | string
enhanceWithSetting_0 object | object
terminologySetting object | object
service object

Represents the definition of each service

factoryName string required

Represents the name of the service factory

pattern=^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
optional boolean

Indicates whether the service optional or not

Default: false
version string
id_def_0 string
config config[] | string | boolean | number | object
resourceRoot string

Represents the resource root path relative to the application root. Used to define custom resource paths for loading modules and resources

model object

Represents sapui5 model name

type string

Represents model class name

dataSource string

Represents string of key/alias from sap.app dataSources to reference an existing data source

uri string

Represents URI for the model

preload boolean

Indicates that the model will be immediately created after the manifest is loaded by Component Factory and before the Component instance is created

Default: false
settings object

Represents UI5-specific settings and configuration options that can be applied to models.

8 nested properties
defaultBindingMode string

Represents default binding mode and must be a string value from sap.ui.model.BindingMode. Possible values: Default, OneTime, OneWay, TwoWay

Default: "Default"
Values: "Default" "OneTime" "OneWay" "TwoWay"
bundleName string

Represents the alternative for bundleUrl

bundleUrl string

Represents the URL for the resource bundle

bundleUrlRelativeTo string

Indicates whether url is relative to component (default) or manifest

Default: "component"
Values: "manifest" "component"
fallbackLocale string

Represents the fallback locale

supportedLocales array

Represents the list of supported locales

terminologies object

Represents terminologies with additional properties files

enhanceWith object[]

Represents enhancement of UI5 resource model with additional properties files

component object

Represents sapui5 component name

minVersion string
lazy boolean

Represents Indicator to lazy loading component

Default: false
lib object

Represents sapui5 library name

minVersion string
lazy boolean

Represents Indicator to lazy loading lib

Default: false
minUI5Version string | string[]
componentUsages object

Represents component name for usage

name string required

Represents name of reuse component

pattern=^([a-zA-Z_$][a-zA-Z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$
componentData config[] | string | boolean | number | object
settings config[] | string | boolean | number | object
lazy boolean

Represents Indicator to lazy loading component usage, default true

Default: true
resource object

Represents additional resources that need to be loaded for the component

js object[]

[Deprecated] Specifies additional JavaScript resources of the Component. Since 1.94, the usage of JavaScript resources is deprecated. Please use regular dependencies via 'sap.ui.define()' or 'sap.ui.require()' instead.

css object[]

Specifies additional CSS resources of the Component.

deviceType_0 object

Represents device types on which the app is running

desktop boolean

Represents indicator whether desktop device is supported, default true

tablet boolean

Represents indicator whether tablet device is supported, default true

phone boolean

Represents indicator whether phone device is supported, default true

signature_def object

Represents signature for inbound targets

parameters object required
additionalParameters string required

Indicates how additional parameters to the declared signature are treated: ('ignored': parameters are not passed on to application | 'allowed': parameters are passed on to application | 'notallowed': additional parameters are not allowed)

Values: "ignored" "allowed" "notallowed"
deviceType object

Represents device types on which the app is running

desktop boolean

Represents indicator whether desktop device is supported

tablet boolean

Represents indicator whether tablet device is supported

phone boolean

Represents indicator whether phone device is supported

objectType string
objectName string
dataSourceCustom object
uri string required

Represents the uri of the data source, should always be given in lower case

customType boolean required

Represents a custom data source type flag. So the type can be any string if its true, and only enum values if false

Values: true
type string

Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON, FHIR, WebSocket, http

pattern=^[a-zA-Z0-9_\-]+$
settings object
6 nested properties
odataVersion string

Represents version of OData: 2.0 is default

Values: "2.0" "4.0" "4.01"
localUri string

Represents path to local meta data document or annotation uri

annotations string[]

Represents array of annotation which references an existing data source of type ODataAnnotation

maxAge number

Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field

multipleOf=1
objects Record<string, object>

Dictionary of (catalog) objects offered by the datasource

ignoreAnnotationsFromMetadata boolean

Indicates whether annotations from metadata should be ignored

dataSourceEnum object
uri string required

Represents uri of the data source

type string

Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON, FHIR, WebSocket, http

Default: "OData"
Values: "OData" "ODataAnnotation" "INA" "XML" "JSON" "FHIR" "WebSocket" "http"
settings object
6 nested properties
odataVersion string

Represents version of OData: 2.0 is default

Values: "2.0" "4.0" "4.01"
localUri string

Represents path to local meta data document or annotation uri

annotations string[]

Represents array of annotation which references an existing data source of type ODataAnnotation

maxAge number

Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field

multipleOf=1
objects Record<string, object>

Dictionary of (catalog) objects offered by the datasource

ignoreAnnotationsFromMetadata boolean

Indicates whether annotations from metadata should be ignored

customType boolean
Values: false
setting object
odataVersion string

Represents version of OData: 2.0 is default

Values: "2.0" "4.0" "4.01"
localUri string

Represents path to local meta data document or annotation uri

annotations string[]

Represents array of annotation which references an existing data source of type ODataAnnotation

maxAge number

Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field

multipleOf=1
objects Record<string, object>

Dictionary of (catalog) objects offered by the datasource

ignoreAnnotationsFromMetadata boolean

Indicates whether annotations from metadata should be ignored

outbound object
inbound object
openSource object
name string required

Represents a name of the open source as appears on the web

version string

Represents a version of the open source (if part of app, version must be specified, if part of UI5 dist layer, version is empty)

packagedWithMySelf boolean

Indicates, whether it is part of the app or not

dataSource dataSourceEnum | dataSourceCustom
tag i18n_key_string[]
enhanceWithSetting object | object
id_def string