Interface ArtistsApiGetArtistsRequest

Request parameters for getArtists operation in ArtistsApi.

Export

ArtistsApiGetArtistsRequest

interface ArtistsApiGetArtistsRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    excludeItemTypes?: BaseItemKind[];
    fields?: ItemFields[];
    filters?: ItemFilter[];
    genreIds?: string[];
    genres?: string[];
    imageTypeLimit?: number;
    includeItemTypes?: BaseItemKind[];
    isFavorite?: boolean;
    limit?: number;
    mediaTypes?: MediaType[];
    minCommunityRating?: number;
    nameLessThan?: string;
    nameStartsWith?: string;
    nameStartsWithOrGreater?: string;
    officialRatings?: string[];
    parentId?: string;
    person?: string;
    personIds?: string[];
    personTypes?: string[];
    searchTerm?: string;
    sortBy?: ItemSortBy[];
    sortOrder?: SortOrder[];
    startIndex?: number;
    studioIds?: string[];
    studios?: string[];
    tags?: string[];
    userId?: string;
    years?: number[];
}

Properties

enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeItemTypes? fields? filters? genreIds? genres? imageTypeLimit? includeItemTypes? isFavorite? limit? mediaTypes? minCommunityRating? nameLessThan? nameStartsWith? nameStartsWithOrGreater? officialRatings? parentId? person? personIds? personTypes? searchTerm? sortBy? sortOrder? startIndex? studioIds? studios? tags? userId? years?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional, include image information in output.

Memberof

ArtistsApiGetArtists

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

ArtistsApiGetArtists

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Total record count.

Memberof

ArtistsApiGetArtists

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional, include user data.

Memberof

ArtistsApiGetArtists

Optional ReadonlyexcludeItemTypes

excludeItemTypes?: BaseItemKind[]

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

Memberof

ArtistsApiGetArtists

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

ArtistsApiGetArtists

Optional Readonlyfilters

filters?: ItemFilter[]

Optional. Specify additional filters to apply.

Memberof

ArtistsApiGetArtists

Optional ReadonlygenreIds

genreIds?: string[]

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

Memberof

ArtistsApiGetArtists

Optional Readonlygenres

genres?: string[]

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

Memberof

ArtistsApiGetArtists

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

ArtistsApiGetArtists

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

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

Memberof

ArtistsApiGetArtists

Optional ReadonlyisFavorite

isFavorite?: boolean

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

Memberof

ArtistsApiGetArtists

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

ArtistsApiGetArtists

Optional ReadonlymediaTypes

mediaTypes?: MediaType[]

Optional filter by MediaType. Allows multiple, comma delimited.

Memberof

ArtistsApiGetArtists

Optional ReadonlyminCommunityRating

minCommunityRating?: number

Optional filter by minimum community rating.

Memberof

ArtistsApiGetArtists

Optional ReadonlynameLessThan

nameLessThan?: string

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

Memberof

ArtistsApiGetArtists

Optional ReadonlynameStartsWith

nameStartsWith?: string

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

Memberof

ArtistsApiGetArtists

Optional ReadonlynameStartsWithOrGreater

nameStartsWithOrGreater?: string

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

Memberof

ArtistsApiGetArtists

Optional ReadonlyofficialRatings

officialRatings?: string[]

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

Memberof

ArtistsApiGetArtists

Optional ReadonlyparentId

parentId?: string

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

Memberof

ArtistsApiGetArtists

Optional Readonlyperson

person?: string

Optional. If specified, results will be filtered to include only those containing the specified person.

Memberof

ArtistsApiGetArtists

Optional ReadonlypersonIds

personIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified person ids.

Memberof

ArtistsApiGetArtists

Optional ReadonlypersonTypes

personTypes?: string[]

Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

Memberof

ArtistsApiGetArtists

Optional ReadonlysearchTerm

searchTerm?: string

Optional. Search term.

Memberof

ArtistsApiGetArtists

Optional ReadonlysortBy

sortBy?: ItemSortBy[]

Optional. Specify one or more sort orders, comma delimited.

Memberof

ArtistsApiGetArtists

Optional ReadonlysortOrder

sortOrder?: SortOrder[]

Sort Order - Ascending,Descending.

Memberof

ArtistsApiGetArtists

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

ArtistsApiGetArtists

Optional ReadonlystudioIds

studioIds?: string[]

Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

Memberof

ArtistsApiGetArtists

Optional Readonlystudios

studios?: string[]

Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

Memberof

ArtistsApiGetArtists

Optional Readonlytags

tags?: string[]

Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

Memberof

ArtistsApiGetArtists

Optional ReadonlyuserId

userId?: string

User id.

Memberof

ArtistsApiGetArtists

Optional Readonlyyears

years?: number[]

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

Memberof

ArtistsApiGetArtists

Settings

Member Visibility

On This Page

Properties