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

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

    type SearchTypesParams = {
        administered?: boolean;
        extendable?: boolean;
        extended?: boolean;
        extensions?: boolean;
        fields?: string[];
        id?: string;
        name?: string;
        page?: number;
        path?: string;
        q?: string;
        readonly?: boolean;
        repo?: string;
        size?: number;
        sort?: string[];
    }
    Index

    Properties

    administered?: boolean

    [NOT] Administer access control only

    extendable?: boolean

    [NOT] Extend[able] types only.

    extended?: boolean

    [NOT] Extend[ed] types only.

    extensions?: boolean

    [NOT] include extensions/* types.

    fields?: string[]

    Fields [Q]uery to build result dataset record.

    fields ::= field [ *( "," field ) ]
    field ::= name [ *( func ) ] [ inner ]
    inner ::= "{" fields "}"
    funcs ::= *( func )
    func ::= "." name "(" [ args ] ")"
    name ::= ALPHA / DIGIT / USCORE

    ALPHA = %x41-5A / %x61-7A ; "A"-"Z" / "a"-"z"
    DIGIT = %x30-39 ; "0"-"9"
    USCORE = %x5F ; underscore ; "_"
    id?: string

    types.id

    name?: string

    types.name

    page?: number

    Page number of result set of records. Default: 1.

    path?: string

    types.path

    q?: string

    Search term: ? - matches any character * - matches 0 or more characters e.g.: name,emails{type},labels etc...

    readonly?: boolean

    [NOT] [ system / custom ] types only

    repo?: string

    types.repo

    size?: number

    Number of result records (per page). Default: 16.

    sort?: string[]

    Sort result dataset of records by fields.

    sort ::= *( ORDER name )

    ORDER = ASC / DESC
    DESC = "-" / "!"
    ASC = [ "+" ] ; Default

    Fields available

    • id(seq)
    • domain{name}
    • created_at
    • created_by{name}
    • updated_at
    • updated_by{name}

    Use ?fields=field.sort() option to sort Edge fields.