@webitel/api-services
    Preparing search index...

    Type Alias ListArticlesParams

    Generated by orval v8.5.3 🍺 Do not edit manually. Webitel API OpenAPI spec version: 24.04.0

    type ListArticlesParams = {
        articleId?: string;
        fields?: string[];
        page?: number;
        q?: string;
        size?: number;
        sort?: string[];
        state?: boolean;
        tags?: string[];
    }
    Index

    Properties

    articleId? fields? page? q? size? sort? state? tags?

    Properties

    articleId?: string

    Record(s) with unique ID only.

    fields?: string[]

    Fields to be retrieved as a result.

    Optionalpage

    page?: number

    Page number of result dataset records. offset = (page*size)

    q?: string

    Search term: location name; ? - matches any one character * - matches 0 or more characters

    size?: number

    Size count of records on result page. limit = (size++)

    sort?: string[]

    Sort the result according to fields.

    state?: boolean

    Active Article only.

    tags?: string[]

    Tags associated with the article.

    Settings

    Member Visibility

    On This Page

    Properties