> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/origin/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/origin/apis-all/common-metadata-api-docs/models.md). # Models ## 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 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 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 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 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 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 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 This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://knowledgebase.fabricdata.com/origin/apis-all/common-metadata-api-docs/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.