Powered by Zoomin Software. For more details please contactZoomin

Semaphore Semantic Enhancement Server (SES) API Reference

Ordered Lists

  • Last Updated: May 13, 2026
  • 2 minute read
    • Semaphore
    • Documentation

It is possible to define ordered lists in Knowledge Model Management. This ordering can be applied for concepts to narrower concepts, broader concepts, or associated concepts, and for concept schemes to top concepts.

These are output in SES as ordered collections in addition to the original unordered format. There might be any of these four types of ordered collection on a term output by Semantic Enhancement Server.

XML

<ORDERED_COLLECTION BASE_TYPE="TopConcepts" QTY="2">
    <FIELD FREQ="0" ID="d84087c9-6cdf-4a18-b300-3f8f2598ce12" NAME="Concept 2" TYPE="hasTopConcept">
        <CLASS NAME="Concept"/>
    </FIELD>
    <FIELD FREQ="0" ID="89e5ce9d-5017-4c0b-833e-3f5129269b8d" NAME="Concept 1" TYPE="hasTopConcept">
        <CLASS NAME="Concept"/>
    </FIELD>
</ORDERED_COLLECTION>
<ORDERED_COLLECTION BASE_TYPE="RelatedConcepts" QTY="2">
    <FIELD FREQ="0" ID="e7f76d98-170e-4820-bbce-0b399fc8a11b" NAME="Related Concept 2" TYPE="has related">
        <CLASS NAME="Concept"/>
    </FIELD>
    <FIELD FREQ="0" ID="7c2c30f7-f0d2-4ac8-9e96-4d7a35b637d3" NAME="Related Concept 1" TYPE="has related">
        <CLASS NAME="Concept"/>
    </FIELD>
</ORDERED_COLLECTION>
<ORDERED_COLLECTION BASE_TYPE="NarrowerConcepts" QTY="2">
    <FIELD FREQ="0" ID="b6101088-8f92-4fcc-9cc7-ce10e0627733" NAME="Grandchild Concept 2" TYPE="has narrower">
        <CLASS NAME="Concept"/>
    </FIELD>
    <FIELD FREQ="0" ID="bf729cfd-8ae1-425c-8903-b3b75bb59a08" NAME="Grandchild Concept 1" TYPE="has narrower">
        <CLASS NAME="Concept"/>
    </FIELD>
</ORDERED_COLLECTION>
<ORDERED_COLLECTION BASE_TYPE="BroaderConcepts" QTY="2">
    <FIELD FREQ="0" ID="d84087c9-6cdf-4a18-b300-3f8f2598ce12" NAME="Concept 2" TYPE="has broader">
        <CLASS NAME="Concept"/>
    </FIELD>
    <FIELD FREQ="0" ID="89e5ce9d-5017-4c0b-833e-3f5129269b8d" NAME="Concept 1" TYPE="has broader">
        <CLASS NAME="Concept"/>
    </FIELD>
</ORDERED_COLLECTION>

Note, each ORDERED_COLLECTION has a BASE_TYPE attribute. The value for this will be one of “NarrowerConcepts”, “BroaderConcepts”, “RelatedConcepts” or “TopConcepts”. The specific relationship type linking the concepts will be present as the “TYPE” attribute of the “FIELD”. There might be different “TYPE”s of field within one ordered collection as the collection is over all relationships of the base type.

JSON

The JSON equivalent looks like:

      "ordered_collections" : [ {
        "base_type" : "TopConcepts",
        "qty" : 2,
        "fields" : [ {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Concept 2",
          "id" : "d84087c9-6cdf-4a18-b300-3f8f2598ce12",
          "type" : "hasTopConcept"
        }, {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Concept 1",
          "id" : "89e5ce9d-5017-4c0b-833e-3f5129269b8d",
          "type" : "hasTopConcept"
        } ]
      } ]
      "ordered_collections" : [ {
        "base_type" : "RelatedConcepts",
        "qty" : 2,
        "fields" : [ {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Related Concept 2",
          "id" : "e7f76d98-170e-4820-bbce-0b399fc8a11b",
          "type" : "has related"
        }, {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Related Concept 1",
          "id" : "7c2c30f7-f0d2-4ac8-9e96-4d7a35b637d3",
          "type" : "has related"
        } ]
      }, {
        "base_type" : "NarrowerConcepts",
        "qty" : 2,
        "fields" : [ {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Grandchild Concept 2",
          "id" : "b6101088-8f92-4fcc-9cc7-ce10e0627733",
          "type" : "has narrower"
        }, {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Grandchild Concept 1",
          "id" : "bf729cfd-8ae1-425c-8903-b3b75bb59a08",
          "type" : "has narrower"
        } ]
      }, {
        "base_type" : "BroaderConcepts",
        "qty" : 2,
        "fields" : [ {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Concept 2",
          "id" : "d84087c9-6cdf-4a18-b300-3f8f2598ce12",
          "type" : "has broader"
        }, {
          "classes" : [ "Concept" ],
          "freq" : 0,
          "name" : "Concept 1",
          "id" : "89e5ce9d-5017-4c0b-833e-3f5129269b8d",
          "type" : "has broader"
        } ]
      } ]

i.e. ordered_collections points to an array of ordered collections each of which is a list of fields.

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