Powered by Zoomin Software. For more details please contactZoomin

Semaphore Semantic Enhancement Server (SES) API Reference

The “az” command

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

The “az” command will return all the concepts within the model . Usually this command will be combined with one or more filter parameters so that only a subsection of the model is returned.

To return the set of letters that should be output for any A-Z rendering page

Request XML output JSON output
REST request: http://localhost:8983/ses/SpaceMissions/az http://localhost:8983/ses/SpaceMissions/az.json
CGI request: http://localhost:8983/ses/?TBDB=SpaceMissions&service=az http://localhost:8983/ses/?TBDB=SpaceMissions&service=az&template=service.json

To return the concepts for a particular page

Request XML output JSON output
REST request: http://localhost:8983/ses/SpaceMissions/az/m http://localhost:8983/ses/SpaceMissions/az/m.json
CGI request: http://localhost:8983/ses/?TBDB=SpaceMissions&service=az&az=m http://localhost:8983/ses/?TBDB=SpaceMissions&service=az&template=service.json&az=m

Note, these requests will return no data when used with the out-of-the-box Space Missions model as none of the labels therein have “Use for A-Z” set. So before playing with these commands, set this for some labels then publish to SES.

Additional Parameter Options

Response

Index

XML
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<SEMAPHORE>
    <PARAMETERS>
        <PARAMETER NAME="relatedconceptlimit">10000</PARAMETER>
        <PARAMETER NAME="q">az_en:*</PARAMETER>
        <PARAMETER NAME="pathelementlimit">10000</PARAMETER>
        <PARAMETER NAME="facet.field">az_en</PARAMETER>
        <PARAMETER NAME="fl">json_en az_label_en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="sort">name_en_pl asc</PARAMETER>
        <PARAMETER NAME="rows">0</PARAMETER>
        <PARAMETER NAME="version">1</PARAMETER>
        <PARAMETER NAME="wt">sesAZReportXML</PARAMETER>
        <PARAMETER NAME="facet">true</PARAMETER>
        <PARAMETER NAME="structure">XML</PARAMETER>
    </PARAMETERS>
    <AZ_REPORT count="4">
        <AZ_LETTER COUNT="4">ALL</AZ_LETTER>
        <AZ_LETTER COUNT="1">B</AZ_LETTER>
        <AZ_LETTER COUNT="2">M</AZ_LETTER>
        <AZ_LETTER COUNT="1">N</AZ_LETTER>
    </AZ_REPORT>
</SEMAPHORE>
JSON
{
  "parameters" : {
    "relatedconceptlimit" : "10000",
    "q" : "az_en:*",
    "pathelementlimit" : "10000",
    "facet.field" : "az_en",
    "fl" : "json_en az_label_en",
    "language" : "\"en\", \"en\", \"en\", \"en\"",
    "sort" : "name_en_pl asc",
    "rows" : "0",
    "version" : "1",
    "wt" : "sesAZReportJSON",
    "facet" : "true",
    "structure" : "JSON"
  },
  "azEntries" : {
    "M" : 2,
    "B" : 1,
    "N" : 1,
    "ALL" : 4
  }
}

Particular Letter

