Схемы и метаданные

Все методы · Ключи и права · Ошибки

Примеры ответов сокращены. Пустой массив означает допустимый результат без доступных записей, а не обязательное отсутствие данных.

Для методов с ключом действуют общие проверки: 401 — ключ не принят, 403 — не хватает scope или прав владельца, 429 — превышен лимит. Неверные параметры могут дать 400, недоступный адресный ресурс — 404. Особенности команды указаны рядом с методом. Точную причину смотрите в error.code и details: как обработать ошибку и безопасно повторить запрос.

Скачать OpenAPI

GET /api/v1/openapi.json

Действие ключа: —. Ключ не нужен.

Без ключа. Возвращает исходную спецификацию OpenAPI 3.1, а не envelope.

Параметры пути: нет. Тело: не требуется.

Пример запроса

GET /api/v1/openapi.json HTTP/1.1
Host: service.example.invalid

Ответ и ошибки

Успех: 200. OpenAPI document.

{
  "openapi": "3.1.0",
  "info": {
    "version": "1.0.0"
  }
}

Если спецификация недоступна, проверьте адрес и состояние сервера.

Найти доступные типы

GET /api/v1/metadata/types

Действие ключа: metadata:read. Оно не заменяет права владельца на объекты и поля.

Только доступные активные типы бизнес-объектов. objectCategory отличает object от dictionary; сущности с отдельным native storage не входят в этот список.

Параметры пути: нет. Тело: не требуется.

Пример запроса

GET /api/v1/metadata/types HTTP/1.1
Host: service.example.invalid
Authorization: Bearer YOUR_API_KEY

Ответ и ошибки

Успех: 200. Объект с массивом types.

{
  "data": {
    "types": [
      {
        "id": "TYPE_ID",
        "code": "type_code",
        "name": "Тип записи",
        "objectCategory": "object"
      }
    ]
  },
  "meta": {
    "correlationId": "CORRELATION_ID",
    "apiVersion": "v1"
  }
}

Прочитать поля типа

GET /api/v1/metadata/types/{typeId}/fields

Действие ключа: metadata:read. Оно не заменяет права владельца на объекты и поля.

typeId — идентификатор или поддержанный однозначный код типа. Скрытые поля исключены. readOnly — подсказка; запись дополнительно проверяет права и правила.

Параметры пути: typeId. Тело: не требуется.

Пример запроса

GET /api/v1/metadata/types/TYPE_ID/fields HTTP/1.1
Host: service.example.invalid
Authorization: Bearer YOUR_API_KEY

Ответ и ошибки

Успех: 200. Схема типа с fields.

{
  "data": {
    "id": "TYPE_ID",
    "objectCategory": "object",
    "fields": [
      {
        "code": "FIELD_CODE",
        "dataType": "string",
        "required": true
      }
    ]
  },
  "meta": {
    "correlationId": "CORRELATION_ID",
    "apiVersion": "v1"
  }
}

Прочитать схему конкретной записи

GET /api/v1/objects/{objectId}/schema

Действие ключа: metadata:read. Оно не заменяет права владельца на объекты и поля.

Схема сохранённой версии типа с правами на поля конкретной записи, без значений полей.

Параметры пути: objectId. Тело: не требуется.

Пример запроса

GET /api/v1/objects/OBJECT_ID/schema HTTP/1.1
Host: service.example.invalid
Authorization: Bearer YOUR_API_KEY

Ответ и ошибки

Успех: 200. Схема с fields.

{
  "data": {
    "id": "TYPE_ID",
    "fields": [
      {
        "code": "FIELD_CODE",
        "dataType": "string"
      }
    ]
  },
  "meta": {
    "correlationId": "CORRELATION_ID",
    "apiVersion": "v1"
  }
}

Связанные статьи

• Обзор API
• Права доступа
• Интеграции