Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
    Generate Logical Data Model
      Generate logical data model (LDM) from physical data model (PDM)post
    LDM - Declarative APIs
    Datasets
    Attributes
    Facts
    Labels
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Generate Logical Data Model (3.51)

Endpoint:/

Generate logical data model (LDM) from physical data model (PDM)

POST
/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel

Generate logical data model (LDM) from physical data model (PDM) stored in data source.

Generate logical data model (LDM) from physical data model (PDM) › path Parameters

  • dataSourceIdstring · required

Generate logical data model (LDM) from physical data model (PDM) › Request Body

  • aggregatedFactPrefixstring

    Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of separator parameter. Given the aggregated fact prefix is aggr and separator is __, the columns with name like aggr__sum__product__sold will be considered as aggregated sold fact in the product table with SUM aggregate function.

    Example: aggr
  • dateGranularitiesstring

    Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is all which enables all available date granularities, including time granularities (like hours, minutes).

    Example: all
  • dateReferencePrefixstring

    Columns starting with this prefix will be considered as references to date dataset. The prefix is then followed by the value of separator parameter. Given the reference prefix is d and separator is __, the columns with name like d__date will be considered as reference to date dataset. There can be also second separator and granularity suffix, e.g. d__date__day to create attribute reference to exact date dataset and granularity.

    Example: d
  • denormPrefixstring

    Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of separator parameter. Given the denormalization reference prefix is dr and separator is __, the columns with name like dr__customer_name will be considered as denormalization references.

    Example: dr
  • factPrefixstring

    Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of separator parameter. Given the fact prefix is f and separator is __, the columns with name like f__sold will be considered as facts.

    Example: f
  • generateLongIdsboolean

    A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of <table>.<column> is used. If the flag is set to true, then all ids will be generated in the long form.

    Default: false
  • grainMultivalueReferencePrefixstring

    Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of separator parameter. Given the reference prefix is grmr and separator is __, the columns with name like grmr__customer__customer_id will be considered as grain multivalue references to customer_id in customer table.

    Example: grmr
  • grainPrefixstring

    Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of separator parameter. Given the grain prefix is gr and separator is __, the columns with name like gr__name will be considered as grains.

    Example: gr
  • grainReferencePrefixstring

    Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of separator parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is grr and separator is __, the columns with name like grr__customer__customer_id will be considered as grain references to customer_id in customer table.

    Example: grr
  • multivalueReferencePrefixstring

    Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of separator parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is mr and separator is __, the columns with name like mr__customer__customer_id will be considered as multivalue references to customer_id in customer table.

    Example: mr
  • pdmobject

    PDM additions wrapper.

  • primaryLabelPrefixstring

    Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of separator parameter. Given the primary label prefix is pl and separator is __, the columns with name like pl__country_id will be considered as primary labels.

    Example: pl
  • referencePrefixstring

    Columns starting with this prefix will be considered as references. The prefix is then followed by the value of separator parameter. Given the reference prefix is r and separator is __, the columns with name like r__customer__customer_id will be considered as references to customer_id in customer table.

    Example: r
  • secondaryLabelPrefixstring

    Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of separator parameter. Given the secondary label prefix is ls and separator is __, the columns with name like ls__country_id__country_name will be considered as secondary labels.

    Example: ls
  • separatorstring

    A separator between prefixes and the names. Default is "__".

    Default: __
  • translationPrefixstring

    Columns starting with this prefix will be considered as secondary label translation. The prefix is then followed by the value of separator parameter. Given the translation prefix is tr and separator is __, the columns with name like tr__attribute__label__en-US will be considered as secondary label en-US translation to label label in attribute attribute.

    Example: tr
  • wdfPrefixstring

    Column serving as workspace data filter. No labels are auto generated for such columns.

    Default: wdf
  • workspaceIdstring

    Optional workspace id.

  • tablePrefixstring · deprecated · required

    Tables starting with this prefix will be included. The prefix is then followed by the value of separator parameter. Given the table prefix is out_table and separator is __, the table with name like out_table__customers will be scanned.

    Example: out_table
  • viewPrefixstring · deprecated · required

    Views starting with this prefix will be included. The prefix is then followed by the value of separator parameter. Given the view prefix is out_view and separator is __, the table with name like out_view__us_customers will be scanned.

    Example: out_view

Generate logical data model (LDM) from physical data model (PDM) › Responses

LDM generated successfully.

  • ldmobject

    A logical data model (LDM) representation.

POST /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel

TranslationsLDM - Declarative APIs