Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetStudiosData

    type GetStudiosData = {
        body?: never;
        path?: never;
        query?: {
            startIndex?: number;
            limit?: number;
            searchTerm?: string;
            parentId?: string;
            fields?: ItemFields[];
            excludeItemTypes?: BaseItemKind[];
            includeItemTypes?: BaseItemKind[];
            isFavorite?: boolean;
            enableUserData?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            userId?: string;
            nameStartsWithOrGreater?: string;
            nameStartsWith?: string;
            nameLessThan?: string;
            enableImages?: boolean;
            enableTotalRecordCount?: boolean;
        };
        url: "/Studios";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        startIndex?: number;
        limit?: number;
        searchTerm?: string;
        parentId?: string;
        fields?: ItemFields[];
        excludeItemTypes?: BaseItemKind[];
        includeItemTypes?: BaseItemKind[];
        isFavorite?: boolean;
        enableUserData?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        userId?: string;
        nameStartsWithOrGreater?: string;
        nameStartsWith?: string;
        nameLessThan?: string;
        enableImages?: boolean;
        enableTotalRecordCount?: boolean;
    }

    Type Declaration

    • OptionalstartIndex?: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • OptionalsearchTerm?: string

      Optional. Search term.

    • OptionalparentId?: string

      Specify this to localize the search to a specific item or folder. Omit to use the root.

    • Optionalfields?: ItemFields[]

      Optional. Specify additional fields of information to return in the output.

    • OptionalexcludeItemTypes?: BaseItemKind[]

      Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

    • OptionalincludeItemTypes?: BaseItemKind[]

      Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

    • OptionalisFavorite?: boolean

      Optional filter by items that are marked as favorite, or not.

    • OptionalenableUserData?: boolean

      Optional, include user data.

    • OptionalimageTypeLimit?: number

      Optional, the max number of images to return, per image type.

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • OptionaluserId?: string

      User id.

    • OptionalnameStartsWithOrGreater?: string

      Optional filter by items whose name is sorted equally or greater than a given input string.

    • OptionalnameStartsWith?: string

      Optional filter by items whose name is sorted equally than a given input string.

    • OptionalnameLessThan?: string

      Optional filter by items whose name is equally or lesser than a given input string.

    • OptionalenableImages?: boolean

      Optional, include image information in output.

    • OptionalenableTotalRecordCount?: boolean

      Total record count.

    url: "/Studios"

    Settings
    Member Visibility

    On This Page
    Properties