Component description

The api-card-inline component creates a row of cards that serve as easy navigation to objects on data markets (configurable via pages).

Example

Minimal JSON

{
  "type": "api-card-inline",
  "api": "",
  "targetComponentId": "",
  "nameAttribute": ""
}
{
  "type": "api-card-inline",
  "api": "api/mr-object/recommendations/customizable-overview-filter",
  "headerTitle": "template.recommendation-api-card.header",
  "headerClaim": "template.recommendation-api-card.claim",
  "noDataText": "no_data",
  "targetComponentId": "market.centerArea.api-card.target",
  "onClickOpens": "newWindow",
  "nameAttribute": "objectName",
  "leftData": {
    "type": "relationTypeKey",
    "value": "has_dietary_category"
  },
  "rightData": {
    "type": "userRelationTypeKey",
    "value": "recipe_owner"
  },
  "filter": {
    "applicationKey": {
      "value": "app"
    },
    "objectTypeKey": {
      "value": "recipe"
    }
  }
}

Nested properties

PropertyDescriptionValuesMandatory
typeapi-card-inlinestringYes
apiAbsolute or relative URL of an API. See Supported APIs.string*Yes
nameAttributeName of the card displayed as the first row. Supported values are for example: spaceName, applicationName, objectName, dashboardName, #shortDescriptionstringYes
targetComponentIdID of the target component (e.g., an API card) which will receive search or filter data.stringYes
componentIdUnique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component's position within the layout (template).stringNo
filterConditions used to limit or refine data selection. For more information, see filter.jsonNo
headerClaimTranslation key of the section subtitle.stringNo
headerTitleTranslation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section. Used as section title.stringNo
leftDataKey and type of the property (relation or user relation type) shown in the bottom left of the card.jsonNo
noDataIconKeyKey of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset. Icon is used when no data is found.stringNo
noDataTextKey of the translation displayed when no data is found.stringNo
objectPathKeyObject or application path. Supported value is: pathNames: Use to add object path to the card.stringNo
onClickOpensAction when a card is clicked. Supported values are: link: Opens the specified link., newWindow: Opens the asset in a new window., rightPanelDetail: Opens the object in a right panel.string in (“link”, “newWindow”, “rightPanelDetail”)No
rightDataKey and type of the property (relation or user relation type) shown in the bottom left of the card.jsonNo

* Supported APIs

APIDescription
api/dashboard/spacesReturns info about all spaces.
api/dashboard/applicationsReturns info about all applications.
api/dashboard/dashboard/{parentPageEnumKey}Returns info about all dashboards.
api/dashboard/favouritesReturns info about objects that user has in “favorites”.
api/dashboard/recommendedReturns info about objects that are recommended for a user.
api/dashboard/recentReturns info about objects that user has recently viewed.
api/dashboard/filtered-objectReturns objects based on filter.
api/dashboard/filtered-root-objectReturns objects based on filter.