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

    Type Alias SearchCommentsParams

    type SearchCommentsParams = {
        authorId?: string;
        authorName?: string;
        authorType?: string;
        dateSince?: string;
        dateUntil?: string;
        editorId?: string;
        editorName?: string;
        editorType?: string;
        fields?: string[];
        id?: string[];
        mode?: SearchCommentsMode;
        page?: number;
        q?: string;
        size?: number;
        sort?: string[];
    }
    Index

    Properties

    authorId? authorName? authorType? dateSince? dateUntil? editorId? editorName? editorType? fields? id? mode? page? q? size? sort?

    Properties

    authorId?: string

    Reference Object unique ID.

    authorName?: string

    Reference Object display name.

    authorType?: string

    Reference Object well-known type.

    dateSince?: string

    Since timestamp(milli). Not before.

    dateUntil?: string

    Until timestamp(milli). Not after.

    editorId?: string

    Reference Object unique ID.

    editorName?: string

    Reference Object display name.

    editorType?: string

    Reference Object well-known type.

    fields?: string[]

    Fields to be retrieved as a result.

    id?: string[]

    Comment(s) with unique ID only.

    mode?: SearchCommentsMode

    The requirement of [M]andatory [A]ccess [C]ontrol.

    • READ: Can fetch record. [GET]
    • WRITE: Can update record. [PUT|PATCH]
    • DELETE: Can delete record. [DELETE]

    Optionalpage

    page?: number

    Page number of result. offset = ((page-1)*size)

    q?: string

    Search term: comment text; ? - matches any character * - matches 0 or more characters

    term-of-search: lookup[name|...]

    size?: number

    Size of result page. limit = (size++)

    sort?: string[]

    Sort the result according to fields.

    Settings

    Member Visibility

    On This Page

    Properties