Powered by Zoomin Software. For more details please contactZoomin

Semaphore Semantic Enhancement Server (SES) API Reference

Table of Contents

filter

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: May 13, 2026
  • 3 minute read
    • Semaphore
    • Documentation

The filter parameter can be used multiple times to restrict the range of concepts and concept schemes that may be returned by any particular call.

The format of each instance is “FILTER=<<FILTER TYPE CODE>>=value”.

If multiple filters of the same type are provided, then they will be combined with an OR, so concepts matching any of the conditions will be returned.

If multiple filters of different types are provided, then they will be combined with an AND, so only concepts matching all the conditions will be returned.

The filter type codes are:

  • FA - facet- return only concepts within this facet. The facet should be supplied either as a name or as an identifier, e.g. http://localhost:8983/ses/SpaceMissions/hints/a?FILTER=FA=Places or http://localhost:8983/ses/SpaceMissions/hints/a?FILTER=FA=c7c21bc6-8acc-4228-a7b3-ddb5f2ac1e59

  • FI - facet identifier = return only concepts within this facet. The facet should be supplied via its identifier, e.g. http://localhost:8983/ses/SpaceMissions/hints/a?FILTER=FI=c7c21bc6-8acc-4228-a7b3-ddb5f2ac1e59

  • AT - attribute - return only concepts with this attribute set, e.g. http://localhost:8983/ses/SpaceMissions/hints/g?FILTER=AT=Boolean_attribute.

  • ATN - attribute - return only concepts with this attribute not, set e.g. http://localhost:8983/ses/SpaceMissions/hints/g?FILTER=ATN=Boolean_attribute.

  • CL - class - return only concepts with the presented class, e.g. http://localhost:8983/ses/SpaceMissions/hints/a?FILTER=CL=Astronaut. Note, the class filter applies to classes directly to the concept, inheritance of classes is not inferred.

  • RT - related term - return only concepts or concepts schemes related to the presented concept or concept scheme via a relationship of type skos:related or a sub-property thereof. The concept or concept scheme is presented via its identifier, http://localhost:8983/ses/SpaceMissions/allterms?FILTER=RT=01e1fb66-05c6-47c6-8907-ab6c499e27e9

  • DE - descendant term - return only concepts that are lower in the concept hierarchy than the presented concept or concept scheme. The concept or concept scheme is presented via its identifier,e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=DE=66e9490b-fc45-488b-bba6-720c88b4657b. Note, the presented concept or concept scheme is not returned by this filter.

  • EQ_REL - equivalence relationship - the relationship that should be used in the “name” or “hints” command to match the name provided. If the match is to be on preferred label, then the magic value of “Preferred Label” should be specified, e.g. http://localhost:8983/ses/SpaceMissions/name/1961-008A?filter=EQ_REL=COSPAR%20ID

  • MINDOCS - minimum document count - return only concepts that have a document count equal to or greater than the MINDOCS value, e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=MINDOCS=1.

  • CREATED_AFTER - return only concepts or concept schemes created on or after this date/time, e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=CREATED_AFTER=2017-05-26T10:46:33.

  • CREATED_BEFORE - return only concepts or concept schemes created before this date/time, e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=CREATED_BEFORE=2017-05-26t10:46:33. (Note, we have the after date is inclusive and the before date is exclusive.)

  • MODIFIED_AFTER - return only concepts or concept schemes created or modified on or after this date/time, e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=MODIFIED_AFTER=2017-05-26T10:46:33.

  • MODIFIED_BEFORE - return only concepts or concept schemes created or modified before this date/time, e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=MODIFIED_BEFORE=2017-05-26t10:46:33. (note, we have the after date is inclusive and the before date is exclusive.)

  • MDC_<<Metadata name>> - return only concepts that have the supplied metadata field with the supplied value, e.g. http://localhost:8983/ses/SpaceMissions/allterms?FILTER=MDC_DBPedia%20URI=http%3A%2F%2Fdbpedia.org%2Fresource%2FGemini_1. Note the metadata field name is case sensitive as is the field value. This currently only works for string values. The match to value must be exact, there is no lemmatization of the query. However, wildcards are supported, so MDC_flavour=* will match and value for the flavour metadata.

Date filters must be presented in the format as above, unless a different date format is configured in the solrconfig.xml file as the “dateFormatString” parameter. The format is specified using standard Java date formatting syntax - see DateTimeFormatter.html. Note the date/time format must include a time element as well as a date element (even if this is padded to zeros in the presented date).

The timezone used to resolve the date filters is by default the timezone of the server. This can be overridden by supplying a “timezone” parameter as part of the request. Details of available timezone identifiers are available here.

Differences to older versions

The default date format is now “yyyy-MM-dd’T’HH:mm:ss”. It can be set to the old format “yyyyMMddHHmmss” by updating the configuration file.

The “NOTE” filter has been removed. This required special configuration of the publication process and was little used.

TitleResults for “How to create a CRG?”Also Available inAlert