XML
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<SEMAPHORE>
    <PARAMETERS>
        <PARAMETER NAME="relatedconceptlimit">10000</PARAMETER>
        <PARAMETER NAME="q">az_en:M</PARAMETER>
        <PARAMETER NAME="pathelementlimit">10000</PARAMETER>
        <PARAMETER NAME="fl">json_en az_label_en</PARAMETER>
        <PARAMETER NAME="az">m</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="language">en</PARAMETER>
        <PARAMETER NAME="sort">name_en_pl asc</PARAMETER>
        <PARAMETER NAME="rows">1000</PARAMETER>
        <PARAMETER NAME="version">1</PARAMETER>
        <PARAMETER NAME="wt">sesConceptsXML</PARAMETER>
        <PARAMETER NAME="structure">XML</PARAMETER>
        <PARAMETER NAME="command">az</PARAMETER>
    </PARAMETERS>
    <TERMS count="2">
        <TERM URI="http://models.smartlogic.com/SpaceMissions#LunarRovingVehicle">
            <NAME>Lunar Roving Vehicle</NAME>
            <ID>db50deee-7d13-4fdc-988c-d8f1f7d9d6a0</ID>
            <DISPLAY_NAME>moon buggy</DISPLAY_NAME>
            <FREQUENCY>0</FREQUENCY>
            <CREATED_DATE>2021-10-05T14:56:38+0000</CREATED_DATE>
            <MODIFIED_DATE>2021-10-05T14:56:38+0000</MODIFIED_DATE>
            <CLASSES>
                <CLASS>Vehicle</CLASS>
            </CLASSES>
            <FACETS>
                <FACET ID="628286df-b32b-47cd-a8de-f310d17ad43d" NAME="Vehicles"/>
            </FACETS>
            <SYNONYMS TYPE="Use For">
                <SYNONYM>LRV</SYNONYM>
                <SYNONYM>moon buggy</SYNONYM>
                <SYNONYM>rover</SYNONYM>
            </SYNONYMS>
            <HIERARCHY QTY="1" TYPE="Broader Term">
                <FIELD FREQ="0" ID="2a384ab9-60b4-4aa7-ba12-a066ee899aeb" NAME="Spacecrafts">
                    <CLASS NAME="Concept"/>
                </FIELD>
            </HIERARCHY>
            <ASSOCIATED QTY="3" TYPE="vehicle of">
                <FIELD FREQ="0" ID="2370e81c-29b4-4e2e-ad8d-37f3d20d3b4b" NAME="Apollo 15">
                    <CLASS NAME="Mission"/>
                </FIELD>
                <FIELD FREQ="0" ID="1da9a43a-8ce0-4bb5-976b-aed8c5cfcc8a" NAME="Apollo 16">
                    <CLASS NAME="Mission"/>
                </FIELD>
                <FIELD FREQ="0" ID="ebfea1e6-8e3a-483b-9834-04c183a2c746" NAME="Apollo 17">
                    <CLASS NAME="Mission"/>
                </FIELD>
            </ASSOCIATED>
            <PATH TYPE="Narrower Term">
                <FIELD FREQ="0" ID="628286df-b32b-47cd-a8de-f310d17ad43d" NAME="Vehicles">
                    <CLASS NAME="Concept Scheme"/>
                </FIELD>
                <FIELD FREQ="0" ID="2a384ab9-60b4-4aa7-ba12-a066ee899aeb" NAME="Spacecrafts">
                    <CLASS NAME="Concept"/>
                </FIELD>
                <FIELD FREQ="0" ID="db50deee-7d13-4fdc-988c-d8f1f7d9d6a0" NAME="Lunar Roving Vehicle">
                    <CLASS NAME="Vehicle"/>
                </FIELD>
            </PATH>
            <METADATA>
                <FIELD NAME="note">&lt;p&gt;The Lunar Roving Vehicle (LRV) or lunar rover is a battery-powered four-wheeled rover used on the Moon in the last three missions of the American Apollo program (15, 16, and 17) during 1971 and 1972. It was popularly known as &amp;#34;moon buggy&amp;#34;, a play on the words &amp;#34;dune buggy&amp;#34;.&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;/p&gt;</FIELD>
                <FIELD NAME="URI">http://models.smartlogic.com/SpaceMissions#LunarRovingVehicle</FIELD>
            </METADATA>
        </TERM>
        <TERM URI="http://models.smartlogic.com/SpaceMissions#Michael_Collins">
            <NAME>Michael Collins</NAME>
            <ID>edcdffe2-6e8a-41a6-ad11-4a74da3e86ff</ID>
            <DISPLAY_NAME>Michael Collins</DISPLAY_NAME>
            <FREQUENCY>0</FREQUENCY>
            <CREATED_DATE>2021-10-05T14:57:24+0000</CREATED_DATE>
            <MODIFIED_DATE>2021-10-05T14:57:24+0000</MODIFIED_DATE>
            <CLASSES>
                <CLASS>Astronaut</CLASS>
            </CLASSES>
            <FACETS>
                <FACET ID="bfc33274-197f-4873-a1f4-f421c8ab64aa" NAME="People"/>
            </FACETS>
            <HIERARCHY QTY="1" TYPE="Broader Term">
                <FIELD FREQ="0" ID="51a4417a-423c-482c-a909-991efeeb0c55" NAME="NASA">
                    <CLASS NAME="Organization"/>
                </FIELD>
            </HIERARCHY>
            <ASSOCIATED QTY="2" TYPE="crewed">
                <FIELD FREQ="0" ID="493cb4f5-102f-4492-a766-449ff1eba891" NAME="Apollo 11">
                    <CLASS NAME="Mission"/>
                </FIELD>
                <FIELD FREQ="0" ID="b2008e0e-db8b-444a-8e54-e892039c4568" NAME="Gemini 10">
                    <CLASS NAME="Mission"/>
                </FIELD>
            </ASSOCIATED>
            <PATH TYPE="Narrower Term">
                <FIELD FREQ="0" ID="bfc33274-197f-4873-a1f4-f421c8ab64aa" NAME="People">
                    <CLASS NAME="Concept Scheme"/>
                </FIELD>
                <FIELD FREQ="0" ID="51a4417a-423c-482c-a909-991efeeb0c55" NAME="NASA">
                    <CLASS NAME="Organization"/>
                </FIELD>
                <FIELD FREQ="0" ID="edcdffe2-6e8a-41a6-ad11-4a74da3e86ff" NAME="Michael Collins">
                    <CLASS NAME="Astronaut"/>
                </FIELD>
            </PATH>
            <METADATA>
                <FIELD NAME="Illustration">&lt;img src="https://images.smartlogic.com/SpaceMissions/Michaelcollins.jpg" width="200" /&gt;</FIELD>
                <FIELD NAME="definition">Michael Collins (born October 31, 1930), (Brig Gen, USAF, Ret.), is an American former astronaut and test pilot. Selected as part of the third group of fourteen astronauts in 1963, he flew into space twice.  His first spaceflight was on Gemini 10, in which he and Command Pilot John Young performed two rendezvous with different spacecraft and Collins undertook two EVAs. His second spaceflight was as the Command Module Pilot for Apollo 11. While he stayed in orbit around the Moon, Neil Armstrong and Buzz Aldrin left in the Lunar Module to make the first manned landing on its surface. He is one of only 24 people to have flown to the Moon.Collins was the fourth person, and third American, to perform an EVA; and is the first person to have performed more than one EVA.Prior to becoming an astronaut, he had attended the United States Military Academy, and from there he joined the United States Air Force and flew F-86s at Chambley-Bussieres Air Base, France. He was accepted to the U.S. Air Force Experimental Flight Test Pilot School at Edwards Air Force Base in 1960. He unsuccessfully applied for the second astronaut group, but was accepted for the third group.After retiring from NASA in 1970 he took a job in the Department of State as Assistant Secretary of State for Public Affairs. A year later he became the director of the National Air and Space Museum. He held this position until 1978 when he stepped down to become undersecretary of the Smithsonian Institution. In 1980 he took the job as Vice President of LTV Aerospace. He resigned in 1985 to start his own business.He was married to Patricia Collins until her death in April 2014. They had three children: Kate (born May 6, 1959), Ann (born October 31, 1961), and Michael (born February 23, 1963).</FIELD>
                <FIELD NAME="URI">http://models.smartlogic.com/SpaceMissions#Michael_Collins</FIELD>
                <FIELD NAME="Wikidata URI">http://www.wikidata.org/entity/Q104859</FIELD>
                <FIELD NAME="DBPedia URI">http://dbpedia.org/resource/Michael_Collins_(astronaut)</FIELD>
            </METADATA>
        </TERM>
    </TERMS>
