@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • List solution tags Returns a paginated list of solution tag definitions visible to the authenticated user, scoped to their app. Results include tags from both the system scope and the caller's organization scope by default; use the owners parameter to restrict to one or both. Use keys to fetch a specific set of tags by their stable key identifiers, or lookup_key to find a single tag by its lookup key. Use path_prefix to filter tags by virtual path hierarchy. Combine filters as needed; all supplied filters are applied together. Pagination is page-based. Supply page and page_size to control which page is returned. The response includes total_entries, total_pages, has_next, and has_prev fields for navigating the full result set.

      Parameters

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

        Query parameters.

        • Optionalkeys?: string[]

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

        • OptionallookupKey?: string

          Return only the solution tag whose lookup_key exactly matches this value.

        • Optionalowners?: string[]

          Restrict results to one or more owner scopes. Accepted values are "system" (app-level system tags) and "org" (tags belonging to the caller's organization). Omit to include all scopes visible to the caller.

        • Optionalpage?: number

          Page number to return. Defaults to 1.

        • OptionalpageSize?: number

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

        • OptionalpathPrefix?: string

          Return only solution tags whose virtual_path starts with this prefix.

      Returns Promise<SolutionTagListResponse>

      Paginated list of solution tag definitions visible to the authenticated user.