Class Index

Classes


Facets

Shows facets for a field
Defined in: facets.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Facets(fieldId, pageNumber, pageSize, hierarchyLevel)
Displays the Faceted values for the given field
Class Detail
Facets(fieldId, pageNumber, pageSize, hierarchyLevel)
Displays the Faceted values for the given field
Parameters:
fieldId Optional
The field id to collect facets on
pageNumber Optional
The page number. Default value is 0.
pageSize Optional
The page size. Default value is 1000.
hierarchyLevel Optional
The level of hierarchy. Default value is 0.
Example: Level 0 == car, Level 1 == car:honda, car:toyota, etc.
Returns:
{value: string; count: number; raw: string;}
/wf/restapi/v2/facets

Parameters:
fieldId=http://mediabeacon.com/ns/default/1.0/ format
pageNumber=0
pageSize=1000
hierarchyLevel=0

 Response:
 [
 {
    "value": "JPEG",
    "count": 631,
    "raw": "Graphics:JPEG"
  },
 {
    "value": "PNG",
    "count": 7,
    "raw": "Graphics:PNG"
  },
 {
    "value": "mp4",
    "count": 6,
    "raw": "video:mp4"
  },
 {
    "value": "Bundle",
    "count": 2,
    "raw": "Data:Bundle"
  },
 {
    "value": "MOV",
    "count": 2,
    "raw": "Video:MOV"
  },...
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:02 GMT-0600 (CST)