Introduction
✅Professional ✅Premium ✅Enterprise
Functional details
Ultimo REST connector allows third parties to request information from or send information to Ultimo. Through Ultimo's user interface, it is possible to create custom APIs. These APIs can be used to import, export, update and delete data. More details on how to use the REST API can be found in the REST API guide.
The most commonly used entities (tables in the database) in Ultimo, such as assets, suppliers, work activities, etc., can be added to an API. Properties, which are columns within the entity's table, can then be added to each entity. On top of that, filters can be defined per property.
Context A default filter that is applied when adding an entity, if more than one is present, is a filter by 'context'. Ultimo uses contexts to differentiate information in database tables. In Ultimo, every type of asset is part of the database table 'Equipment', but this is specified further for Technical Asset, Medical Asset or Fleet Asset, on the basis of a context. So a context is mandatory to import data into a table with multiple contexts.
Templates An API can be set up with multiple entities. Multiple entities are also required for an expand of other entities. Ultimo has many different entities and properties. Therefore, we offer several templates to get a quick start with realising a new custom API.
These predefined templates contain the most relevant entities, properties and filters. On the following pages, you can find more information concerning the contents of the different templates. Additional entities, properties and filters can then be added, which may be missing from the template but are necessary for your process. All entities can be found through the 'Entity overview' in the configuration tool of Ultimo.
Each template is issued with read-only privileges, but can be easily modified to a different authorisation level to allow inserts and updates on entities.
Playground
It is possible to test the connector on this page, use the parameters below to try it out! Please note, this is an example. Not all entities and properties are available in this playground.
Parameter | Description |
URL | |
ApiKey | BED9194293084F68807042B9451B36D0 |
Last updated