service.table.describe — Опис колонок таблиці

Призначення

Повертає перелік колонок таблиці з типами, nullable, default та ключами.

HTTP

• URL: https://api13.arm20.com/ (ваш домен)
• Метод: POST
• Content-Type: application/json

Авторизація

• Потрібні логін/пароль (як в онлайн статистиці): так.
• meta.user_card: обов’язково.

Параметри params

Поле	Тип	Обовʼязково	Опис

| table | string | так | Назва таблиці (має бути у списку з service.schema). |

Приклад запиту

Мокап: mockups/service/service.table.describe/request.json

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "service.table.describe",
  "params": {
    "table": "Users"
  },
  "id": "example-service.table.describe",
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  }
}

Приклад відповіді (успіх)

Мокап: mockups/service/service.table.describe/response.ok.json

{
  "ok": true,
  "result": {
    "table": "Users",
    "columns": [
      {
        "name": "Ind",
        "type": "int(11)",
        "nullable": false,
        "default": null,
        "key": "PRI",
        "extra": "auto_increment"
      },
      {
        "name": "Nt",
        "type": "varchar(64)",
        "nullable": false,
        "default": "",
        "key": "",
        "extra": ""
      }
    ],
    "columns_count": 2
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "desc-001"
}

Примітки

• Дані беруться з INFORMATION_SCHEMA.COLUMNS.

• Зручно для генерації форм/мапінгів на стороні клієнта.

Типові помилки

• AUTH_REQUIRED / AUTH_FAILED — проблеми з логіном/паролем.

• UNAUTHORIZED — не передали або некоректний meta.user_card.

• MISSING_TABLE — не передали params.table.

• FORBIDDEN_TABLE — таблиця не в білому списку (див. service.schema).