2024-08-27 14:41:12 +05:30

1.8 KiB

title slug
createDashboardDataModel /main-concepts/metadata-standard/schemas/api/data/createdashboarddatamodel

CreateDashboardDataModelRequest

Create Dashboard Data Model entity request.

Properties

  • name: Name that identifies this data model. Refer to ../../type/basic.json#/definitions/entityName.
  • displayName (string): Display Name that identifies this data model. It could be title or label from the source services.
  • description: Description of the data model instance. What it has and how to use it. Refer to ../../type/basic.json#/definitions/markdown.
  • tags (array): Tags for this data model. Default: None.
    • Items: Refer to ../../type/tagLabel.json.
  • owner: Owner of this data model. Refer to ../../type/entityReference.json.
  • service: Link to the data model service where this data model is hosted in. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • serviceType: Service type where this data model is hosted in. Refer to ../../entity/services/dashboardService.json#/definitions/dashboardServiceType.
  • dataModelType: Refer to ../../entity/data/dashboardDataModel.json#/definitions/dataModelType.
  • sql: In case the Data Model is based on a SQL query. Refer to ../../type/basic.json#/definitions/sqlQuery. Default: None.
  • columns (array): Columns from the data model. Default: None.
    • Items: Refer to ../../entity/data/table.json#/definitions/column.
  • project (string): Name of the project / workspace / collection in which the dataModel is contained.
  • domain (string): Fully qualified name of the domain the Dashboard Data Model belongs to.
  • lifeCycle: Life Cycle of the entity. Refer to ../../type/lifeCycle.json.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.