Публичный Web API: Успешный ответ (Получение схемы контракта по коду)

Методы

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

Ресурс

{
    "contract": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "fields": [
            {
                "array": "boolean",
                "calcByFormula": "boolean",
                "code": "string",
                "data": "json",
                "defaultValue": {},
                "deleted": "boolean",
                "formula": "string",
                "indexed": "boolean",
                "required": "boolean",
                "searchable": "boolean",
                "single": "boolean",
                "type": "string",
                "view": {
                    "data": {},
                    "name": "string"
                }
            }
        ],
        "name": "string",
        "namespace": "string",
        "sources": [
            {
                "code": "string",
                "namespace": "string"
            }
        ]
    },
    "error": "string",
    "success": "boolean"
}

Свойства

Имя	Тип	Описание	Дополнительно
contract	object	Полная схема Контракта.	Опциональное
contract.__createdAt	date-time	Дата создания.	Опциональное
contract.__createdBy	uuid	Кем создан.	Опциональное
contract.__deletedAt	date-time	Дата удаления.	Опциональное
contract.__updatedAt	date-time	Дата редактирования.	Опциональное
contract.__updatedBy	uuid	Кем отредактирован.	Опциональное
contract.code	string	Код.	Опциональное
contract.fields[]	array	Поля.	Опциональное
contract.fields[].array	boolean	Признак массива.	Опциональное
contract.fields[].calcByFormula	boolean	Заполнение по формуле.	Опциональное
contract.fields[].code	string	Код.	Опциональное
contract.fields[].data	json	Дополнительные атрибуты поля.	Опциональное
contract.fields[].defaultValue	object	Значение по умолчанию.	Опциональное
contract.fields[].deleted	boolean	Признак удаления.	Опциональное
contract.fields[].formula	string	Формула.	Опциональное
contract.fields[].indexed	boolean	Поиск и сортировка.	Опциональное
contract.fields[].required	boolean	Обязательно для заполнения.	Опциональное
contract.fields[].searchable	boolean	Полнотекстовый поиск.	Опциональное
contract.fields[].single	boolean	Признак количества значений, содержащихся в поле: `true` — одно значение, `false` — множество значений.	Опциональное
contract.fields[].type	string	Тип. TYPE_UNSPECIFIED: Не задан. STRING: Cтрока. FLOAT: Число с плавающей точкой. INTEGER: Целое число. BOOLEAN: Выбор «да/нет». DATETIME: Дата и время. CATEGORY: Категория. MONEY: Деньги. FILE: Файл. PHONE: Телефон. EMAIL: Электронная почта. IMAGE: Изображение. STATUS: Статус. JSON: Произвольный тип (JSON). SYS_USER: Пользователь. FULL_NAME: Полное имя. LINK: Ссылка. SYS_COLLECTION: Ссылка на элемент определённого приложения. REF_ITEM: Ссылка на элемент произвольного приложения. ENUM: Перечисление. TABLE: Таблица. ACCOUNT: Учётная запись. ROLE: Роль. REPORT: Отчёт. UUID: UUID. EVENT: Событие. COLLECTION_TYPE: Ссылка на тип приложения. SYS_DIRECTORY: Ссылка на папку. Возможные значения: `TYPE_UNSPECIFIED` `STRING` `FLOAT` `INTEGER` `BOOLEAN` `DATETIME` `CATEGORY` `MONEY` `FILE` `PHONE` `EMAIL` `IMAGE` `STATUS` `JSON` `SYS_USER` `FULL_NAME` `LINK` `SYS_COLLECTION` `REF_ITEM` `ENUM` `TABLE` `ACCOUNT` `ROLE` `REPORT` `UUID` `EVENT` `COLLECTION_TYPE` `SYS_DIRECTORY`	Опциональное
contract.fields[].view	object	Краткое описание данных для отображения поля приложения.	Опциональное
contract.fields[].view.data	object	Параметры отображения, специфичные для определённого типа поля.	Опциональное
contract.fields[].view.name	string	Название.	Опциональное
contract.name	string	Название контракта.	Опциональное
contract.namespace	string	Раздел.	Опциональное
contract.sources[]	array	Источники данных для контракта.	Опциональное
contract.sources[].code	string	Код источника данных.	Опциональное
contract.sources[].namespace	string	Раздел источника данных.	Опциональное
error	string	Текст ошибки, если `success == false`.	Опциональное
success	boolean	Признак успешного запроса.	Опциональное