Struct zenkit::types::GetEntriesViewRequest

pub struct GetEntriesViewRequest {
    pub filter: Value,
    pub group_by_element_id: ID,
    pub limit: u64,
    pub skip: u64,
    pub allow_deprecated: bool,
    pub task_style: bool,
}

Parameters for get_entries_for_list_view

Fields

filter: Value

filter-object to filter the response

group_by_element_id: ID

optional group_by (for persons and categories)

limit: u64

number of items to return

skip: u64

starting item number

allow_deprecated: bool

Allow deprecated entries to be included in the response. countData will also count deprecated entries in this case. An additional property called countDataNonDeprecated{total, filteredTotal} will be added, that does not count deprecated items.

task_style: bool

Divide the entries into two groups, todo and done. This only works for lists that have the task addon activated, meaning that list.settings.tasks is set. Calling the route with this parameter set to true for a list that is not a task list will result in an error (LIST_HAS_NO_TASK_ELEMENT:C13). If everything works out, the result will contain countDataPerGroup for the keys "todo" and "done": {todo: {total: n, filteredTotal: m}, done: {total: i, filteredTotal: j}}.

Trait Implementations

impl Debug for GetEntriesViewRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetEntriesViewRequest

pub fn default() -> Self

Returns the "default value" for a type.

impl Serialize for GetEntriesViewRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.