</SEMAPHORE>
JSON
{
  "parameters" : {
    "relatedconceptlimit" : "10000",
    "q" : "az_en:M",
    "pathelementlimit" : "10000",
    "fl" : "json_en az_label_en",
    "az" : "m",
    "language" : "\"en\", \"en\", \"en\", \"en\"",
    "sort" : "name_en_pl asc",
    "rows" : "1000",
    "version" : "1",
    "wt" : "sesConceptsJSON",
    "structure" : "JSON",
    "command" : "az"
  },
  "terms" : [ {
    "term" : {
      "name" : "Lunar Roving Vehicle",
      "displayName" : "moon buggy",
      "id" : "db50deee-7d13-4fdc-988c-d8f1f7d9d6a0",
      "uri" : "http://models.smartlogic.com/SpaceMissions#LunarRovingVehicle",
      "classes" : [ "Vehicle" ],
      "facets" : [ {
        "name" : "Vehicles",
        "freq" : 0,
        "id" : "628286df-b32b-47cd-a8de-f310d17ad43d"
      } ],
      "freq" : "0",
      "documents" : "0",
      "createdDate" : "2021-10-05T14:56:38+0000",
      "lastUpdatedDate" : "2021-10-05T14:56:38+0000",
      "metadata" : {
        "note" : [ "<p>The Lunar Roving Vehicle (LRV) or lunar rover is a battery-powered four-wheeled rover used on the Moon in the last three missions of the American Apollo program (15, 16, and 17) during 1971 and 1972. It was popularly known as &#34;moon buggy&#34;, a play on the words &#34;dune buggy&#34;.<br/><br/><br/></p>" ],
        "URI" : "http://models.smartlogic.com/SpaceMissions#LunarRovingVehicle"
      },
      "equivalence" : [ {
        "name" : "Use For",
        "fields" : [ {
          "field" : {
            "name" : "LRV"
          }
        }, {
          "field" : {
            "name" : "moon buggy"
          }
        }, {
          "field" : {
            "name" : "rover"
          }
        } ]
      } ],
      "hierarchy" : [ {
        "qty" : "1",
        "name" : "Broader Term",
        "fields" : [ {
          "field" : {
            "classes" : [ "Concept" ],
            "name" : "Spacecrafts",
            "freq" : 0,
            "id" : "2a384ab9-60b4-4aa7-ba12-a066ee899aeb"
          }
        } ]
      } ],
      "associated" : [ {
        "qty" : "3",
        "name" : "vehicle of",
        "fields" : [ {
          "field" : {
            "classes" : [ "Mission" ],
            "name" : "Apollo 15",
            "freq" : 0,
            "id" : "2370e81c-29b4-4e2e-ad8d-37f3d20d3b4b"
          }
        }, {
          "field" : {
            "classes" : [ "Mission" ],
            "name" : "Apollo 16",
            "freq" : 0,
            "id" : "1da9a43a-8ce0-4bb5-976b-aed8c5cfcc8a"
          }
        }, {
          "field" : {
            "classes" : [ "Mission" ],
            "name" : "Apollo 17",
            "freq" : 0,
            "id" : "ebfea1e6-8e3a-483b-9834-04c183a2c746"
          }
        } ]
      } ],
      "paths" : [ {
        "path" : [ {
          "field" : {
            "classes" : [ "Concept Scheme" ],
            "name" : "Vehicles",
            "freq" : 0,
            "id" : "628286df-b32b-47cd-a8de-f310d17ad43d"
          }
        }, {
          "field" : {
            "classes" : [ "Concept" ],
            "name" : "Spacecrafts",
            "freq" : 0,
            "id" : "2a384ab9-60b4-4aa7-ba12-a066ee899aeb"
          }
        }, {
          "field" : {
            "classes" : [ "Vehicle" ],
            "name" : "Lunar Roving Vehicle",
            "freq" : 0,
            "id" : "db50deee-7d13-4fdc-988c-d8f1f7d9d6a0"
          }
        } ],
        "name" : "Narrower Term"
      } ]
    }
  }, {
    "term" : {
      "name" : "Michael Collins",
      "displayName" : "Michael Collins",
      "id" : "edcdffe2-6e8a-41a6-ad11-4a74da3e86ff",
      "uri" : "http://models.smartlogic.com/SpaceMissions#Michael_Collins",
      "classes" : [ "Astronaut" ],
      "facets" : [ {
        "name" : "People",
        "freq" : 0,
        "id" : "bfc33274-197f-4873-a1f4-f421c8ab64aa"
      } ],
      "freq" : "0",
      "documents" : "0",
      "createdDate" : "2021-10-05T14:57:24+0000",
      "lastUpdatedDate" : "2021-10-05T14:57:24+0000",
      "metadata" : {
        "Illustration" : [ "<img src=\"https://images.smartlogic.com/SpaceMissions/Michaelcollins.jpg\" width=\"200\" />" ],
        "definition" : [ "Michael Collins (born October 31, 1930), (Brig Gen, USAF, Ret.), is an American former astronaut and test pilot. Selected as part of the third group of fourteen astronauts in 1963, he flew into space twice.  His first spaceflight was on Gemini 10, in which he and Command Pilot John Young performed two rendezvous with different spacecraft and Collins undertook two EVAs. His second spaceflight was as the Command Module Pilot for Apollo 11. While he stayed in orbit around the Moon, Neil Armstrong and Buzz Aldrin left in the Lunar Module to make the first manned landing on its surface. He is one of only 24 people to have flown to the Moon.Collins was the fourth person, and third American, to perform an EVA; and is the first person to have performed more than one EVA.Prior to becoming an astronaut, he had attended the United States Military Academy, and from there he joined the United States Air Force and flew F-86s at Chambley-Bussieres Air Base, France. He was accepted to the U.S. Air Force Experimental Flight Test Pilot School at Edwards Air Force Base in 1960. He unsuccessfully applied for the second astronaut group, but was accepted for the third group.After retiring from NASA in 1970 he took a job in the Department of State as Assistant Secretary of State for Public Affairs. A year later he became the director of the National Air and Space Museum. He held this position until 1978 when he stepped down to become undersecretary of the Smithsonian Institution. In 1980 he took the job as Vice President of LTV Aerospace. He resigned in 1985 to start his own business.He was married to Patricia Collins until her death in April 2014. They had three children: Kate (born May 6, 1959), Ann (born October 31, 1961), and Michael (born February 23, 1963)." ],
        "URI" : "http://models.smartlogic.com/SpaceMissions#Michael_Collins",
        "Wikidata URI" : [ "http://www.wikidata.org/entity/Q104859" ],
        "DBPedia URI" : [ "http://dbpedia.org/resource/Michael_Collins_(astronaut)" ]
      },
      "equivalence" : [ ],
      "hierarchy" : [ {
        "qty" : "1",
        "name" : "Broader Term",
        "fields" : [ {
          "field" : {
            "classes" : [ "Organization" ],
            "name" : "NASA",
            "freq" : 0,
            "id" : "51a4417a-423c-482c-a909-991efeeb0c55"
          }
        } ]
      } ],
      "associated" : [ {
        "qty" : "2",
        "name" : "crewed",
        "fields" : [ {
          "field" : {
            "classes" : [ "Mission" ],
            "name" : "Apollo 11",
            "freq" : 0,
            "id" : "493cb4f5-102f-4492-a766-449ff1eba891"
          }
        }, {
          "field" : {
            "classes" : [ "Mission" ],
            "name" : "Gemini 10",
            "freq" : 0,
            "id" : "b2008e0e-db8b-444a-8e54-e892039c4568"
          }
        } ]
      } ],
      "paths" : [ {
        "path" : [ {
          "field" : {
            "classes" : [ "Concept Scheme" ],
            "name" : "People",
            "freq" : 0,
            "id" : "bfc33274-197f-4873-a1f4-f421c8ab64aa"
          }
        }, {
          "field" : {
            "classes" : [ "Organization" ],
            "name" : "NASA",
            "freq" : 0,
            "id" : "51a4417a-423c-482c-a909-991efeeb0c55"
          }
        }, {
          "field" : {
            "classes" : [ "Astronaut" ],
            "name" : "Michael Collins",
            "freq" : 0,
            "id" : "edcdffe2-6e8a-41a6-ad11-4a74da3e86ff"
          }
        } ],
        "name" : "Narrower Term"
      } ]
    }
  } ],
  "total" : "2"
}

Note that if a letter is provided and the match is on an alternative label, then the matching label will be returned as the display name, otherwise the display name will be the same as the preferred label of the concept.

It is possible that elements with a zero count will be returned - this will be the case if the filter removed some terms marked as use for A-Z.

The ALL bucket is the sum of the contents off all the other buckets.

If a concept appears in more than one bucket (because more than one of its labels is marked as “Use for A-Z”), it is possible to have a larger number of concepts in the “ALL” bucket than there are in the model.

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