Cosmoplat

COSMOPlat IoT Platform OpenAPI

The 物联开发平台 (IoT development platform) API published by COSMOPlat as the "OpenApi-线上" reference. Twenty-six documented operations across product management, device management, alarm rules, alarm records, rule chains, thing-model (telemetry profile) management, time-series telemetry, attribute data and device RPC. The reference publishes paths, methods, query/body parameters and response field tables, but does not publish a base URL or an authentication scheme.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.cosmoplat.com/help/detail/304/1012
📖
APIReference
https://www.cosmoplat.com/help/detail/304/1038

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cosmoplat/refs/heads/main/openapi/cosmoplat-iot-platform-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/cosmoplat/refs/heads/main/overlays/cosmoplat-iot-platform-overlay.yaml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/cosmoplat/refs/heads/main/errors/cosmoplat-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/cosmoplat/refs/heads/main/data-model/cosmoplat-data-model.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/cosmoplat/refs/heads/main/apis.yml

OpenAPI Specification

cosmoplat-iot-platform-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: COSMOPlat IoT Platform OpenAPI
  version: 线上 (online)
  summary: Device, product, alarm, rule-chain, thing-model, telemetry and RPC operations for the COSMOPlat
    (Kaos) industrial IoT platform.
  description: "Machine-readable transcription of the COSMOPlat 物联开发平台 (IoT development platform) \"OpenApi-线上\"\
    \ reference published by COSMOPlat at https://www.cosmoplat.com/help/detail/304/1038\n\nThe provider\
    \ publishes this contract as an HTML reference table only — no OpenAPI, Swagger, Postman or other\
    \ machine-readable artifact is served anywhere on cosmoplat.com. This document transcribes that reference\
    \ so it can be read by a machine.\n\nGAPS THE PROVIDER HAS NOT PUBLISHED (deliberately left empty\
    \ here rather than guessed):\n  * No base URL / server host is stated anywhere in the reference, so\
    \ `servers` is omitted.\n  * No authentication scheme is documented for these operations, so `securitySchemes`\
    \ is empty.\n  * No per-operation 4xx/5xx catalogue is published; the single documented failure envelope\
    \ from 公共分类 › 状态码描述 is wired as the `default` response.\n"
  contact:
    name: COSMOPlat
    email: market@cosmoplat.com
    url: https://www.cosmoplat.com/help
  x-provenance:
    authored_by: API Evangelist (catalog-authored)
    method: generated
    source: https://www.cosmoplat.com/help/detail/304/1038
    generated: '2026-08-11'
    note: Transcribed field-for-field from the provider's published HTML API reference. COSMOPlat does
      not publish an OpenAPI document; this is not a provider artifact. Re-harvest and replace verbatim
      if COSMOPlat ever serves one.
externalDocs:
  description: COSMOPlat IoT platform documentation
  url: https://www.cosmoplat.com/help/detail/304/1012
tags:
- name: Product Management
- name: Device Management
- name: Alarm Rules
- name: Alarm Records
- name: Rule Chains
- name: Thing Model (Telemetry Profile)
- name: Time-series Data
- name: Attribute Data
- name: Device RPC
paths:
  /pageTbProductManage:
    get:
      operationId: getPageTbProductManage
      summary: 分页查询产品信息
      tags:
      - Product Management
      parameters:
      - name: page
        in: query
        required: true
        schema:
          type: string
        description: 页数（从0开始）
        example: '0'
      - name: pageSize
        in: query
        required: true
        schema:
          type: string
        description: 每页最大数量
        example: '30'
      - name: identifier
        in: query
        required: false
        schema:
          type: string
        description: 产品标识
      - name: textSearch
        in: query
        required: false
        schema:
          type: string
        description: 产品名称
      - name: strNodeType
        in: query
        required: false
        schema:
          type: string
        description: 节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：TB_PRODUCT_MANAGE
                            id:
                              type: string
                              description: 产品ID
                          description: 产品ID
                        createdTime:
                          type: number
                          description: 创建时间
                        tenantId:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值-TENANT
                            id:
                              type: string
                              description: 租户ID
                          description: 租户
                        name:
                          type: string
                          description: 产品名称
                        description:
                          type: string
                          description: 产品描述
                        image:
                          type: string
                          description: 图片
                        type:
                          type: string
                          description: 类型
                        transportType:
                          type: string
                          description: 传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
                        defaultRuleChainId:
                          type: string
                          description: 规则链ID
                        nodeType:
                          type: string
                          description: 节点类型，DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
                        tbSupplierName:
                          type: string
                          description: 生产厂商
                        identifier:
                          type: string
                          description: 产品标识
                        productModel:
                          type: string
                          description: 产品型号
                    description: 业务数据
                  totalPages:
                    type: number
                    description: 总页数
                  totalElements:
                    type: number
                    description: 总条数
                  hasNext:
                    type: boolean
                    description: 是否存在下一条记录
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 分页查询产品信息
        url: https://www.cosmoplat.com/help/detail/304/1038
  /tbProductManage:
    post:
      operationId: postTbProductManage
      summary: 创建产品
      tags:
      - Product Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 产品名称
                nodeType:
                  type: string
                  description: 节点类型：DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
                defaultRuleChainId:
                  type: object
                  properties:
                    id:
                      type: string
                      description: 规则链ID
                    entityType:
                      type: string
                      description: 类型：固定值-RULE_CHAIN
                  required:
                  - id
                  - entityType
                transportType:
                  type: string
                  description: 传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
              required:
              - name
              - nodeType
              - defaultRuleChainId
              - transportType
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: object
                    properties:
                      entityType:
                        type: string
                      id:
                        type: string
                    description: 产品ID
                  createdTime:
                    type: number
                    description: 创建时间
                  tenantId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：TENANT
                      id:
                        type: string
                        description: 租户ID
                    description: 租户
                  name:
                    type: string
                    description: 名称
                  description:
                    type: string
                    description: 描述
                  image:
                    type: string
                    description: 图片
                  type:
                    type: string
                    description: 类型
                  transportType:
                    type: string
                    description: 传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
                  defaultRuleChainId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：RULE_CHAIN
                      id:
                        type: string
                        description: 规则链ID
                    description: 规则链ID
                  nodeType:
                    type: string
                    description: 节点类型：DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
                  tbSupplierName:
                    type: string
                    description: 生产厂商
                  identifier:
                    type: string
                    description: 产品标识
                  productModel:
                    type: string
                    description: 产品型号
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 创建产品
        url: https://www.cosmoplat.com/help/detail/304/1038
  /tbProductManage/{tbProductManageId}:
    delete:
      operationId: deleteTbProductManageByTbProductManageId
      summary: 删除产品
      tags:
      - Product Management
      description: 成功httpCode返回200
      parameters:
      - name: tbProductManageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 成功 / Success
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 删除产品
        url: https://www.cosmoplat.com/help/detail/304/1038
    get:
      operationId: getTbProductManageByTbProductManageId
      summary: 查询产品详情
      tags:
      - Product Management
      parameters:
      - name: tbProductManageId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: object
                    properties:
                      entityType:
                        type: string
                      id:
                        type: string
                    description: 产品ID
                  createdTime:
                    type: number
                    description: 创建时间
                  tenantId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：TENANT
                      id:
                        type: string
                        description: 租户ID
                    description: 租户
                  name:
                    type: string
                    description: 名称
                  description:
                    type: string
                    description: 描述
                  image:
                    type: string
                    description: 图片
                  type:
                    type: string
                    description: 类型
                  transportType:
                    type: string
                    description: 传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
                  defaultRuleChainId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：RULE_CHAIN
                      id:
                        type: string
                        description: 规则链ID
                    description: 规则链
                  nodeType:
                    type: string
                    description: 节点类型：DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
                  tbSupplierName:
                    type: string
                    description: 生产厂商
                  identifier:
                    type: string
                    description: 产品标识
                  productModel:
                    type: string
                    description: 产品型号
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 查询产品详情
        url: https://www.cosmoplat.com/help/detail/304/1038
  /tenant/devicesnew:
    get:
      operationId: getTenantDevicesnew
      summary: 分页查询设备信息
      tags:
      - Device Management
      parameters:
      - name: page
        in: query
        required: true
        schema:
          type: string
        description: 页数（从0开始）
      - name: pageSize
        in: query
        required: true
        schema:
          type: string
        description: 每页最大数量
      - name: productManageId
        in: query
        required: false
        schema:
          type: string
        description: 产品配置id
      - name: name
        in: query
        required: false
        schema:
          type: string
        description: 设备标识
      - name: realName
        in: query
        required: false
        schema:
          type: string
        description: 设备名称
      - name: nodeType
        in: query
        required: false
        schema:
          type: string
        description: 节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
      - name: active
        in: query
        required: false
        schema:
          type: string
        description: 设备状态true在线false离线
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：DEVICE
                            id:
                              type: string
                              description: 设备ID
                          description: 设备ID
                        createdTime:
                          type: number
                          description: 创建时间
                        tenantId:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：TENANT
                            id:
                              type: string
                              description: 租户ID
                          description: 租户
                        name:
                          type: string
                          description: 设备标识
                        realName:
                          type: string
                          description: 设备名称
                        productManageId:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：TB_PRODUCT_MANAGE
                            id:
                              type: string
                              description: 产品ID
                          description: 产品
                        description:
                          type: string
                          description: 描述
                        image:
                          type: string
                          description: 图片
                        active:
                          type: boolean
                          description: 设备状态true在线false离线
                        nodeType:
                          type: string
                          description: 节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
                        credentialsType:
                          type: string
                          description: 凭据类型：ACCESS_TOKEN，X509_CERTIFICATE，MQTT_BASIC，LWM2M_CREDENTIALS
                        lastActivityTime:
                          type: number
                          description: 最近在线时间
                        deviceCredentialsId:
                          type: string
                          description: 访问令牌
                    description: 业务数据
                  totalPages:
                    type: number
                    description: 总页数
                  totalElements:
                    type: number
                    description: 总条数
                  hasNext:
                    type: boolean
                    description: 是否存在下一条记录
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 分页查询设备信息
        url: https://www.cosmoplat.com/help/detail/304/1038
  /device:
    post:
      operationId: postDevice
      summary: 创建设备
      tags:
      - Device Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                realName:
                  type: string
                  description: 设备名称
                productManageId:
                  type: object
                  properties:
                    id:
                      type: string
                      description: 产品ID
                    entityType:
                      type: string
                      description: 固定值：TB_PRODUCT_MANAGE
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: object
                    properties:
                      entityType:
                        type: string
                      id:
                        type: string
                        description: 设备ID
                    description: 设备ID
                  createdTime:
                    type: number
                    description: 创建时间
                  tenantId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：TENANT
                      id:
                        type: string
                        description: 租户ID
                    description: 租户
                  name:
                    type: string
                    description: 设备标识
                  realName:
                    type: string
                    description: 设备名称
                  productManageId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：TB_PRODUCT_MANAGE
                      id:
                        type: string
                        description: 产品ID
                    description: 产品
                  description:
                    type: string
                    description: 设备描述
                  image:
                    type: string
                    description: 图片
                  active:
                    type: string
                    description: 设备状态true在线false离线
                  lat:
                    type: string
                    description: 纬度
                  lon:
                    type: string
                    description: 经度
                  address:
                    type: string
                    description: 详细地址
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 创建设备
        url: https://www.cosmoplat.com/help/detail/304/1038
  /device/{deviceId}:
    delete:
      operationId: deleteDeviceByDeviceId
      summary: 删除设备
      tags:
      - Device Management
      description: 成功httpCode返回200
      parameters:
      - name: deviceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 成功 / Success
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 删除设备
        url: https://www.cosmoplat.com/help/detail/304/1038
  /device/info/{deviceId}:
    get:
      operationId: getDeviceInfoByDeviceId
      summary: 获取设备详情
      tags:
      - Device Management
      parameters:
      - name: deviceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：DEVICE
                      id:
                        type: string
                        description: 设备ID
                    description: 设备ID
                  createdTime:
                    type: number
                    description: 创建时间
                  tenantId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：TENANT
                      id:
                        type: string
                        description: 租户ID
                    description: 租户
                  name:
                    type: string
                    description: 设备标识
                  realName:
                    type: string
                    description: 设备名称
                  type:
                    type: string
                    description: 所属产品名称
                  productManageId:
                    type: object
                    properties:
                      entityType:
                        type: string
                        description: 固定值：TB_PRODUCT_MANAGE
                      id:
                        type: string
                        description: 产品ID
                    description: 产品
                  description:
                    type: string
                    description: 设备描述
                  image:
                    type: string
                    description: 图片
                  active:
                    type: boolean
                    description: 设备状态true在线false离线
                  lat:
                    type: string
                    description: 纬度
                  lon:
                    type: string
                    description: 经度
                  address:
                    type: string
                    description: 详细地址
                  nodeType:
                    type: string
                    description: 节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
                  credentialsType:
                    type: string
                    description: 凭据类型：ACCESS_TOKEN，X509_CERTIFICATE，MQTT_BASIC，LWM2M_CREDENTIALS
                  lastActivityTime:
                    type: number
                    description: 最近在线时间
                  deviceCredentialsId:
                    type: string
                    description: 访问令牌
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 获取设备详情
        url: https://www.cosmoplat.com/help/detail/304/1038
  /alarm/setting/page:
    post:
      operationId: postAlarmSettingPage
      summary: 分页查询告警规则
      tags:
      - Alarm Rules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  type: number
                  description: 页数
                pageSize:
                  type: number
                  description: 页大小
                deviceProductId:
                  type: string
                  description: 产品id
                title:
                  type: string
                  description: 名称
                deviceId:
                  type: string
                  description: 设备Id
              required:
              - deviceProductId
              - title
              - deviceId
      responses:
        '200':
          description: 业务数据 / Business payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：ALARM_SETTING
                            id:
                              type: string
                              description: 告警规则ID
                          description: 告警规则ID
                        createdTime:
                          type: number
                          description: 创建时间
                        tenantId:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：TENANT
                            id:
                              type: string
                              description: 租户ID
                          description: 租户
                        title:
                          type: string
                          description: 名称
                        deviceProductId:
                          type: object
                          properties:
                            entityType:
                              type: string
                              description: 固定值：TB_PRODUCT_MANAGE
                            id:
                              type: string
                              description: 产品ID
                          description: 产品ID
                        description:
                          type: string
                          description: 告警规则描述
                        status:
                          type: number
                          description: 状态：1-启用，0-禁用
                        updatedTime:
                          type: number
                          description: 更新时间
                        alarmData:
                          type: string
                          description: 告警规则信息
                        deviceProductName:
                          type: string
                          description: 产品名称
                        name:
                          type: string
                          description: 名称
                    description: 业务数据
                  totalPages:
                    type: number
                    description: 总页数
                  totalElements:
                    type: number
                    description: 总记录数
                  hasNext:
                    type: boolean
                    description: 是否有下一条记录
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 分页查询告警规则
        url: https://www.cosmoplat.com/help/detail/304/1038
  /alarm/setting:
    post:
      operationId: postAlarmSetting
      summary: 创建告警规则
      tags:
      - Alarm Rules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 报警规则名称
                deviceProductId:
                  type: string
                  description: 产品
                description:
                  type: string
                  description: 报警规则描述
                alarmData:
                  type: string
                  description: 报警规则详情
      responses:
        '200':
          description: 成功 / Success
        default:
          description: 失败响应 / Failure envelope documented in 公共分类 › 状态码描述
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      externalDocs:
        description: 创建告�

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cosmoplat/refs/heads/main/openapi/cosmoplat-iot-platform-openapi.yml