Powered by Zoomin Software. For more details please contactZoomin

Semaphore 5.13 Knowledge Service

Knowledge Service API Reference Guide

  • Last Updated: November 20, 2026
  • 1 minute read
    • Semaphore
    • Version 5.13
    • Documentation

It is possible to interrogate the Knowledge Service using the GraphQL interface. This can be found at <machine_name:port>/q/graphql-ui/, for example: http://localhost:5092/q/graphql-ui/. The documentation of this interface is available from there.

All Knowledge Service requests can also be made using RESTful GET requests. They return JSON objects with a Content-Type of application/json;charset=UTF-8.

Swagger documentation for the Knowledge Service is available on the server itself, at <machine_name:port>/q/swagger-ui/, for example: http://localhost:5092/q/swagger-ui/.

Common across all requests are the following parameters:

  • extracts: Tells the server which fields are to be returned (if this is not present, then all available fields are presented).
  • filter: Specifies which data items are returned.
  • filterOptions: Options that can be applied to the filtering searches
  • limit: The maximum number of items to be returned.
  • offset: The result number for the first item to be returned. limit and offset should be used together for pagination
  • sortBy: The ordering of the results to return

When filtering, it is possible to use wildcards in the search values. If you are doing this, then the filterOptions parameter should be set to filterOptions=wildcarded,punctuation-sensitive. All these parameters are available for all requests - except for the status request.

Note - the Knowledge Service is not designed as a drop in replacement for the Semantic Enhancement Server, but there is a lot of functional overlap. A summary of how to achieve the SES functionalities within the Knowledge Service is here.

To query a specific version of a model, include the version number in the REST endpoint, for example, /models/SpaceMissions/5.6/structure.

Alert