{ "openapi": "3.1.1", "info": { "title": "BAUERGROUP.HardwareIDAllocator.API | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api.hardware-id.app.0047-20.cloud.bauer-group.com/" } ], "paths": { "/api/v1/auth/whoami": { "get": { "tags": [ "AuthEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhoAmIResponse" } } } } } } }, "/api/v1/unit-types": { "get": { "tags": [ "UnitTypeEndpoints" ], "parameters": [ { "name": "role", "in": "query", "schema": { "$ref": "#/components/schemas/UnitTypeRole" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitTypeDto" } } } } } } }, "post": { "tags": [ "UnitTypeEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUnitTypeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTypeDto" } } } } } } }, "/api/v1/unit-types/{id}": { "get": { "tags": [ "UnitTypeEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTypeDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "UnitTypeEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTypeDto" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "UnitTypeEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/v1/contract-manufacturers": { "get": { "tags": [ "ContractManufacturerEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractManufacturerDto" } } } } } } }, "post": { "tags": [ "ContractManufacturerEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContractManufacturerRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractManufacturerDto" } } } } } } }, "/api/v1/contract-manufacturers/{id}": { "get": { "tags": [ "ContractManufacturerEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractManufacturerDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "ContractManufacturerEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContractManufacturerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractManufacturerDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/tokens": { "get": { "tags": [ "TokenEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenDto" } } } } } } }, "post": { "tags": [ "TokenEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTokenRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenCreatedDto" } } } } } } }, "/api/v1/tokens/{id}": { "get": { "tags": [ "TokenEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/tokens/{id}/revoke": { "post": { "tags": [ "TokenEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/v1/tokens/{id}/rotate": { "post": { "tags": [ "TokenEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenCreatedDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/audit": { "get": { "tags": [ "AuditEndpoints" ], "parameters": [ { "name": "class", "in": "query", "schema": { "type": "string" } }, { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "actorId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/dashboard": { "get": { "tags": [ "DashboardEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardDto" } } } } } } }, "/api/v1/admin/backup": { "get": { "tags": [ "AdminEndpoints" ], "parameters": [ { "name": "compress", "in": "query", "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/restore": { "post": { "tags": [ "AdminEndpoints" ], "parameters": [ { "name": "mode", "in": "query", "schema": { "default": "replace", "$ref": "#/components/schemas/RestoreMode" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreResult" } } } } } } }, "/api/v1/mac/namespaces": { "get": { "tags": [ "MacEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MacNamespaceDto" } } } } } } }, "post": { "tags": [ "MacEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMacNamespaceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacNamespaceDto" } } } } } } }, "/api/v1/mac/namespaces/{code}": { "get": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacNamespaceDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMacNamespaceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacNamespaceDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/blocks": { "get": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MacBlockDto" } } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMacBlockRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacBlockDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/blocks/{blockByte}": { "patch": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockByte", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMacBlockRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacBlockDto" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockByte", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/issue": { "post": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacIssueResponse" } } } } } } }, "/api/v1/mac/namespaces/{code}/values": { "get": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "issuedFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "issuedTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacSearchPage" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/values/{value}": { "get": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacValueDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMacValueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/values/{value}/confirm-burnt": { "post": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/values/{value}/retire": { "post": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/values/{value}/release": { "post": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/mac/namespaces/{code}/values/{value}/block": { "post": { "tags": [ "MacEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MacValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/usb-pid/namespaces": { "get": { "tags": [ "UsbPidEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UsbVidDto" } } } } } } }, "post": { "tags": [ "UsbPidEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsbVidRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbVidDto" } } } } } } }, "/api/v1/usb-pid/namespaces/{code}": { "get": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbVidDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUsbVidRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbVidDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/usb-pid/namespaces/{code}/issue": { "post": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidIssueResponse" } } } } } } }, "/api/v1/usb-pid/namespaces/{code}/values": { "get": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "deviceClass", "in": "query", "schema": { "type": "string" } }, { "name": "issuedFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "issuedTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidSearchPage" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/usb-pid/namespaces/{code}/values/{value}": { "get": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidValueDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUsbPidRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/usb-pid/namespaces/{code}/values/{value}/block": { "post": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/usb-pid/namespaces/{code}/values/{value}/release": { "post": { "tags": [ "UsbPidEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsbPidValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces": { "get": { "tags": [ "ImeiEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImeiTacDto" } } } } } } }, "post": { "tags": [ "ImeiEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImeiTacRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiTacDto" } } } } } } }, "/api/v1/imei/namespaces/{code}": { "get": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiTacDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateImeiTacRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiTacDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces/{code}/issue": { "post": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiIssueResponse" } } } } } } }, "/api/v1/imei/namespaces/{code}/values": { "get": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "issuedFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "issuedTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiSearchPage" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces/{code}/values/{value}": { "get": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces/{code}/values/{value}/confirm-burnt": { "post": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces/{code}/values/{value}/retire": { "post": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces/{code}/values/{value}/release": { "post": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/imei/namespaces/{code}/values/{value}/block": { "post": { "tags": [ "ImeiEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImeiValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/units/namespaces": { "get": { "tags": [ "UnitsEndpoints" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitSchemeDto" } } } } } } }, "post": { "tags": [ "UnitsEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUnitSchemeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSchemeDto" } } } } } } }, "/api/v1/units/namespaces/{code}": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSchemeDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitSchemeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSchemeDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/units/namespaces/{code}/seed": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoolSeedResult" } } } } } } }, "/api/v1/units/namespaces/{code}/issue": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitIssueResponse" } } } } } } }, "/api/v1/units/namespaces/{code}/reserve": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveResponse" } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitValueDto" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/confirm-reservation": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/release-reservation": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/replace": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResponse" } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}/confirm-burnt": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/retire": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/release": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/block": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/metadata": { "patch": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "schema": { "$ref": "#/components/schemas/MetadataPatchMode" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchMetadataResponse" } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}/compliance": { "patch": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchComplianceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchMetadataResponse" } } } } } }, "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceView" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/units/namespaces/{code}/values": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/IdentifierStatus" } }, { "name": "issuedFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "issuedTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "metadataContains", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SerialSearchPage" } } } } } } }, "/api/v1/units/namespaces/{code}/bulk-issue": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIssueResult" } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}/links": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDto" } } } } } } }, "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLinkRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkDto" } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}/links/{linkId}": { "delete": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/v1/units/namespaces/{code}/values/{value}/assemble": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssembleRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssemblyDto" } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}/bom": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeRemoved", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BomNode" } } } } } } } }, "/api/v1/units/namespaces/{code}/values/{value}/parents": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssemblyDto" } } } }, "204": { "description": "No Content" } } } }, "/api/v1/units/by-link": { "get": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "class", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/units/assemblies/{assemblyId}/unmount": { "post": { "tags": [ "UnitsEndpoints" ], "parameters": [ { "name": "assemblyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnmountRequestBody" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } } }, "components": { "schemas": { "AccessTokenState": { "enum": [ "active", "revoked" ] }, "AssembleRequest": { "required": [ "childScheme", "childSerial", "slot", "note" ], "type": "object", "properties": { "childScheme": { "type": "string" }, "childSerial": { "type": "string" }, "slot": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] } } }, "AssemblyDto": { "required": [ "id", "parentUnitId", "childUnitId", "slot", "mountedAt", "removedAt", "removedReason", "note" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentUnitId": { "type": "string", "format": "uuid" }, "childUnitId": { "type": "string", "format": "uuid" }, "slot": { "type": [ "null", "string" ] }, "mountedAt": { "type": "string", "format": "date-time" }, "removedAt": { "type": [ "null", "string" ], "format": "date-time" }, "removedReason": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] } } }, "AuditActorType": { "enum": [ "accessToken", "user", "system" ] }, "AuditEntryDto": { "required": [ "id", "occurredAt", "actorType", "actorId", "actorTokenName", "actorContractManufacturerId", "actorContractManufacturerCode", "class", "action", "targetType", "targetId", "clientIp", "payload" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "occurredAt": { "type": "string", "format": "date-time" }, "actorType": { "$ref": "#/components/schemas/AuditActorType" }, "actorId": { "type": "string" }, "actorTokenName": { "type": [ "null", "string" ] }, "actorContractManufacturerId": { "type": [ "null", "string" ], "format": "uuid" }, "actorContractManufacturerCode": { "type": [ "null", "string" ] }, "class": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierClass" } ] }, "action": { "type": "string" }, "targetType": { "type": "string" }, "targetId": { "type": "string" }, "clientIp": { "type": [ "null", "string" ] }, "payload": { "type": [ "null", "string" ] } } }, "AuditPage": { "required": [ "items", "totalCount", "page", "pageSize" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEntryDto" } }, "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } } }, "BlockRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" } } }, "BomNode": { "required": [ "assemblyId", "unitId", "serial", "schemeCode", "status", "slot", "depth", "children" ], "type": "object", "properties": { "assemblyId": { "type": "string", "format": "uuid" }, "unitId": { "type": "string", "format": "uuid" }, "serial": { "type": "string" }, "schemeCode": { "type": "string" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "slot": { "type": [ "null", "string" ] }, "depth": { "type": "integer", "format": "int32" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/BomNode" } } } }, "BulkIssueRequest": { "required": [ "count", "reference" ], "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "reference": { "type": [ "null", "string" ] } } }, "BulkIssueResult": { "required": [ "requested", "issued", "serials", "partialFailureReason" ], "type": "object", "properties": { "requested": { "type": "integer", "format": "int32" }, "issued": { "type": "integer", "format": "int32" }, "serials": { "type": "array", "items": { "$ref": "#/components/schemas/UnitIssueResponse" } }, "partialFailureReason": { "type": [ "null", "string" ] } } }, "ComplianceLifetime": { "enum": [ "standard", "extended", "critical", "custom", null ] }, "ComplianceView": { "required": [ "issuedAt", "warrantyMonths", "warrantyUntil", "lifetime", "supportUntil", "firmwareRevision", "productionLot" ], "type": "object", "properties": { "issuedAt": { "type": "string", "format": "date-time" }, "warrantyMonths": { "type": [ "null", "integer" ], "format": "int32" }, "warrantyUntil": { "type": [ "null", "string" ], "format": "date" }, "lifetime": { "$ref": "#/components/schemas/ComplianceLifetime" }, "supportUntil": { "type": "string", "format": "date" }, "firmwareRevision": { "type": [ "null", "string" ] }, "productionLot": { "type": [ "null", "string" ] } } }, "ConfirmRequest": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": [ "null", "string" ] } } }, "ContractManufacturerDto": { "required": [ "id", "code", "name", "country", "contactEmail", "isActive", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "country": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CreateContractManufacturerRequest": { "required": [ "code", "name", "country", "contactEmail", "isActive" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "country": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] } } }, "CreateImeiTacRequest": { "required": [ "tac", "modelName", "modelMarketing", "displayName", "legalHolder", "contact", "usageStart" ], "type": "object", "properties": { "tac": { "type": "string" }, "modelName": { "type": [ "null", "string" ] }, "modelMarketing": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "legalHolder": { "type": [ "null", "string" ] }, "contact": { "type": [ "null", "string" ] }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "CreateLinkRequest": { "required": [ "identifierClass", "identifierValue", "origin", "externalManufacturer", "externalManufacturerReference", "role", "note" ], "type": "object", "properties": { "identifierClass": { "$ref": "#/components/schemas/IdentifierClass" }, "identifierValue": { "type": "string" }, "origin": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LinkOrigin" } ] }, "externalManufacturer": { "type": [ "null", "string" ] }, "externalManufacturerReference": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] } } }, "CreateMacBlockRequest": { "required": [ "blockByte", "purpose", "isActive" ], "type": "object", "properties": { "blockByte": { "type": "string" }, "purpose": { "type": "string" }, "isActive": { "type": [ "null", "boolean" ] } } }, "CreateMacNamespaceRequest": { "required": [ "prefix", "displayName", "legalHolder", "defaultCategory", "usageStart" ], "type": "object", "properties": { "prefix": { "type": "string" }, "displayName": { "type": "string" }, "legalHolder": { "type": [ "null", "string" ] }, "defaultCategory": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MacCategory" } ] }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "CreateTokenRequest": { "required": [ "name", "scopes", "contractManufacturerId", "allowedIps", "expiresAt" ], "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "contractManufacturerId": { "type": [ "null", "string" ], "format": "uuid" }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateUnitSchemeRequest": { "required": [ "code", "displayName", "unitTypeId", "formatPattern", "formatTemplate", "generator", "formatterSlug", "sequenceStart", "sequenceEnd", "usageStart" ], "type": "object", "properties": { "code": { "type": "string" }, "displayName": { "type": [ "null", "string" ] }, "unitTypeId": { "type": "string", "format": "uuid" }, "formatPattern": { "type": "string" }, "formatTemplate": { "type": [ "null", "string" ] }, "generator": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UnitGenerator" } ] }, "formatterSlug": { "type": [ "null", "string" ] }, "sequenceStart": { "type": [ "null", "integer" ], "format": "int64" }, "sequenceEnd": { "type": [ "null", "integer" ], "format": "int64" }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "CreateUnitTypeRequest": { "required": [ "externalRef", "name", "description", "productUrl", "role", "metadata" ], "type": "object", "properties": { "externalRef": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "productUrl": { "type": [ "null", "string" ] }, "role": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UnitTypeRole" } ] }, "metadata": { "type": [ "null", "string" ] } } }, "CreateUsbVidRequest": { "required": [ "vid", "vendorName", "displayName", "legalHolder", "strategy", "startPid", "endPid", "usageStart" ], "type": "object", "properties": { "vid": { "type": "string" }, "vendorName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "legalHolder": { "type": [ "null", "string" ] }, "strategy": { "type": [ "null", "string" ] }, "startPid": { "type": [ "null", "integer" ], "format": "int32" }, "endPid": { "type": [ "null", "integer" ], "format": "int32" }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "DashboardActivityEntry": { "required": [ "id", "occurredAt", "actorType", "class", "action", "targetType", "targetId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "occurredAt": { "type": "string", "format": "date-time" }, "actorType": { "type": "string" }, "class": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierClass" } ] }, "action": { "type": "string" }, "targetType": { "type": "string" }, "targetId": { "type": "string" } } }, "DashboardClassStats": { "required": [ "namespaceCount", "available", "reserved", "issued", "burnt", "retired", "released", "blocked", "issuedLast24h", "issuedLast7d" ], "type": "object", "properties": { "namespaceCount": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int64" }, "reserved": { "type": "integer", "format": "int64" }, "issued": { "type": "integer", "format": "int64" }, "burnt": { "type": "integer", "format": "int64" }, "retired": { "type": "integer", "format": "int64" }, "released": { "type": "integer", "format": "int64" }, "blocked": { "type": "integer", "format": "int64" }, "issuedLast24h": { "type": "integer", "format": "int64" }, "issuedLast7d": { "type": "integer", "format": "int64" }, "capacity": { "type": "integer", "format": "int64", "default": 0 }, "total": { "type": "integer", "format": "int64" }, "remaining": { "type": "integer", "format": "int64" } } }, "DashboardDto": { "required": [ "identifiers", "platform", "recentActivity" ], "type": "object", "properties": { "identifiers": { "$ref": "#/components/schemas/DashboardIdentifierClasses" }, "platform": { "$ref": "#/components/schemas/DashboardPlatformStats" }, "recentActivity": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardActivityEntry" } } } }, "DashboardIdentifierClasses": { "required": [ "mac", "usbPid", "imei", "unit" ], "type": "object", "properties": { "mac": { "$ref": "#/components/schemas/DashboardClassStats" }, "usbPid": { "$ref": "#/components/schemas/DashboardClassStats" }, "imei": { "$ref": "#/components/schemas/DashboardClassStats" }, "unit": { "$ref": "#/components/schemas/DashboardClassStats" } } }, "DashboardPlatformStats": { "required": [ "unitTypes", "contractManufacturers", "contractManufacturersActive", "activeTokens", "revokedTokens" ], "type": "object", "properties": { "unitTypes": { "type": "integer", "format": "int32" }, "contractManufacturers": { "type": "integer", "format": "int32" }, "contractManufacturersActive": { "type": "integer", "format": "int32" }, "activeTokens": { "type": "integer", "format": "int32" }, "revokedTokens": { "type": "integer", "format": "int32" } } }, "IdentifierClass": { "enum": [ "mac", "usbpid", "imei", "unit", "manufacturerSerial", "manufacturerLot", "oemReference", null ] }, "IdentifierStatus": { "enum": [ "available", "reserved", "issued", "burnt", "retired", "released", "blocked", "replaced" ] }, "ImeiIssueRequest": { "required": [ "unitId", "reference", "idempotencyKey" ], "type": "object", "properties": { "unitId": { "type": [ "null", "string" ], "format": "uuid" }, "reference": { "type": [ "null", "string" ] }, "idempotencyKey": { "type": [ "null", "string" ] }, "metadata": { } } }, "ImeiIssueResponse": { "required": [ "id", "valueDisplay", "namespaceCode", "issuedAt", "imeiInt", "tac", "snr", "checkDigit" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "valueDisplay": { "type": "string" }, "namespaceCode": { "type": "string" }, "issuedAt": { "type": "string", "format": "date-time" }, "imeiInt": { "type": "integer", "format": "int64" }, "tac": { "type": "string" }, "snr": { "type": "integer", "format": "int32" }, "checkDigit": { "type": "integer", "format": "int32" } } }, "ImeiSearchPage": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImeiSearchResult" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } } }, "ImeiSearchResult": { "required": [ "id", "value", "pretty", "imeiInt", "snr", "checkDigit", "status", "reference", "issuedAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "pretty": { "type": "string" }, "imeiInt": { "type": "integer", "format": "int64" }, "snr": { "type": "integer", "format": "int32" }, "checkDigit": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "reference": { "type": [ "null", "string" ] }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "ImeiTacDto": { "required": [ "id", "code", "tac", "displayName", "modelName", "modelMarketing", "legalHolder", "legalStatus", "usageStart", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "tac": { "type": "string" }, "displayName": { "type": "string" }, "modelName": { "type": "string" }, "modelMarketing": { "type": [ "null", "string" ] }, "legalHolder": { "type": [ "null", "string" ] }, "legalStatus": { "$ref": "#/components/schemas/LegalStatus" }, "usageStart": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "date-time" } } }, "ImeiValueDto": { "required": [ "id", "value", "pretty", "imeiInt", "tac", "snr", "checkDigit", "status", "issuedAt", "burntAt", "returnedAt", "returnReason", "metadata", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "pretty": { "type": "string" }, "imeiInt": { "type": "integer", "format": "int64" }, "tac": { "type": "string" }, "snr": { "type": "integer", "format": "int32" }, "checkDigit": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "burntAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnedAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnReason": { "type": [ "null", "string" ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "JsonElement": { }, "LegalStatus": { "enum": [ "active", "ghost", "suspended", "dissolved", "acquired" ] }, "LifecycleRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "LinkDto": { "required": [ "id", "unitId", "serial", "scheme", "status", "identifierClass", "identifierValue", "origin", "externalManufacturer", "externalManufacturerReference", "role", "note", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "unitId": { "type": "string", "format": "uuid" }, "serial": { "type": "string" }, "scheme": { "type": "string" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "identifierClass": { "$ref": "#/components/schemas/IdentifierClass" }, "identifierValue": { "type": "string" }, "origin": { "$ref": "#/components/schemas/LinkOrigin" }, "externalManufacturer": { "type": [ "null", "string" ] }, "externalManufacturerReference": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "LinkOrigin": { "enum": [ "internal", "external" ] }, "MacBlockDto": { "required": [ "id", "blockByte", "purpose", "isActive" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "blockByte": { "type": "integer", "format": "uint8" }, "purpose": { "type": "string" }, "isActive": { "type": "boolean" } } }, "MacCategory": { "enum": [ "ethernetWifi", "zigbee", "bluetooth" ] }, "MacIssueRequest": { "required": [ "category", "unitId", "reference", "idempotencyKey" ], "type": "object", "properties": { "category": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MacCategory" } ] }, "unitId": { "type": [ "null", "string" ], "format": "uuid" }, "reference": { "type": [ "null", "string" ] }, "idempotencyKey": { "type": [ "null", "string" ] }, "block": { "type": [ "null", "string" ] }, "metadata": { } } }, "MacIssueResponse": { "required": [ "id", "valueDisplay", "namespaceCode", "issuedAt", "category", "macInt", "blockByte", "blockPurpose" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "valueDisplay": { "type": "string" }, "namespaceCode": { "type": "string" }, "issuedAt": { "type": "string", "format": "date-time" }, "category": { "type": "string" }, "macInt": { "type": "integer", "format": "int64" }, "blockByte": { "type": "integer", "format": "uint8" }, "blockPurpose": { "type": "string" } } }, "MacNamespaceDto": { "required": [ "id", "code", "prefix", "displayName", "legalHolder", "legalStatus", "defaultCategory", "usageStart", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "legalHolder": { "type": [ "null", "string" ] }, "legalStatus": { "$ref": "#/components/schemas/LegalStatus" }, "defaultCategory": { "$ref": "#/components/schemas/MacCategory" }, "usageStart": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "date-time" } } }, "MacSearchPage": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MacSearchResult" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } } }, "MacSearchResult": { "required": [ "id", "value", "macInt", "category", "status", "reference", "issuedAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "macInt": { "type": "integer", "format": "int64" }, "category": { "type": "string" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "reference": { "type": [ "null", "string" ] }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "MacValueDto": { "required": [ "id", "value", "macInt", "category", "status", "reference", "issuedAt", "burntAt", "returnedAt", "returnReason", "note", "metadata", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "macInt": { "type": "integer", "format": "int64" }, "category": { "type": "string" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "reference": { "type": [ "null", "string" ] }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "burntAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnedAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnReason": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "MetadataPatchMode": { "enum": [ "replace", "merge", null ] }, "PatchComplianceRequest": { "required": [ "warrantyMonths", "complianceLifetime", "supportUntil", "firmwareRevision", "productionLot" ], "type": "object", "properties": { "warrantyMonths": { "type": [ "null", "integer" ], "format": "int32" }, "complianceLifetime": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ComplianceLifetime" } ] }, "supportUntil": { "type": [ "null", "string" ], "format": "date" }, "firmwareRevision": { "type": [ "null", "string" ] }, "productionLot": { "type": [ "null", "string" ] } } }, "PatchMetadataRequest": { "required": [ "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/JsonElement" } } }, "PatchMetadataResponse": { "required": [ "metadata" ], "type": "object", "properties": { "metadata": { "type": "string" } } }, "PoolSeedResult": { "required": [ "classSlug", "namespaceCode", "insertedRows", "totalRows" ], "type": "object", "properties": { "classSlug": { "type": "string" }, "namespaceCode": { "type": "string" }, "insertedRows": { "type": "integer", "format": "int64" }, "totalRows": { "type": "integer", "format": "int64" }, "note": { "type": [ "null", "string" ] } } }, "ReplaceRequest": { "required": [ "reason", "reference" ], "type": "object", "properties": { "reason": { "type": "string" }, "reference": { "type": [ "null", "string" ] } } }, "ReplaceResponse": { "required": [ "oldId", "oldSerial", "newId", "newSerial", "replacedAt" ], "type": "object", "properties": { "oldId": { "type": "string", "format": "uuid" }, "oldSerial": { "type": "string" }, "newId": { "type": "string", "format": "uuid" }, "newSerial": { "type": "string" }, "replacedAt": { "type": "string", "format": "date-time" } } }, "ReserveRequest": { "required": [ "timeoutSeconds" ], "type": "object", "properties": { "timeoutSeconds": { "type": [ "null", "integer" ], "format": "int32" } } }, "ReserveResponse": { "required": [ "id", "serial", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "serial": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "RestoreMode": { "enum": [ "replace", "merge" ] }, "RestoreResult": { "required": [ "tables", "rowsInserted", "rowsSkipped", "elapsed" ], "type": "object", "properties": { "tables": { "type": "integer", "format": "int32" }, "rowsInserted": { "type": "integer", "format": "int64" }, "rowsSkipped": { "type": "integer", "format": "int64" }, "elapsed": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" } } }, "RetireRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" } } }, "SerialSearchPage": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SerialSearchResult" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } } }, "SerialSearchResult": { "required": [ "id", "serial", "serialSeq", "status", "issuedAt", "replacesId", "metadataJson" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "serial": { "type": "string" }, "serialSeq": { "type": [ "null", "integer" ], "format": "int64" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "replacesId": { "type": [ "null", "string" ], "format": "uuid" }, "metadataJson": { "type": [ "null", "string" ] } } }, "TokenCreatedDto": { "required": [ "id", "name", "plaintext", "tokenPrefix", "scopes", "contractManufacturerId", "allowedIps", "expiresAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "plaintext": { "type": "string" }, "tokenPrefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "contractManufacturerId": { "type": [ "null", "string" ], "format": "uuid" }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "TokenDto": { "required": [ "id", "name", "tokenPrefix", "scopes", "state", "contractManufacturerId", "contractManufacturerCode", "allowedIps", "expiresAt", "lastUsedAt", "createdAt", "revokedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tokenPrefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "state": { "$ref": "#/components/schemas/AccessTokenState" }, "contractManufacturerId": { "type": [ "null", "string" ], "format": "uuid" }, "contractManufacturerCode": { "type": [ "null", "string" ] }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastUsedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "UnitGenerator": { "enum": [ "sequential", "random", "sequence", "custom", "clientProvided" ] }, "UnitIssueRequest": { "required": [ "unitId", "reference", "idempotencyKey" ], "type": "object", "properties": { "unitId": { "type": [ "null", "string" ], "format": "uuid" }, "reference": { "type": [ "null", "string" ] }, "idempotencyKey": { "type": [ "null", "string" ] }, "clientSerial": { "type": [ "null", "string" ] } } }, "UnitIssueResponse": { "required": [ "id", "valueDisplay", "namespaceCode", "issuedAt", "serialSeq" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "valueDisplay": { "type": "string" }, "namespaceCode": { "type": "string" }, "issuedAt": { "type": "string", "format": "date-time" }, "serialSeq": { "type": [ "null", "integer" ], "format": "int64" } } }, "UnitSchemeDto": { "required": [ "id", "code", "displayName", "unitTypeId", "generator", "formatPattern", "formatTemplate", "formatterSlug", "sequenceStart", "sequenceEnd", "legalStatus", "usageStart", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "displayName": { "type": "string" }, "unitTypeId": { "type": "string", "format": "uuid" }, "generator": { "$ref": "#/components/schemas/UnitGenerator" }, "formatPattern": { "type": "string" }, "formatTemplate": { "type": [ "null", "string" ] }, "formatterSlug": { "type": [ "null", "string" ] }, "sequenceStart": { "type": [ "null", "integer" ], "format": "int64" }, "sequenceEnd": { "type": [ "null", "integer" ], "format": "int64" }, "legalStatus": { "$ref": "#/components/schemas/LegalStatus" }, "usageStart": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "date-time" } } }, "UnitTypeDto": { "required": [ "id", "externalRef", "name", "description", "productUrl", "role", "metadata", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalRef": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "productUrl": { "type": [ "null", "string" ] }, "role": { "$ref": "#/components/schemas/UnitTypeRole" }, "metadata": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "UnitTypeRole": { "enum": [ "product", "component", "subassembly", "material", "consumable" ] }, "UnitValueDto": { "required": [ "id", "value", "scheme", "serialSeq", "status", "reference", "issuedAt", "returnedAt", "returnReason", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "scheme": { "type": "string" }, "serialSeq": { "type": [ "null", "integer" ], "format": "int64" }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "reference": { "type": [ "null", "string" ] }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnedAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnReason": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "UnmountRequestBody": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" } } }, "UpdateContractManufacturerRequest": { "required": [ "name", "country", "contactEmail", "isActive" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] } } }, "UpdateImeiTacRequest": { "required": [ "displayName", "modelName", "modelMarketing", "legalHolder", "contact", "legalStatus", "usageStart" ], "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "modelName": { "type": [ "null", "string" ] }, "modelMarketing": { "type": [ "null", "string" ] }, "legalHolder": { "type": [ "null", "string" ] }, "contact": { "type": [ "null", "string" ] }, "legalStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LegalStatus" } ] }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "UpdateMacBlockRequest": { "required": [ "purpose", "isActive" ], "type": "object", "properties": { "purpose": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] } } }, "UpdateMacNamespaceRequest": { "required": [ "displayName", "legalHolder", "defaultCategory", "legalStatus", "usageStart" ], "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "legalHolder": { "type": [ "null", "string" ] }, "defaultCategory": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MacCategory" } ] }, "legalStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LegalStatus" } ] }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "UpdateMacValueRequest": { "required": [ "reference", "note" ], "type": "object", "properties": { "reference": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] } } }, "UpdateUnitSchemeRequest": { "required": [ "displayName", "formatPattern", "formatTemplate", "unitTypeId", "sequenceStart", "sequenceEnd", "legalStatus", "usageStart" ], "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "formatPattern": { "type": [ "null", "string" ] }, "formatTemplate": { "type": [ "null", "string" ] }, "unitTypeId": { "type": [ "null", "string" ], "format": "uuid" }, "sequenceStart": { "type": [ "null", "integer" ], "format": "int64" }, "sequenceEnd": { "type": [ "null", "integer" ], "format": "int64" }, "legalStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LegalStatus" } ] }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "UpdateUnitTypeRequest": { "required": [ "name", "description", "productUrl", "role", "metadata" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "productUrl": { "type": [ "null", "string" ] }, "role": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UnitTypeRole" } ] }, "metadata": { "type": [ "null", "string" ] } } }, "UpdateUsbPidRequest": { "required": [ "name", "description", "deviceClass", "serialNumber", "reference", "note" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "deviceClass": { "type": [ "null", "string" ] }, "serialNumber": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] } } }, "UpdateUsbVidRequest": { "required": [ "displayName", "vendorName", "legalHolder", "legalStatus", "strategy", "usageStart" ], "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "vendorName": { "type": [ "null", "string" ] }, "legalHolder": { "type": [ "null", "string" ] }, "legalStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LegalStatus" } ] }, "strategy": { "type": [ "null", "string" ] }, "usageStart": { "type": [ "null", "string" ], "format": "date" } } }, "UsbPidIssueRequest": { "required": [ "name", "description", "reference", "deviceClass", "bcdDeviceMin", "bcdDeviceMax", "idempotencyKey" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "deviceClass": { "type": [ "null", "string" ] }, "bcdDeviceMin": { "type": [ "null", "integer" ], "format": "int32" }, "bcdDeviceMax": { "type": [ "null", "integer" ], "format": "int32" }, "idempotencyKey": { "type": [ "null", "string" ] }, "metadata": { }, "explicitPid": { "type": [ "null", "integer" ], "format": "int32" }, "unitId": { "type": [ "null", "string" ], "format": "uuid" } } }, "UsbPidIssueResponse": { "required": [ "id", "valueDisplay", "namespaceCode", "issuedAt", "pid" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "valueDisplay": { "type": "string" }, "namespaceCode": { "type": "string" }, "issuedAt": { "type": "string", "format": "date-time" }, "pid": { "type": "integer", "format": "int32" } } }, "UsbPidSearchPage": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsbPidSearchResult" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } } }, "UsbPidSearchResult": { "required": [ "id", "value", "pid", "name", "description", "deviceClass", "status", "reference", "source", "issuedAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "pid": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "deviceClass": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "reference": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "UsbPidValueDto": { "required": [ "id", "value", "pid", "vid", "name", "description", "status", "reference", "deviceClass", "bcdDeviceMin", "bcdDeviceMax", "issuedAt", "returnedAt", "returnReason", "source", "note", "metadata", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "pid": { "type": "integer", "format": "int32" }, "vid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/IdentifierStatus" }, "reference": { "type": [ "null", "string" ] }, "deviceClass": { "type": [ "null", "string" ] }, "bcdDeviceMin": { "type": [ "null", "integer" ], "format": "int32" }, "bcdDeviceMax": { "type": [ "null", "integer" ], "format": "int32" }, "issuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnedAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnReason": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "UsbVidDto": { "required": [ "id", "code", "vid", "displayName", "vendorName", "legalHolder", "legalStatus", "strategy", "startPid", "endPid", "usageStart", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "vid": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "vendorName": { "type": "string" }, "legalHolder": { "type": [ "null", "string" ] }, "legalStatus": { "$ref": "#/components/schemas/LegalStatus" }, "strategy": { "type": "string" }, "startPid": { "type": "integer", "format": "int32" }, "endPid": { "type": "integer", "format": "int32" }, "usageStart": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "date-time" } } }, "WhoAmIResponse": { "required": [ "tokenId", "tokenPrefix", "tokenName", "scopes", "contractManufacturerId", "clientIp" ], "type": "object", "properties": { "tokenId": { "type": "string", "format": "uuid" }, "tokenPrefix": { "type": "string" }, "tokenName": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "contractManufacturerId": { "type": [ "null", "string" ], "format": "uuid" }, "clientIp": { "type": [ "null", "string" ] } } } } }, "tags": [ { "name": "AuthEndpoints" }, { "name": "UnitTypeEndpoints" }, { "name": "ContractManufacturerEndpoints" }, { "name": "TokenEndpoints" }, { "name": "AuditEndpoints" }, { "name": "DashboardEndpoints" }, { "name": "AdminEndpoints" }, { "name": "MacEndpoints" }, { "name": "UsbPidEndpoints" }, { "name": "ImeiEndpoints" }, { "name": "UnitsEndpoints" } ] }