# Models ## The DbCountry object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"DbCountry":{"title":"DbCountry","properties":{"Id":{"type":"integer","format":"int32"},"FabricId":{"description":"Fabric Language Id.","type":"string"},"IsoCode":{"description":"ISO code for a Country.","type":"string"},"IsoCodeA3":{"description":"ISO 3 character code for a Country.","type":"string"},"Name":{"description":"Name of the Country.","type":"string"},"AlternateNames":{"description":"Alternate names of the Country.","type":"array","items":{"type":"string"}}},"description":"DbCountry","type":"object"}}}} ``` ## The GetCountries object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetCountries":{"title":"GetCountries","properties":{},"description":"GetCountries","type":"object"}}}} ``` ## The GetLanguages object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetLanguages":{"title":"GetLanguages","properties":{},"description":"GetLanguages","type":"object"}}}} ``` ## The GetImageTypes object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetImageTypes":{"title":"GetImageTypes","properties":{},"description":"GetImageTypes","type":"object"}}}} ``` ## The GetTags object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetTags":{"title":"GetTags","required":["Skip","Take"],"properties":{"Skip":{"description":"Offset for paging. Default is 0.","type":"integer","format":"int32"},"Take":{"description":"Maximum number of rows returned. Default is 1,000.","type":"integer","format":"int32"}},"description":"GetTags","type":"object"}}}} ``` ## The GetVideoTypes object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetVideoTypes":{"title":"GetVideoTypes","properties":{},"description":"GetVideoTypes","type":"object"}}}} ``` ## The GetCommonEnumerators object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetCommonEnumerators":{"title":"GetCommonEnumerators","properties":{},"description":"GetCommonEnumerators","type":"object"}}}} ``` ## The GetOriginatingNetworks object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetOriginatingNetworks":{"title":"GetOriginatingNetworks","properties":{},"description":"GetOriginatingNetworks","type":"object"}}}} ``` ## The GetTrendSources object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetTrendSources":{"title":"GetTrendSources","properties":{},"description":"GetTrendSources","type":"object"}}}} ``` ## The GetDataDemoFilters object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetDataDemoFilters":{"title":"GetDataDemoFilters","properties":{},"description":"GetDataDemoFilters","type":"object"}}}} ``` ## The GetMovieAlternateIdTypes object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetMovieAlternateIdTypes":{"title":"GetMovieAlternateIdTypes","properties":{},"description":"GetMovieAlternateIdTypes","type":"object"}}}} ``` ## The GetMovieReleaseTypes object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetMovieReleaseTypes":{"title":"GetMovieReleaseTypes","properties":{},"description":"GetMovieReleaseTypes","type":"object"}}}} ``` ## The GetMovieCertifications object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetMovieCertifications":{"title":"GetMovieCertifications","properties":{},"description":"GetMovieCertifications","type":"object"}}}} ``` ## The GetMovieGenres object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetMovieGenres":{"title":"GetMovieGenres","properties":{},"description":"GetMovieGenres","type":"object"}}}} ``` ## The GetShowAlternateIdTypes object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetShowAlternateIdTypes":{"title":"GetShowAlternateIdTypes","properties":{},"description":"GetShowAlternateIdTypes","type":"object"}}}} ``` ## The GetShowGenres object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"GetShowGenres":{"title":"GetShowGenres","properties":{},"description":"GetShowGenres","type":"object"}}}} ``` ## The EntertainmentCollection object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"EntertainmentCollection":{"title":"EntertainmentCollection","properties":{"Id":{"description":"ID of the Collection. This is used in EntertainmentSearch to locate programs in this collection. Could be ID or ParentID.","type":"string"},"Name":{"description":"Name of collection.","type":"string"},"Description":{"description":"Description of collection.","type":"string"},"Types":{"description":"List of Types of collection.","type":"array","items":{"type":"string"}},"ParentCollectionIds":{"description":"List of collection ParentIds.","type":"array","items":{"type":"string"}},"Items":{"description":"Programs in the collection.","type":"array","items":{"$ref":"#/components/schemas/EntertainmentCollectionItem"}},"Tags":{"description":"Significant Term tags from programs in the collection.","type":"array","items":{"type":"string"}},"MicroGenres":{"description":"Micro genres from programs in the collection.","type":"array","items":{"type":"string"}},"Subjects":{"description":"Subjects from programs in the collection.","type":"array","items":{"type":"string"}},"BasedOns":{"description":"Based Ons from programs in the collection.","type":"array","items":{"type":"string"}},"Characters":{"description":"Characters from programs in the collection.","type":"array","items":{"type":"string"}},"Timestamp":{"description":"DateTime where collection was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollection","type":"object"},"EntertainmentCollectionItem":{"title":"EntertainmentCollectionItem","properties":{"ProgramId":{"description":"ID of program in collection.","type":"string"},"Sequence":{"description":"Nullable sequence used to order some collections.","type":"integer","format":"int32"},"Modified":{"description":"DateTime collection item was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollectionItem","type":"object"}}}} ``` ## The EntertainmentCollectionItem object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"EntertainmentCollectionItem":{"title":"EntertainmentCollectionItem","properties":{"ProgramId":{"description":"ID of program in collection.","type":"string"},"Sequence":{"description":"Nullable sequence used to order some collections.","type":"integer","format":"int32"},"Modified":{"description":"DateTime collection item was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollectionItem","type":"object"}}}} ``` ## The DbMovieGenre object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"DbMovieGenre":{"title":"DbMovieGenre","properties":{"Id":{"description":"ID of MovieGenre.","type":"integer","format":"int32"},"Genre":{"description":"Genre associated with Movie.","type":"string"},"IABUniqueId":{"description":"Unique IAB Id for Genre.","type":"integer","format":"int32"},"IABParentId":{"description":"IAB Parent Id of IABUniqueId for Genre.","type":"integer","format":"int32"}},"description":"DbMovieGenre","type":"object"}}}} ``` ## The DbShowGenre object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"DbShowGenre":{"title":"DbShowGenre","properties":{"Id":{"description":"ID of ShowGenre.","type":"integer","format":"int32"},"Genre":{"description":"Genre associated with Show.","type":"string"},"IABUniqueId":{"description":"Unique IAB Id for Genre.","type":"integer","format":"int32"},"IABParentId":{"description":"IAB Parent Id of IABUniqueId for Genre.","type":"integer","format":"int32"}},"description":"DbShowGenre","type":"object"}}}} ``` ## The DbShowCertification object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"DbShowCertification":{"title":"DbShowCertification","properties":{"Id":{"description":"Unique ID of a ShowCertification.","type":"integer","format":"int32"},"Certification":{"description":"Show certification or Rating.","type":"string"},"CountryId":{"description":"ID of Country associated with ShowCertification.","type":"integer","format":"int32"},"Order":{"description":"Rank of ShowCertification from youngest to oldest.","type":"integer","format":"int32"},"Definition":{"description":"Definition of ShowCertification.","type":"string"},"Country":{"$ref":"#/components/schemas/DbCountry"}},"description":"DbShowCertification","type":"object"},"DbCountry":{"title":"DbCountry","properties":{"Id":{"type":"integer","format":"int32"},"FabricId":{"description":"Fabric Language Id.","type":"string"},"IsoCode":{"description":"ISO code for a Country.","type":"string"},"IsoCodeA3":{"description":"ISO 3 character code for a Country.","type":"string"},"Name":{"description":"Name of the Country.","type":"string"},"AlternateNames":{"description":"Alternate names of the Country.","type":"array","items":{"type":"string"}}},"description":"DbCountry","type":"object"}}}} ``` ## The LanguageResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"LanguageResponse":{"title":"LanguageResponse","properties":{"Id":{"description":"Unique ID of a Language.","type":"integer","format":"int32"},"IsoCode":{"description":"ISO code for this Language.","type":"string"},"Name":{"description":"Name of the Language.","type":"string"},"FabricId":{"description":"Fabric Language Id.","type":"string"},"IETFCode":{"description":"IETF BCP 47 code for this language.","type":"string"}},"description":"LanguageResponse","type":"object"}}}} ``` ## The EncodeTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"EncodeTypeResponse":{"title":"EncodeTypeResponse","properties":{"Id":{"description":"Unique ID of an EncodeType.","type":"integer","format":"int32"},"Type":{"description":"The name of the type for the EncodeType.","type":"string"}},"description":"EncodeTypeResponse","type":"object"}}}} ``` ## The ImageTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"ImageTypeResponse":{"title":"ImageTypeResponse","properties":{"Id":{"description":"Unique ID for the ImageType.","type":"integer","format":"int32"},"Type":{"description":"Name of the Type of the ImageType.","type":"string"}},"description":"ImageTypeResponse","type":"object"}}}} ``` ## The TagResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"TagResponse":{"title":"TagResponse","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"}},"description":"TagResponse","type":"object"}}}} ``` ## The VideoTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"VideoTypeResponse":{"title":"VideoTypeResponse","properties":{"Id":{"description":"Unique ID of VideoType.","type":"integer","format":"int32"},"Type":{"description":"Type of VideoType.","type":"string"}},"description":"VideoTypeResponse","type":"object"}}}} ``` ## The CommonEnumerators object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"CommonEnumerators":{"title":"CommonEnumerators","properties":{"Provider":{"type":"array","items":{"type":"string"}},"DeliveryMethod":{"type":"array","items":{"type":"string"}},"OfferType":{"type":"array","items":{"type":"string"}},"VideoQuality":{"type":"array","items":{"type":"string"}},"CurrencyType":{"type":"array","items":{"type":"string"}}},"description":"CommonEnumerators","type":"object"}}}} ``` ## The OriginatingNetworkResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"OriginatingNetworkResponse":{"title":"OriginatingNetworkResponse","properties":{"Name":{"type":"string"},"FullName":{"type":"string"},"AlternateNames":{"type":"array","items":{"type":"string"}},"Packages":{"type":"array","items":{"type":"string"}}},"description":"OriginatingNetworkResponse","type":"object"}}}} ``` ## The TrendSourceResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"TrendSourceResponse":{"title":"TrendSourceResponse","properties":{"ItemCount":{"type":"integer","format":"int32"},"Id":{"type":"integer","format":"int32"},"Name":{"type":"string"},"Brand":{"type":"string"},"CountryId":{"type":"integer","format":"int32"},"Classifiers":{"type":"array","items":{"type":"string"}},"Modified":{"type":"string","format":"date-time"},"ListUrl":{"type":"string"},"Active":{"type":"boolean"},"Scrapestorm":{"type":"boolean"},"Programtype":{"type":"string"}},"description":"TrendSourceResponse","type":"object"}}}} ``` ## The DataDemoFilters object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"DataDemoFilters":{"title":"DataDemoFilters","properties":{"SortBy":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"CollectionSortBys":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"ProgramTypes":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"Packages":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"AvailableOn":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"Genres":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"Themes":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"Status":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"Countries":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"TrendSources":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"TrendBrands":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"TrendListClassifiers":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"MissingExternalIdNames":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"Languages":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"OriginatingNetworks":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"CollectionTypes":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"YearRange":{"type":"array","items":{"type":"integer","format":"int32"}},"AwardYears":{"type":"array","items":{"type":"integer","format":"int32"}},"AwardTypes":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"AwardCategoryTypes":{"type":"array","items":{"$ref":"#/components/schemas/NameValueFilter"}},"RemoteIp":{"type":"string"}},"description":"DataDemoFilters","type":"object"},"NameValueFilter":{"title":"NameValueFilter","properties":{"Name":{"type":"string"},"Value":{"type":"string"}},"description":"NameValueFilter","type":"object"}}}} ``` ## The CountryResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"CountryResponse":{"title":"CountryResponse","properties":{"Id":{"type":"integer","format":"int32"},"FabricId":{"description":"Fabric Language Id.","type":"string"},"IsoCode":{"description":"ISO code for a Country.","type":"string"},"IsoCodeA3":{"description":"ISO 3 character code for a Country.","type":"string"},"Name":{"description":"Name of the Country.","type":"string"},"AlternateNames":{"description":"Alternate names of the Country.","type":"array","items":{"type":"string"}}},"description":"CountryResponse","type":"object"}}}} ``` ## The NameValueFilter object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"NameValueFilter":{"title":"NameValueFilter","properties":{"Name":{"type":"string"},"Value":{"type":"string"}},"description":"NameValueFilter","type":"object"}}}} ``` ## The MovieAlternateIdTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"MovieAlternateIdTypeResponse":{"title":"MovieAlternateIdTypeResponse","properties":{"Id":{"description":"ID of AlternateIdType.","type":"integer","format":"int32"},"Type":{"description":"Provider type of AlternateId.","type":"string"}},"description":"MovieAlternateIdTypeResponse","type":"object"}}}} ``` ## The MovieReleaseTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"MovieReleaseTypeResponse":{"title":"MovieReleaseTypeResponse","properties":{"Id":{"description":"Unique ID of MovieReleaseType.","type":"integer","format":"int32"},"Type":{"description":"Name of MovieReleaseType.","type":"string"}},"description":"MovieReleaseTypeResponse","type":"object"}}}} ``` ## The ShowReleaseTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"ShowReleaseTypeResponse":{"title":"ShowReleaseTypeResponse","properties":{"Id":{"description":"Unique ID of ShowReleaseType.","type":"integer","format":"int32"},"Type":{"description":"Name of ShowReleaseType.","type":"string"}},"description":"ShowReleaseTypeResponse","type":"object"}}}} ``` ## The SearchCollectionResponse object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"SearchCollectionResponse":{"title":"SearchCollectionResponse","properties":{"Took":{"type":"integer","format":"int64"},"Total":{"type":"integer","format":"int64"},"MaxScore":{"type":"number","format":"double"},"Hits":{"type":"array","items":{"$ref":"#/components/schemas/CollectionHit"}},"Message":{"type":"string"},"NextPageToken":{"type":"string"}},"description":"SearchCollectionResponse","type":"object"},"CollectionHit":{"title":"CollectionHit","properties":{"Score":{"type":"number","format":"double"},"Source":{"$ref":"#/components/schemas/EntertainmentCollection"},"Id":{"type":"string"}},"description":"CollectionHit","type":"object"},"EntertainmentCollection":{"title":"EntertainmentCollection","properties":{"Id":{"description":"ID of the Collection. This is used in EntertainmentSearch to locate programs in this collection. Could be ID or ParentID.","type":"string"},"Name":{"description":"Name of collection.","type":"string"},"Description":{"description":"Description of collection.","type":"string"},"Types":{"description":"List of Types of collection.","type":"array","items":{"type":"string"}},"ParentCollectionIds":{"description":"List of collection ParentIds.","type":"array","items":{"type":"string"}},"Items":{"description":"Programs in the collection.","type":"array","items":{"$ref":"#/components/schemas/EntertainmentCollectionItem"}},"Tags":{"description":"Significant Term tags from programs in the collection.","type":"array","items":{"type":"string"}},"MicroGenres":{"description":"Micro genres from programs in the collection.","type":"array","items":{"type":"string"}},"Subjects":{"description":"Subjects from programs in the collection.","type":"array","items":{"type":"string"}},"BasedOns":{"description":"Based Ons from programs in the collection.","type":"array","items":{"type":"string"}},"Characters":{"description":"Characters from programs in the collection.","type":"array","items":{"type":"string"}},"Timestamp":{"description":"DateTime where collection was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollection","type":"object"},"EntertainmentCollectionItem":{"title":"EntertainmentCollectionItem","properties":{"ProgramId":{"description":"ID of program in collection.","type":"string"},"Sequence":{"description":"Nullable sequence used to order some collections.","type":"integer","format":"int32"},"Modified":{"description":"DateTime collection item was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollectionItem","type":"object"}}}} ``` ## The CollectionHit object ```json {"openapi":"3.1.1","info":{"title":"Common Metadata API","version":"1.0"},"components":{"schemas":{"CollectionHit":{"title":"CollectionHit","properties":{"Score":{"type":"number","format":"double"},"Source":{"$ref":"#/components/schemas/EntertainmentCollection"},"Id":{"type":"string"}},"description":"CollectionHit","type":"object"},"EntertainmentCollection":{"title":"EntertainmentCollection","properties":{"Id":{"description":"ID of the Collection. This is used in EntertainmentSearch to locate programs in this collection. Could be ID or ParentID.","type":"string"},"Name":{"description":"Name of collection.","type":"string"},"Description":{"description":"Description of collection.","type":"string"},"Types":{"description":"List of Types of collection.","type":"array","items":{"type":"string"}},"ParentCollectionIds":{"description":"List of collection ParentIds.","type":"array","items":{"type":"string"}},"Items":{"description":"Programs in the collection.","type":"array","items":{"$ref":"#/components/schemas/EntertainmentCollectionItem"}},"Tags":{"description":"Significant Term tags from programs in the collection.","type":"array","items":{"type":"string"}},"MicroGenres":{"description":"Micro genres from programs in the collection.","type":"array","items":{"type":"string"}},"Subjects":{"description":"Subjects from programs in the collection.","type":"array","items":{"type":"string"}},"BasedOns":{"description":"Based Ons from programs in the collection.","type":"array","items":{"type":"string"}},"Characters":{"description":"Characters from programs in the collection.","type":"array","items":{"type":"string"}},"Timestamp":{"description":"DateTime where collection was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollection","type":"object"},"EntertainmentCollectionItem":{"title":"EntertainmentCollectionItem","properties":{"ProgramId":{"description":"ID of program in collection.","type":"string"},"Sequence":{"description":"Nullable sequence used to order some collections.","type":"integer","format":"int32"},"Modified":{"description":"DateTime collection item was last modified.","type":"string","format":"date-time"}},"description":"EntertainmentCollectionItem","type":"object"}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://knowledgebase.fabricdata.com/origin/apis-all/common-metadata-api-docs/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.