TMW facets

API-Version: 1.0.2

Version 2021-12-02

help#format

The SolR data can automatically be facetted by different fields. The definition of the field names and the SolR stings are done in the config.ini. There is a distinct section for each domain, labeled with the the config group title [{domain_name}.facets] . On a single record retrieval facetting will return the keywords and the text facets of the record. On a record list, all keywords and text facets are included in the result.

To access a facet it is sufficient to add the facet parameter to the query string. The field names are listed with comma separation. The all value returns all defined facets. If only the facets are required, the paramter limit can be set to 0

	; object list with object facet (default limit = 10)
	html: 2021-12-02/object/object_name:dampflokomotive|facet=object
	xml: 2021-12-02/object/object_name:dampflokomotive|facet=object/xml

	; object and subject facets without record data
	html: 2021-12-02/object/object_name:dampflokomotive|facet=object|limit=0
	xml: 2021-12-02/object/object_name:dampflokomotive|facet=object,subject|limit=0/xml

	; all facets from all records without record data
	html: 2021-12-02/object/*:*|facet=all|limit=0
	xml: 2021-12-02/object/*:*|facet=all|limit=0/xml
	

For the facet output formats see the [[format|format documentation]].

Object domain

Facets for object records:

Date Range Facet

Object Facet

Facet of the SolR field object_facet, containing thesaurus terms for the object name.

	2021-12-02/object/*:*|facet=object|limit=0
	2021-12-02/object/*:*|facet=object|limit=0/xml
	

Subject Facet

Facet of the SolR field subject_facet, containing thesaurus terms for the descriptions of themes, like concepts or technologies.

Event Facet

Facet of the SolR field event_facet, containing thesaurus terms for events.

Creator (Role) Facet

Facet of the SolR field creator_role_txt. The field contains a combination of a person/institution name with its role, referring to the object, i.e. a person can be producer for one object and user for another object. With this combined facet, the different roles for one person/institution can be distinguished.

Geography Facet

Facet of the SolR field geo_facet, containing thesaurus terms for geography.

Title Text Facet

Facet of the SolR field title, containing words from the title text sting.

Desctription Text Facet

Facet of the SolR field description, containing words from the description text sting.