Concepts Service API Reference Guide

It is possible to interrogate the Concepts Server 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 requests of the Concepts server can also be carried out using RESTful GET requests. They all return json objects i.e. with Content-Type of application/json;charset=UTF-8.

Swagger documentation for the Concepts Server 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).
• filters: Applies a filter about which data items are to be 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.

If you have published multiple versions of a model, then to interrogate a particular version of a model, then add that version to the rest endpoint, e.g. /models/SpaceMissions/5.6/structure.