Публичный Web API: Модель экземпляра схемы раздела (Получение схемы раздела по коду)

Методы

GET — Получение схемы раздела по коду

Ресурс

{
    "error": "string",
    "namespace": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "hidden": "boolean",
        "icon": "string",
        "language": "string",
        "name": "string",
        "namespace": "string",
        "params": {
            "fields": [
                {
                    "array": "boolean",
                    "calcByFormula": "boolean",
                    "code": "string",
                    "defaultValue": {},
                    "deleted": "boolean",
                    "formula": "string",
                    "indexed": "boolean",
                    "required": "boolean",
                    "searchable": "boolean",
                    "single": "boolean",
                    "type": "string",
                    "view": {
                        "data": {},
                        "name": "string"
                    }
                }
            ],
            "values": {
                "<key>": {}
            }
        },
        "permissions": {
            "inheritParent": "boolean",
            "values": [
                {
                    "group": {
                        "id": "uuid",
                        "type": "string"
                    },
                    "inherited": "boolean",
                    "types": [
                        "string"
                    ]
                }
            ]
        },
        "sort": "int64"
    },
    "success": "boolean"
}

Свойства

Имя	Тип	Описание	Дополнительно
error	string	Текст ошибки, если `success == false`	Опциональное
namespace	object	Полная схема раздела	Опциональное
namespace.__createdAt	date-time	Дата создания	Опциональное
namespace.__createdBy	uuid	Кем создано	Опциональное
namespace.__deletedAt	date-time	Дата удаления	Опциональное
namespace.__updatedAt	date-time	Дата редактирования	Опциональное
namespace.__updatedBy	uuid	Кем отредактировано	Опциональное
namespace.code	string	Код	Опциональное
namespace.hidden	boolean	Признак видимости	Опциональное
namespace.icon	string	Иконка	Опциональное
namespace.language	string	Оригинальный язык раздела	Опциональное
namespace.name	string	Наименование	Опциональное
namespace.namespace	string	Namespace - тип для пространства имен.	Опциональное
namespace.params	object	Параметры раздела	Опциональное
namespace.params.fields[]	array		Опциональное
namespace.params.fields[].array	boolean	Array	Опциональное
namespace.params.fields[].calcByFormula	boolean	Заполнение по формуле	Опциональное
namespace.params.fields[].code	string	Код	Опциональное
namespace.params.fields[].defaultValue	object	Значение по умолчанию	Опциональное
namespace.params.fields[].deleted	boolean	Признак удаления	Опциональное
namespace.params.fields[].formula	string	Формула	Опциональное
namespace.params.fields[].indexed	boolean	Поиск и сортировка	Опциональное
namespace.params.fields[].required	boolean	Обязательно для заполнения	Опциональное
namespace.params.fields[].searchable	boolean	Полнотекстовый поиск	Опциональное
namespace.params.fields[].single	boolean	Признак того, что в поле хранится единичное значение (если признак равен `true` - одно значение, если `false` - множество)	Опциональное
namespace.params.fields[].type	string	Тип	Опциональное
namespace.params.fields[].view	object	Краткое описание данных для отображения поля раздела	Опциональное
namespace.params.fields[].view.data	object	Параметры отображения, специфичные для конкретного типа поля	Опциональное
namespace.params.fields[].view.name	string		Опциональное
namespace.params.values	object		Опциональное
namespace.params.values.<key>	map of object		Опциональное
namespace.permissions	object	Список прав доступа	Опциональное
namespace.permissions.inheritParent	boolean		Опциональное
namespace.permissions.values[]	array		Опциональное
namespace.permissions.values[].group	object	Пользователь, группа или элемент оргструктуры	Опциональное
namespace.permissions.values[].group.id	uuid		Опциональное
namespace.permissions.values[].group.type	string	Возможные значения: `user` `group` `orgstruct` `role`	Опциональное
namespace.permissions.values[].inherited	boolean		Опциональное
namespace.permissions.values[].types[]	array of string		Опциональное
namespace.sort	int64	Сортировка	Опциональное
success	boolean	Признак успешного запроса	Опциональное