Interface LibraryApiGetSimilarItemsRequest

Request parameters for getSimilarItems operation in LibraryApi.

Export

LibraryApiGetSimilarItemsRequest

interface LibraryApiGetSimilarItemsRequest {
    excludeArtistIds?: string[];
    fields?: ItemFields[];
    itemId: string;
    limit?: number;
    userId?: string;
}

Properties

excludeArtistIds? fields? itemId limit? userId?

Properties

Optional ReadonlyexcludeArtistIds

excludeArtistIds?: string[]

Exclude artist ids.

Memberof

LibraryApiGetSimilarItems

Optional Readonlyfields

fields?: ItemFields[]

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

Memberof

LibraryApiGetSimilarItems

ReadonlyitemId

itemId: string

The item id.

Memberof

LibraryApiGetSimilarItems

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

LibraryApiGetSimilarItems

Optional ReadonlyuserId

userId?: string

Optional. Filter by user id, and attach user data.

Memberof

LibraryApiGetSimilarItems

Settings

Member Visibility

On This Page

Properties