Using Swagger via SOAP REST- Examples?

[Daniel_Cerone]

Hi all

Where is the documentation that explains how each swagger operation should be filled in?  This is for SOAP REST API.

For example, what should it look like when I want to fill out the GET /Trends operation and try it out?  What am I filling into these fields, using a real-life EBO example?  The examples next to the field mean nothing to me. 

I was able to GET and PUT values, so I got the basics.  But the same input doesn't work for alarms or trends.  In my basic EBO setup, I have 01%2FServer01%2FTest%2FStringValue.  I also have an alarm in there too but I get a "doesn't exist" error when trying to get that alarms status.

Also, where do we have documentation for what you can and cannot do with SOAP REST API?

May anyone please advise on what this looks like in real life?  The docs I've seen have no examples, just explanations of variables which, doesn't help.  Thanks.

[SteveGregory]

Hi Daniel,

If you are using the Get /Trends function, then you will most likely be getting the 'Bulk Retrieval not supported error'. That is because that feature is not supported and you can find plenty info about that message elsewhere on the forum

If you are after trend values, then use Get /Trend Samples and pass in the trend log path as the trendId parameter. See attached example.

If you actually want a list of trends objects in a folder, then use GET /Containers/{id}/Children where id is the folder path and is embedded into the URL as a double URL encoded query parameter.

Note, query parameters need to be double URL encoded and swagger interface only single encodes, so you need to single encode the path first before entering into the swagger interface. You can use an online converter to do this. e.g. https://www.urlencoder.io/ 

Hope this helps!