cancel
Showing results for 
Search instead for 
Did you mean: 
Create Post

Build a web based SWIS API Explorer

Build a web based SWIS API Explorer

Lately several of the tools I've been integrating with have this kind of option and Orion should have it too.  This is not just like in the wiki where we can review documentation of how to use the commands and such, its more of a GUI drive menu where you pick the command you want, it has a drop down of possible values based on what is live in your system and explanation for the arguments and once you have walked through all the things you need it can spit you out an example of exactly how that GET or POST would look for the specific options you picked from the drop downs.

I'm aware of the /swis.aspx page but thats a bit of a joke since you can't even copy data from it, and it's not terribly user friendly to begin with.  You can kind of accomplish what I'm going for by playing with the verbs in SWQL Studio, but you have to guess at some of the syntax, and you can learn some clarification on the syntax and such from the Swagger or Wiki pages. I know that these tools exist outside of Orion, but the fact of the matter is that when I was first starting my experiments with the API it slowed me down a lot before I found the Wiki and installed the SDK.  Compared to when I was integrating SNOW for a client I was able to figure out what I needed to build into my scripts in an afternoon with no pre-existing familiarity with their platform.  For the last several years I've posted the links to anyone who had any questions whatsoever but instead of relying on tribal knowledge there doesn't seem like any reason that Orion couldn't just get you directly where you need to be.

In a fantasy land I would also hope that by bringing the API stuff to be more natively visible it would also maybe encourage SW to treat the API as less of an officially unsupported step child and get on board with the fact that in 2020 REST and JSON are basically the language of enterprise IT.

See examples:

https://developer.servicenow.com/app.do#!/training/article/app_store_learnv2_rest_newyork_inbound_re...

Introduction to New Relic's REST API Explorer | New Relic Documentation

API Explorer | Microsoft Docs

Dropbox API Explorer

API Explorer

DocuSign Developer Center: API Explorer

11 Comments
Community Manager
Community Manager
Status changed to: Open for Voting
 
This suggestion / Feature Request would be SO much appreciated! I'd totally be on board with it. What do you need to make it happen? A free fishing trip in Duluth, MN? A trip to the Apostle Islands? I can make that happen--I have the boat & fishing gear, and love sharing my home boating areas with folks new to them.
Level 9

Agree!

It would be nice, I have seen alot of useful features uncovered using formats like the ones listed. A number of products I use just bolt on Swagger UI. It might be that the Orion API doesn't quite fit that mold though, there may be some things not exposed via REST. 

Yes please!?!??!  To late to get it in the 2020.2 release? What about 2020.4??

Level 8

I think this would be a very good addition to the product, as the API is very powerful but can be initially a bit daunting.

Level 20

This sounds like a neat idea... it's not really required but I suppose it's really just repackaging the existing API wiki that's right here:

https://github.com/solarwinds/OrionSDK/wiki

@ecklerwr1 Its a little bit of that, but the key functionality is the whole drop down UI to get the code you need part.  Once I saw that stuff in Service Now it was a game changer for me.  Makes the API stuff MUCH more accessible to everyone.  Several other tools I have touched in the last year also have a similar web based functionality lately so we don't want to look like we aren't hip to the modern world. 

Select the object type you want to work with, pick from the available verbs/operations, populate the arguments based on the selected verb or crud operation, spits out code sample in curl/powershell/python.

If I could get back even a sliver of the hours I have spent digging through the code examples on github, the explanations in the wiki, posts in the SDK forum, messaging @mrxinu and @tdanner, it would be hugely valuable.

Product Manager
Product Manager

While not exactly the API explorer as outlined, I will say there are a few things in the code base that does accelerate your SDK work. 

One example is the web based swis query interface in /orion/admin/swis.aspx

Where you can test your queries 

serena_0-1590679894690.png

 

Another example is the new dashboard system https://thwack.solarwinds.com/t5/The-Orion-Platform-Documents/Orion-Platform-2020-2-Release-Candidat...

Scroll down to his section on the data model for widgets and you'll see a graphical query builder that would help you visualize the scheme for SWIS entities

serena_0-1590693613612.png

And lastly, the SAM API poller can be a quick way to do validation of your queries as well. In 2020.2 the API poller has been improved with some out of the box api poller templates, and you can add in your query into the url like the example below to quickly check the results in a nice visual format, and then just quickly start monitoring! If interested in trying this out, the improvements to the API poller can be seen in the current release candidate: https://thwack.solarwinds.com/t5/SAM-Documents/SAM-2020-2-Release-Candidate-Now-Available/ta-p/59035...

serena_1-1590693905578.png

 

 

Product Manager
Product Manager

There is also the SolarWinds Information Service Swagger UI here.

http://solarwinds.github.io/OrionSDK/swagger-ui/#/