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

    Type Alias ListCatalogsParams

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

    type ListCatalogsParams = {
        depth?: string;
        fields?: string[];
        hasSubservices?: boolean;
        id?: string[];
        page?: number;
        query?: string;
        size?: number;
        sort?: string;
        state?: boolean;
        subFields?: string[];
    }
    Index

    Properties

    depth? fields? hasSubservices? id? page? query? size? sort? state? subFields?

    Properties

    depth?: string

    Filter by the depth of the hierarchy to retrieve services. The depth indicates how many ancestor levels of services will be included for each catalog.

    • A depth of 0 includes only the direct catalog.
    • A depth of 1 includes the catalog and its immediate services.
    • By default the depth is limited by 3, meaning all nested services and sub-services will be included.
    fields?: string[]

    Fields to be retrieved as a result. If the user passes "-" as the value for fields, it will retrieve all available fields for each catalog.

    hasSubservices?: boolean

    Filter catalogs with subservices

    id?: string[]

    List of IDs to filter the catalogs

    Optionalpage

    page?: number

    Page number for pagination

    query?: string

    Search query string for filtering by name. Supports:

    • Wildcards (*) for substring matching
    • Placeholder (?) for single character substitution
    • Exact match for full names
    size?: number

    Number of records per page

    sort?: string

    Sorting options by fields

    state?: boolean

    Filter by state (true for active, false for inactive)

    subFields?: string[]

    Fields to be retrieved as a result for [SUBSERVICES]. If the user passes "-" as the value for fields, it will retrieve all available fields for each catalog subservices.

    Settings

    Member Visibility

    On This Page

    Properties