@docsvision/webclient/System/ICommonResponse.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { GenModels } from '@docsvision/webclient/Generated/DocsVision.WebClient.Models';
/**
 * Стандартная модель ответа сервера.
 * @param ResponseModelT тип возвращаемых данных
 */
export interface ICommonResponse<ResponseModelT> {
    /**
     * Успешно ли завершился запрос.
     */
    success: boolean;
    /**
     * Временная метка карточки.
     */
    timestamp: number;
    /**
     * Идентификатор карточки, для которой возвращен {@link timestamp}
     */
    timestampCardId: string;
    /**
     * Идентификатор строки, для которой возвращен {@link timestamp}
     */
    timestampRowId: string;
    /**
     * Сообщение об ошибке или предупреждение.
     */
    message: string;
    /**
     * Данные.
     */
    data: ResponseModelT;
    /**
     *  Модель с данными связанных источников данных
     */
    extendedDataSourceInfos: GenModels.ExtendedDataSourceInfoModel[];
    /**
     * Имя сервера.
     */
    serverName: string;
    /**
     * Серверное время.
     */
    time: Date;
}