{\n \"term\": string,\n \"operator\": enum,\n \"value\": string\n}\n<\/code><\/pre>\n\n\n\n\n\nterm<\/code> defines the document attribute in dot notation<\/li>operator<\/code> is one of \u201cequals<\/code>\u201d, \u201cnotEquals<\/code>\u201d, \u201catMost<\/code>\u201d, \u201catLeast<\/code>\u201d, \u201csmaller<\/code>\u201d, \u201clarger<\/code>\u201d, \u201cexists<\/code>\u201d or \u201cnotExists<\/code>\u201d, the default value is \u201cequals<\/code>\u201d<\/li>value<\/code> the value of the document attribute<\/li><\/ul>\n\n\n\n\nExample: Get all events of a series by ID\n\n\n\n\nGET http:\/\/<api-url>\/stores-active\/contentInstance\/event\/filter?filter={\"term\":\"internalIds.seriesId\",\"value\":\"105739158\"}\n<\/code><\/pre>\n\n\n\n\nThere is a special case for the operator \u201cin<\/code>\u201d where the filter expects a list of \u201cvalues\u201d:[string]<\/code> that the attribute specified by term has to match.\n\n\n\nExample: Get events on channels ITV2 and ITV3\n\n\n\n\nGET http:\/\/<api-url>\/stores-active\/contentInstance\/event\/filter?filter={\"term\":\"source\",\"operator\":\"in\",\"values\":[\"ITV2\",\"ITV3\"]}\n<\/code><\/pre>\n\n\n\n\nYou can combine filters using operator \u201cand<\/code>\u201d, \u201cor<\/code>\u201d or \u201cnestedAnd<\/code>\u201d:\n\n\n\n\n{\n \"operator\": enum ,\n \"criteria\": [@genericFilter]\n}\n<\/code><\/pre>\n\n\n\n\nExample: Get events that have keyword of value talkshow\n\n\n\n\nGET http:\/\/<api-url>\/stores-active\/contentInstance\/event\/filter?filter={\"operator\":\"nestedAnd\",\"criteria\":[{\"term\":\"tags.category.categoryId\",\"value\":\"Keyword\"},{\"term\":\"tags.value.valueId\",\"value\":\"talkshow\"}]}\n<\/code><\/pre>\n\n\n\n\n\nWINDOW OF AVAILABILTY FILTERING<\/h4>\n\n\n\n\nA special type of often used filtering is by scheduledStart- and End- DateTime\n\n\n\nAbsolute windows<\/strong> can be defined by providing timestamps for the start and end of the window:
\"windowOfAvailabilityStart\": timestamp<\/code>
\"windowOfAvailabilityEnd\": timestamp<\/code>\n\n\n\nExample: Get events broadcast between 5AM UTC on June 21st and 5AM on June 22nd on channels ITV 2 and ITV3\n\n\n\n\nGET http:\/\/<api-url>\/stores-active\/contentInstance\/event\/filter?filter={\"term\":\"source\",\"operator\":\"in\", \"values\":[\"ITV2\",\"ITV3\"]}&windowOfAvailabilityStart=2016-06-21T05:00:00Z&windowOfAvailabilityEnd=2016-06-22T05:00:00Z\n<\/code><\/pre>\n\n\n\n\nRelative windows<\/strong> can be defined by providing a relative time and an offset for the start and the end of the window where origin<\/code> is either \u201ccurrentTime<\/code>\u201d or \u201cstartOfDay<\/code>\u201d and \u201coffset<\/code>\u201d a duration in XSD duration format. A \u201ctimeZone<\/code>\u201d: timezone, can optionally be provided to interpret relative window of availability origins.\n\n\n\nExample: Search for \u201cunscrupulous\u201d on events scheduled for the next 24 hours\n\n\n\n\nGET http:\/\/<api-url>\/stores-active\/contentInstance\/event\/search?query=unscrupulous&relativeWindowOfAvailabilityStart={\"origin\":\"currentTime\",\"offset\":\"PT0H\"}&relativeWindowOfAvailabilityEnd={\"origin\":\"currentTime\",\"offset\":\"PT0H\"}\n<\/code><\/pre>\n\n\n\n\nWindows can have different types defining the interpretation of the windows of availability windowOfAvailabilityType:<\/code> enum:\n\n\n\noverlap:<\/code> any overlap between the asset\u2019s availability and the specified window of availability will be allowed
strictStart:<\/code> the start of the asset has to lie within the specified window of availability
strictEnd<\/code>: the end of the asset has to lie within the specified window of availability
strict<\/code>: both the start and end of the asset have to lie within the specified window\n\n\n\nThe default value is \u201coverlap<\/code>\u201d.\n\n\n\n\nNOW AND NEXT INFORMATION<\/h4>\n\n\n\n\nAnother special case of filtering is the \u201cnow<\/code> and next<\/code>\u201d type request. A special keyword beforeAfter allows to return a number of documents available around the origin time.\n\n\n\n\norigin<\/code> may be an absolute timestamp or \u201ccurrentTime<\/code>\u201d.<\/li>offset<\/code> points to the first document to be returned,<\/li>limit<\/code> defines the number of documents returned per source (typically per TV channel)<\/li><\/ul>\n\n\n\n\nExample: The following request retrieves now (origin:currentTime, offset:0<\/code>) & next (limit:2<\/code>) information for all available channels:\n\n\n\n\nGET http:\/\/<api-url>\/stores-active\/contentInstance\/event\/filter?beforeAfter={\"origin\":\"currentTime\",\"offset\":0,\"limit\":2}<\/code><\/pre>\n\n\n\n\n\nAdvanced Details<\/h2>\n\n\n\n\n\n
Context merging rules<\/strong>
If a contextId is provided together with an ad-hoc context, the two are merged according to the following rules:<\/p>\n\n\n\n\n\n- the two contexts are merged at top level attribute level<\/li>
- if the ad-hoc and the pre-defined contexts both contain the same top-level attribute, the one in the ad-hoc context is kept<\/li>
- no merging at lower levels of the context object, in particular no merging of list attributes<\/li><\/ul>\n\n","protected":false},"excerpt":{"rendered":"
Besides Search, this is the main functionality of ECDAPI. It returns metadata of the documents matching the filter criteria. The candidate documents are those in the given store or in all active stores of the given store type \/ hierarchy level. Please note that for performance reasons there is a hard-coded internal limit of 10000 […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":66,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-807","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/807","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/comments?post=807"}],"version-history":[{"count":0,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/807\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/66"}],"wp:attachment":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/media?parent=807"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}