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

    Type Alias GetYearsData

    type GetYearsData = {
        body?: never;
        path?: never;
        query?: {
            startIndex?: number;
            limit?: number;
            sortOrder?: SortOrder[];
            parentId?: string;
            fields?: ItemFields[];
            excludeItemTypes?: BaseItemKind[];
            includeItemTypes?: BaseItemKind[];
            mediaTypes?: MediaType[];
            sortBy?: ItemSortBy[];
            enableUserData?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            userId?: string;
            recursive?: boolean;
            enableImages?: boolean;
        };
        url: "/Years";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        startIndex?: number;
        limit?: number;
        sortOrder?: SortOrder[];
        parentId?: string;
        fields?: ItemFields[];
        excludeItemTypes?: BaseItemKind[];
        includeItemTypes?: BaseItemKind[];
        mediaTypes?: MediaType[];
        sortBy?: ItemSortBy[];
        enableUserData?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        userId?: string;
        recursive?: boolean;
        enableImages?: boolean;
    }

    Type Declaration

    • OptionalstartIndex?: number

      Skips over a given number of items within the results. Use for paging.

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • OptionalsortOrder?: SortOrder[]

      Sort Order - Ascending,Descending.

    • 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 excluded based on item type. This allows multiple, comma delimited.

    • OptionalincludeItemTypes?: BaseItemKind[]

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

    • OptionalmediaTypes?: MediaType[]

      Optional. Filter by MediaType. Allows multiple, comma delimited.

    • OptionalsortBy?: ItemSortBy[]

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

    • 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.

    • Optionalrecursive?: boolean

      Search recursively.

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

    url: "/Years"

    Settings
    Member Visibility

    On This Page
    Properties