---
title: "获取UNS定义"
method: GET
path: "/inter-api/supos/uns/def/{uns}"
tags: ["supos/uns/system", "suposUnsSystem"]
---

# 获取UNS定义

`GET /inter-api/supos/uns/def/{uns}`

## Path parameters

- `uns` string, required

## Response `200`

A successful response.

- object
  - `code` integer
  - `data` CreateTopicDto
    - `accessLevel` string — Access level
    - `addDashBoard` boolean
    - `addFlow` boolean
    - `alarmRuleDefine` object — AlarmRuleDefine type
    - `alias` string, required
    - `batch` integer
    - `compileExpression` object
    - `countExistsSiblings` integer
    - `createAt` integer
    - `createTemplate` boolean
    - `dataPath` string
    - `dataSrcID` integer
    - `dataType` string — Data type and fields
    - `description` string
    - `displayName` string
    - `expression` string
    - `extend` object — Extended fields
    - `extendFieldUsed` string[]
    - `fieldDefines` FieldDefines
      - `CalcField` FieldDefine
        - `decimal` string
        - `displayName` string
        - `inc` boolean
        - `index` string
        - `lastTime` integer
        - `lastValue` string
        - `lowerLimit` number, double
        - `maxLen` string
        - `name` string, required
        - `remark` string
        - `systemField` boolean
        - `tbValueName` string
        - `type` string, required
        - `unique` boolean
        - `unit` string
        - `uns` object
        - `upperLimit` number, double
      - `FieldIndexMap` object — Index -> Field name
      - `FieldsMap` object — Field name -> FieldDefine
      - `UniqueKeys` object — Set of unique field names
    - `fields` FieldDefine[]
      - `decimal` string
      - `displayName` string
      - `inc` boolean
      - `index` string
      - `lastTime` integer
      - `lastValue` string
      - `lowerLimit` number, double
      - `maxLen` string
      - `name` string, required
      - `remark` string
      - `systemField` boolean
      - `tbValueName` string
      - `type` string, required
      - `unique` boolean
      - `unit` string
      - `uns` object
      - `upperLimit` number, double
    - `fieldsChanged` boolean
    - `flagNo` string
    - `frequency` string — Frequency for merge type
    - `frequencySeconds` integer
    - `hasBlobField` boolean
    - `id` string
    - `index` integer
    - `initValue` object
    - `jsonFields` FieldDefine[] — jsonb 预定义字段，存在protocol
      - `decimal` string
      - `displayName` string
      - `inc` boolean
      - `index` string
      - `lastTime` integer
      - `lastValue` string
      - `lowerLimit` number, double
      - `maxLen` string
      - `name` string, required
      - `remark` string
      - `systemField` boolean
      - `tbValueName` string
      - `type` string, required
      - `unique` boolean
      - `unit` string
      - `uns` object
      - `upperLimit` number, double
    - `labelIDs` object
    - `labelNames` string[]
    - `layRec` string
    - `modelAlias` string
    - `modelId` string
    - `mountSource` string
    - `mountType` string — Mount fields
    - `name` string, required
    - `order` integer
    - `parentAlias` string
    - `parentDataType` string
    - `parentId` string
    - `path` string
    - `pathType` integer, required
    - `primaryField` string[]
    - `protocol` object
    - `protocolBean` object
    - `protocolType` string
    - `refFields` FieldDefine[]
      - `decimal` string
      - `displayName` string
      - `inc` boolean
      - `index` string
      - `lastTime` integer
      - `lastValue` string
      - `lowerLimit` number, double
      - `maxLen` string
      - `name` string, required
      - `remark` string
      - `systemField` boolean
      - `tbValueName` string
      - `type` string, required
      - `unique` boolean
      - `unit` string
      - `uns` object
      - `upperLimit` number, double
    - `refSource` string — Pride specific fields
    - `refTopicFields` object
    - `refUns` object
    - `referIds` integer[]
    - `referModelId` string
    - `referTable` string
    - `referUns` string — Reference fields
    - `refers` InstanceField[] — Calculation fields
      - `alias` string, required
      - `field` string, required
      - `id` integer, required
      - `path` string, required
      - `uts` boolean, required
    - `retainTableWhenDeleteInstance` boolean
    - `save2db` boolean
    - `status` integer
    - `strMaxLen` integer
    - `streamOptions` StreamOptions
    - `subscribeEnable` boolean
    - `tableName` string — Table fields
    - `tbFieldName` string
    - `template` CreateTopicDto — recursive
    - `timestamps` object
    - `tmField` string — Internal fields
    - `updateAt` integer — Update metadata
    - `valueType` string
    - `withFlags` integer — Flags and options
  - `msg` string

---

[API](https://skmtc.net/freezonex/apis/untitled-api.md) · [All operations](https://skmtc.net/freezonex/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/freezonex/untitled-api/versions/1837fd35a283/schema)