@deltares/fews-pi-requests/lib/types/response/logs/logDisplaysResponse.d.ts

Library for making requests to the FEWS PI webservice

/**
 * LogsDisplaysResponse PI_JSON
 */
export interface LogsDisplaysResponse {
    logDisplays?: LogsDisplay[];
}
export interface LogsDisplay {
    /**
     * the id of the logs display
     */
    id: string;
    /**
     * Name of the logs display
     */
    name: string;
    relativeViewPeriod?: RelativeViewPeriod;
    /**
     * Default number of log entries to request when loading the logs display
     */
    defaultLogRequestCount?: number;
    userAlerts?: LogDisplayUserAlerts;
    systemLog?: LogDisplaySystemLog;
    manualLog?: LogDisplayManualLog;
    logDissemination?: LogDisplayLogDissemination;
}
export interface RelativeViewPeriod {
    unit: string;
    start: string;
    end: string;
}
export interface LogDisplayUserAlerts {
    /**
     * Show message pop up
     */
    showMessagePopUp: boolean;
    /**
     * Show unread message icons in topology
     */
    showUnreadMessageIconsInTopology: boolean;
}
export interface LogDisplaySystemLog {
    logLevel?: "INFO" | "WARN" | "ERROR";
    eventCodes?: string[];
}
export interface LogDisplayManualLog {
    /**
     * Note group id
     */
    noteGroupId: string;
}
export interface LogDisplayLogDissemination {
    disseminationActions: LogDisplayDisseminationAction[];
}
export interface LogDisplayDisseminationAction {
    /**
     * the id of the dissemination action
     */
    id: string;
    /**
     * Description of the dissemination action
     */
    description: string;
    /**
     * Icon id
     */
    iconId: string;
    /**
     * Manual log
     */
    manualLog: boolean;
    /**
     * System log
     */
    systemLog: boolean;
    /**
     * Maximum number of characters in the log entry. Usefull for manual log entries to limit the size of the log message that can be use (e.g. SMS).
     */
    maxLogCharacters?: number;
}