본문으로 건너뛰기

SemanticTableResponse

Data returned for Semantic Table. Required fields are id, name, category, item.

idId (string)필수

Server-assigned unique identifier

nameName (string)필수

Resource name

alias object

Display name shown to users.

하나 이상(anyOf)
string
categoryCategory (string)필수

Resource type tag

typeType (string)

Query target used by this semantic table.

Possible values: [clickhouse, postgres, oracle, odata_v2, odata_v4]

기본값: clickhouse
collection_id object

Parent collection ID

하나 이상(anyOf)
string
folder_id object

Identifier of the containing folder.

하나 이상(anyOf)
string
tags object

Classification labels

하나 이상(anyOf)
  • Array [
  • string
  • ]
  • description object

    Resource description

    하나 이상(anyOf)
    string
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    기본값: []
    created_at object

    Creation timestamp (Unix ms)

    하나 이상(anyOf)
    integer
    updated_at object

    Last update timestamp (Unix ms)

    하나 이상(anyOf)
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
  • idId (string)필수

    "user." | "group." | "public.all"

    typeType (string)필수

    Possible values: [user, group, public]

    display_nameDisplay Name (string)필수
    avatar_url object
    하나 이상(anyOf)
    string
    avatar_config object
    하나 이상(anyOf)
    object
    email object
    하나 이상(anyOf)
    string<email>
  • ]
  • my_share_scope object

    How the current caller received access to the resource.

    하나 이상(anyOf)
    string

    Possible values: [owner, grant, admin]

    connector object

    Data connector name resolved at execution

    하나 이상(anyOf)
    string
    commentsstring[]
    instructionsstring[]
    columns object[]
  • Array [
  • nameName (string)필수

    Physical column name, unless a computed expression in options.sql.expr replaces it for supported SQL targets.

    kindKind (string)

    Semantic column kind: categorical or time.

    Possible values: [categorical, time]

    기본값: categorical
    data_type object
    하나 이상(anyOf)
    nameName (string)필수

    Arrow type name, e.g. 'int64', 'utf8', 'decimal'

    unit object
    하나 이상(anyOf)
    string

    Possible values: [s, ms, us, ns]

    timezone object
    하나 이상(anyOf)
    string
    precision object
    하나 이상(anyOf)
    integer

    Possible values: >= 1 and <= 76

    scale object
    하나 이상(anyOf)
    integer

    Possible values: >= 0

    label object
    하나 이상(anyOf)
    string
    description object

    Human-readable explanation of the column.

    하나 이상(anyOf)
    string
    filterableFilterable (boolean)

    Whether the column can be used in filter conditions.

    기본값: true
    sortableSortable (boolean)

    Whether the column can be used for result ordering.

    기본값: true
    groupableGroupable (boolean)

    Whether the column can be selected or used for grouping.

    기본값: true
    visibleVisible (boolean)

    Whether the column is exposed in the semantic catalog. Hidden columns remain available to authored filters and templates.

    기본값: true
    synonymsstring[]

    Alternative terms that may refer to the column.

    valuesstring[]

    Exhaustive values for a low-cardinality column. Omitted from semantic catalog output when dictionary is set.

    samplesstring[]

    Illustrative, non-exhaustive example values. Omitted from semantic catalog output when dictionary is set.

    dictionary object

    Dictionary used to resolve canonical values and surface-form synonyms.

    하나 이상(anyOf)
    builtin object
    하나 이상(anyOf)
    object
    external object
    하나 이상(anyOf)
    string
    defaultDefault
    options object

    Target-specific column bindings, including an optional computed SQL expression.

    하나 이상(anyOf)
    object
  • ]
  • metrics object[]
  • Array [
  • nameName (string)필수
    typeType (string)필수

    Possible values: [simple, ratio, derived, cumulative, conversion]

    data_type object
    하나 이상(anyOf)
    nameName (string)필수

    Arrow type name, e.g. 'int64', 'utf8', 'decimal'

    unit object
    하나 이상(anyOf)
    string

    Possible values: [s, ms, us, ns]

    timezone object
    하나 이상(anyOf)
    string
    precision object
    하나 이상(anyOf)
    integer

    Possible values: >= 1 and <= 76

    scale object
    하나 이상(anyOf)
    integer

    Possible values: >= 0

    label object
    하나 이상(anyOf)
    string
    description object
    하나 이상(anyOf)
    string
    synonymsstring[]
    sortableSortable (boolean)
    기본값: true
    visibleVisible (boolean)
    기본값: true
    options object
    하나 이상(anyOf)
    object
    agg object
    하나 이상(anyOf)
    string

    Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

    expr object
    하나 이상(anyOf)
    string
    percentile object
    하나 이상(anyOf)
    number
    clauses object[]
  • Array [
  • columnColumn (string)필수

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    opOp (string)필수
    valueValue
    granularity object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

  • ]
  • window object
    하나 이상(anyOf)
    string
    grain_to_date object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

    numerator object
    하나 이상(anyOf)
    aggAgg (string)필수

    Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

    expr object
    하나 이상(anyOf)
    string
    percentile object
    하나 이상(anyOf)
    number
    clauses object[]
  • Array [
  • columnColumn (string)필수

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    opOp (string)필수
    valueValue
    granularity object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

  • ]
  • denominator object
    하나 이상(anyOf)
    aggAgg (string)필수

    Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

    expr object
    하나 이상(anyOf)
    string
    percentile object
    하나 이상(anyOf)
    number
    clauses object[]
  • Array [
  • columnColumn (string)필수

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    opOp (string)필수
    valueValue
    granularity object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

  • ]
  • base object
    하나 이상(anyOf)
    aggAgg (string)필수

    Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

    expr object
    하나 이상(anyOf)
    string
    percentile object
    하나 이상(anyOf)
    number
    clauses object[]
  • Array [
  • columnColumn (string)필수

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    opOp (string)필수
    valueValue
    granularity object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

  • ]
  • conversion object
    하나 이상(anyOf)
    aggAgg (string)필수

    Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

    expr object
    하나 이상(anyOf)
    string
    percentile object
    하나 이상(anyOf)
    number
    clauses object[]
  • Array [
  • columnColumn (string)필수

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    opOp (string)필수
    valueValue
    granularity object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

  • ]
  • entity object
    하나 이상(anyOf)
    string
    metrics object[]
  • Array [
  • nameName (string)필수
    alias object
    하나 이상(anyOf)
    string
    offset_window object
    하나 이상(anyOf)
    string
  • ]
  • ]
  • filters object[]
  • Array [
  • nameName (string)필수
    clauses object[]필수
  • Array [
  • columnColumn (string)필수

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    opOp (string)필수
    valueValue
    granularity object
    하나 이상(anyOf)
    string

    Possible values: [minute, hour, day, week, month, quarter, year]

  • ]
  • label object
    하나 이상(anyOf)
    string
    description object
    하나 이상(anyOf)
    string
    synonymsstring[]
    visibleVisible (boolean)
    기본값: true
  • ]
  • links object[]
  • Array [
  • categoryCategory (string)필수

    Allowed values: semantic.table, semantic.ontology.

    Possible values: [semantic.table, semantic.ontology]

    idId (string)필수

    Target resource id

    name object

    Entity name inside the target (ontology only)

    하나 이상(anyOf)
    string
  • ]
  • options object
    하나 이상(anyOf)
    object
    itemItem (string)필수사용 중단
    SemanticTableResponse
    {
    "id": "string",
    "name": "string",
    "alias": "string",
    "category": "string",
    "type": "clickhouse",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "markings": [
    "string"
    ],
    "created_at": 0,
    "updated_at": 0,
    "owners": [
    {
    "id": "string",
    "type": "user",
    "display_name": "string",
    "avatar_url": "string",
    "avatar_config": {},
    "email": "user@example.com"
    }
    ],
    "my_share_scope": "owner",
    "connector": "string",
    "comments": [
    "string"
    ],
    "instructions": [
    "string"
    ],
    "columns": [
    {
    "name": "string",
    "kind": "categorical",
    "data_type": {
    "name": "string",
    "unit": "s",
    "timezone": "string",
    "precision": 0,
    "scale": 0
    },
    "label": "string",
    "description": "string",
    "filterable": true,
    "sortable": true,
    "groupable": true,
    "visible": true,
    "synonyms": [
    "string"
    ],
    "values": [
    "string"
    ],
    "samples": [
    "string"
    ],
    "dictionary": {
    "builtin": {},
    "external": "string"
    },
    "options": {}
    }
    ],
    "metrics": [
    {
    "name": "string",
    "type": "simple",
    "data_type": {
    "name": "string",
    "unit": "s",
    "timezone": "string",
    "precision": 0,
    "scale": 0
    },
    "label": "string",
    "description": "string",
    "synonyms": [
    "string"
    ],
    "sortable": true,
    "visible": true,
    "options": {},
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
    {
    "column": "string",
    "op": "string",
    "granularity": "minute"
    }
    ],
    "window": "string",
    "grain_to_date": "minute",
    "numerator": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
    {
    "column": "string",
    "op": "string",
    "granularity": "minute"
    }
    ]
    },
    "denominator": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
    {
    "column": "string",
    "op": "string",
    "granularity": "minute"
    }
    ]
    },
    "base": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
    {
    "column": "string",
    "op": "string",
    "granularity": "minute"
    }
    ]
    },
    "conversion": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
    {
    "column": "string",
    "op": "string",
    "granularity": "minute"
    }
    ]
    },
    "entity": "string",
    "metrics": [
    {
    "name": "string",
    "alias": "string",
    "offset_window": "string"
    }
    ]
    }
    ],
    "filters": [
    {
    "name": "string",
    "clauses": [
    {
    "column": "string",
    "op": "string",
    "granularity": "minute"
    }
    ],
    "label": "string",
    "description": "string",
    "synonyms": [
    "string"
    ],
    "visible": true
    }
    ],
    "links": [
    {
    "category": "semantic.table",
    "id": "string",
    "name": "string"
    }
    ],
    "options": {}
    }