Skip to main content
Declined

Display OData API information on entities

Related products:Software Factory
Robert Jan de Nie
Jeroen van den Belt
Harm Horstman
Geurt
+17
  • Robert Jan de Nie
    Robert Jan de Nie
  • Jeroen van den Belt
    Jeroen van den Belt
  • Vincent Doppenberg
  • Harm Horstman
    Harm Horstman
  • Geurt
    Geurt
  • Erwin Ekkel
  • Freddy
    Freddy
  • Frank Junger
  • Ricky
    Ricky
  • Remco Kort
    Remco Kort
  • Martin
  • Peter van Leenen
  • Maarten
  • AndreKemmeren
    AndreKemmeren
  • Marius Korff
    Marius Korff
  • BramG
  • Raymond Gerritsen
    Raymond Gerritsen
  • JimQ
  • Mathijn.Smits
  • Dennis1690
    Dennis1690
  • Sanket Kolhe
  • Ionut
    Ionut

One of the standout features of Thinkwise is that many entities automatically generate an OData API, which can be used for CRUD operations and executing procedures. Although the URLs for these API calls are quite predictable, it can sometimes be a bit tricky to figure out how to trigger a task, subroutine, process flow, or a mutation on a table.

Imagine if these entities in the Software Factory had a dedicated “API” tab that detailed the necessary URLs and supported HTTP methods, all while accounting for configured permissions. It could also auto-generate a sample JSON body for tasks, updates, subroutines, etc., where optional parameters can be easily checked or unchecked. This addition would make debugging API calls significantly easier, ensuring that you have the correct URL, method, and body structure right at your fingertips.

Did this topic help you find an answer to your question?

4 replies

Mark Jongeling
Administrator
Forum|alt.badge.img+23

Hey Bram,

I can recommend REST API Documentation Tool | Swagger UI. Works pretty well! 😄


AndreKemmeren
Captain
Forum|alt.badge.img+3

Could Swagger UI be included in the Indicium package, maybe enabled/disabled with a config setting? This way you don't have to work around CORS and authentication challenges compared to running it locally or on another domain.
We rather not install extra stuff into the Thinkwise web-app if we can avoid it, this only complicates releases etc. 


Jeroen van den Belt
Administrator
Forum|alt.badge.img+9

It is also possible to install Swagger UI next to the Thinkwise web-app instead of in it, as long as it runs in the same domain. More information on the Thinkwise perspective on Swagger UI can be found here: 

Since there are already existing tools for this, we don't have any plans to add this to our own standard.

 


Jeroen van den Belt
Administrator
Forum|alt.badge.img+9
NewDeclined

Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings