openapi: 3.1.1
info:
title: Nortech Asset Me API
version: 1.0.0
contact:
name: Nortech AI
url: https://nortech.ai
email: support@nortech.ai
summary: HTTP API for Nortech AI. Contact Nortech AI support for access.
description: "This API is structured between three main API groups:\n* **Metadata API** - To navigate and get information about your assets.\n* **Signal Data API** - To query all signal data produced from your assets.\n* **Deriver API** - To create and manage derivers that produce computed signals.\n\n# Pagination\nAll `List` Endpoints support cursor pagination. In this pagination model, the client receives a `next.token` field in the response, \nwhich can be used as a `nextToken` query parameter to fetch the next page of results. \nThe `size` parameter defines the maximum number of results to return, the `sortBy` and `sortOrder` parameters define the field to sort by and its order."
x-logo:
url: https://branding-api.apps.nor.tech/logo-light
backgroundColor: '#fafafa'
altText: Nortech AI
href: https://nortech.ai
servers:
- url: https://api.apps.nor.tech
description: HTTP API for Nortech AI
security:
- Bearer Token: []
tags:
- name: Me
paths:
/api/me:
get:
operationId: me
summary: Get current user
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
username:
type: string
customerId:
type: number
customerName:
type: string
roles:
type: array
items:
type: string
required:
- username
- customerId
- customerName
- roles
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
status:
const: Unauthorized
required:
- status
tags:
- Me
components:
securitySchemes:
Bearer Token:
type: http
scheme: bearer
bearerFormat: JWT
x-tagGroups:
- name: Metadata API v1
tags:
- Workspace
- Asset
- Division
- Unit
- Signal
- name: Signal Data API v1
tags:
- Historical Data
- Live Data
- MQTT Live Data
- Import Data
- name: Deriver API v1
tags:
- Deriver