Interface GetArticles

interface GetArticles {
    highlight?: boolean;
    limit?: number;
    query: string;
    serviceDeskId: string;
    start?: number;
}

Properties

highlight?: boolean

If set to true matching query term in the title and excerpt will be highlighted using the @@@hl@@@term@@@endhl@@@ syntax. Default: false.

limit?: number

The maximum number of items to return per page. Default: 100. See the Pagination section for more details.

query: string

The string used to filter the articles.

serviceDeskId: string

start?: number

The starting index of the returned objects. Base index: 0. See the Pagination section for more details.