@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • List solution categories Returns a paginated list of solution category definitions visible to the authenticated caller. Use filters to narrow results by key, parent key, lookup key, or virtual path prefix. Results are scoped to categories accessible under the caller's viewer context. Pass app to restrict the listing to categories associated with a specific app scope. Omit owners to return categories from all ownership scopes ("system" and "org") that the caller can see. Pagination is page-based. Use page and page_size to navigate large result sets. The response includes total_entries, total_pages, has_next, and has_prev to support pagination controls. total_entries reflects the count after key deduplication.

      Parameters

      • Optionalparams: {
            keys?: string[];
            lookupKey?: string;
            owners?: string[];
            page?: number;
            pageSize?: number;
            parentKeys?: string[];
            pathPrefix?: string;
        }

        Query parameters.

        • Optionalkeys?: string[]

          Return only categories whose key exactly matches one of the provided values.

        • OptionallookupKey?: string

          Return only the category whose lookup_key exactly matches this value.

        • Optionalowners?: string[]

          Restrict results to categories owned by the specified scopes. Accepted values are "system" and "org". Omit to include all ownership scopes visible to the caller.

        • Optionalpage?: number

          Page number to retrieve, 1-indexed. Defaults to 1.

        • OptionalpageSize?: number

          Number of solution categories to return per page. Defaults to 25.

        • OptionalparentKeys?: string[]

          Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.

        • OptionalpathPrefix?: string

          Return only categories whose virtual_path starts with this prefix.

      Returns Promise<SolutionCategoryListResponse>

      Paginated list of solution category summaries matching the applied filters.