Просмотр пользовательских полей активов

01 сентября 2025

ID 269939

GET /api/v2/settings/id/:id

Пользователь может просматривать список пользовательских полей, сделанных пользователем KUMA в веб-интерфейсе программы.

Пользовательское поле представляет из себя контейнер для ввода текста. При необходимости может использоваться значение по умолчанию и маска для проверки корректности вводимого текста в формате https://pkg.go.dev/regexp/syntax. Все символы косой черты в маске необходимо дополнительно экранировать.

Доступ: Главный администратор, Администратор тенанта Main.

Параметры запроса

Имя

Тип данных

Обязательный

Описание

Пример значения

string

Да

Идентификатор конфигурации пользовательских полей

00000000-0000-0000-0000-000000000000

Ответ

HTTP-код: 200

Формат: JSON

type Settings struct {

ID string `json:"id"`

TenantID string `json:"tenantID"`

TenantName string `json:"tenantName"`

Kind string `json:"kind"`

UpdatedAt int64 `json:"updatedAt"`

CreatedAt int64 `json:"createdAt"`

Disabled bool `json:"disabled"`

CustomFields []*CustomField `json:"customFields"`

}

type CustomField struct {

ID string `json:"id"`

Name string `json:"name"`

Default string `json:"default"`

Mask string `json:"mask"`

}

Возможные ошибки

HTTP-код

Описание

Значение поля message

Значение поля details

404

Параметры не найдены: неверный идентификатор или параметров нет

Not found in database

null

500

Любые другие внутренние ошибки

вариативное

Вам помогла эта статья?

Что нам нужно улучшить?

Спасибо за ваш отзыв, вы помогаете нам становиться лучше!