Types and enumerations

    Here are listed all types and enumerations that can be used in REST API.

    User role

    ValueDescription
    ADMINGlobal Administrator
    WORKSPACE_ADMINDomain Administrator
    SCHEMA_ADMINData Manager
    DATA_ADMINReport Editor

    User request type

    ValueDescription
    LOGINLogin

    LOGIN_UNATTENDED

    Unattended login

    PASSWORD_SET

    Set of new password

    PASSWORD_RESET

    Reset of current password

    UNLOCK_ACCOUNT

    Unlock account

    Attribute type

    ValueDescription
    StringAttribute with String value
    NumericAttribute with numeric value
    IntegerAttribute with Integer value
    BooleanAttribute with true or false value
    DateAttribute with date value (without time)
    TimeAttribute with time value (without date)
    DateTimeAttribute with date and time value
    TextAttribute with long text value
    JSONAttribute with JSON value
    GeoJSONAttribute with GeoJSON value
    PointAttribute with geographic point value

    Indicator type

    ValueDescription
    DATA_INDICATORData indicator
    FORMULA_INDICATORFormula indicator
    INDICATOR_GROUPIndicator group

    Import form field type

    ValueDescription
    usernameField for username values
    textfieldField for text values
    datefieldField for dates
    checkboxField for boolean values
    timestampField for timestamps
    selectField for selection

    Data Overwriting Policy

    ValueDescription
    DELETE_ALLDeletes existing data
    DELETE_BY_MEMBERSDeletes existing data by members
    DELETE_BY_MEMBERS_WITHOUT_IMPORTDeletes existing data by members without import

    Import Period

    ValueDescriptionMinutes
    CUSTOMSpecifies custom repeat interval in minutes. 
    HOURHour60
    HOUR22 hoursHOUR * 2
    HOUR44 hoursHOUR * 4
    HOUR88 hoursHOUR * 8
    DAYDayHOUR * 24
    DAY22 daysDAY * 2
    WEEKWeekDAY * 7
    WEEK22 weeksWEEK * 2
    MONTHMonthDAY * 31
    QUARTERQuarterMONTH * 3
    YEARYearDAY * 365

    View Report type

    ValueDescription
    chartChart view
    tableTable view
    mapMap view
    kpiKPI view
    textCustom content view
    imageImage view

    Dashlet type

    ValueDescription
    viewReportView Report
    textContentText content

    Page size

    ValueDescription
    A1Page size A1
    A2Page size A2
    A3Page size A3
    A4Page size A4

    Page orientation

    ValueDescription
    PORTRAITPortrait page orientation
    LANDSCAPELandscape page orientation

    Indicator size

    ValueDescription
    x-smallSmaller
    smallSmall
    normalNormal
    largeLarge
    x-largeLarger
    xx-largeVery large

    Conditional formatting symbol

    ValueDescriptionSymbol value
    ARROW_UPArrow up
    ARROW_DOWNArrow down
    PROBLEMExclamation mark!
    WARNINGWarning

    Date and time interval type

    ValueDescription
    absoluteAbsolute interval
    relativeRelative interval
    customCustom interval

    Date Interval Period

    ValueDescription
    DAYDay
    WEEKWeek
    MONTHMonth
    QUARTERQuarter
    YEARYear

    Time Interval Period

    ValueDescription
    HOURHour
    MINUTEMinute
    SECONDSecond

    Filter operation type

    ValueDescription
    EQequals
    NEQnot equal to
    GTgreater than
    GTEgreater than or equal to
    LTlower than
    LTElower than or equal to
    INcontains
    NOT_INdoesn't contain
    NULLempty
    NOT_NULLnot empty
    BETWEENbetween
    COUNTcount
    GBYan increase of more than
    LBYa decrease of more than
    PGBYgreater by X %
    PLBYlower by X %
    • No labels