Welcome to the new Schneider Electric Community

It's your place to connect with experts and peers, get continuous support, and share knowledge.

  • Explore the new navigation for even easier access to your community.
  • Bookmark and use our new, easy-to-remember address (community.se.com).
  • Get ready for more content and an improved experience.

Contact SchneiderCommunity.Support@se.com if you have any questions.

Close
Invite a Co-worker
Send a co-worker an invite to the Exchange portal.Just enter their email address and we’ll connect them to register. After joining, they will belong to the same company.
Send Invite Cancel
84248members
353347posts

ITA API Webservices

EcoStruxure IT forum

A support forum for Data Center Operation, Data Center Expert, and EcoStruxure IT product users to share knowledge on installation, configuration, and general product use.

Mark1
Cadet
0 Likes
2
968

ITA API Webservices

We are looking for some tip/tricks in how to use the API webservices.

 

At the moment we use the export table function from the equipment browser (desktop client) to get all the assets from every location we have. (includes columns are rack name, asset name, U height and a few custom property's)

 

We are looking for a few to simplify this proces (maybe with the use op API webservices)

the idea is to dump the data in MS EXCEL for making management reports

 

2 Replies 2
gsterling
Commander Commander
Commander
0 Likes
0
960

Re: ITA API Webservices

Hello Mark

 

Have to tried using the REST api's which are provided with ITA?

 

If you use a browser to connect to your ITA server at https://<ita-server-host-or-ip>/api/current

 

You'll be asked for credentials for an ITA user account, enter valid credentials and you should see this view. The great thing about this view is that its fully interactive in that you can walk through individual API calls and test them so you get a better understanding of how they work. I'll run through one example below using the assets api GET call.

 

REST-pict-1.JPG

 

If you click on any of the entry headers (like assets) or the "Show/Hide" button each entry can be expanded so you can see its API options and features. As an example I have pasted info for the assets api call below

 

The individual items in this section can also be expanded so you can see the details of each individual call.

 

I expanded the "GET /assets" entry below. You'll see a full explanation of the call, the required and/or optional parameters and an opportunity to test it.

 

Please NOTE: my below example is a GET command so its a query. There are also PUT, POST, and DELETE commands to update, create, and delete assets. Any operations performed in this view are worked against the ITA server to which you're connected ... so if you update, create or delete, you are changing data on your ITA server. So if you are experimenting make sure your experimenting on non-important data.

 

REST-Assets-GET-1.JPG

I changed the above optional field "recursive" to true so I don't get only the top level asset and then click "Try it out!". The output from "Try it out!" might look like this (from my demo server).

 

You'll notice you'll be provided with two examples for making the call yourself via "curl" for linux users and "https" if using a browser or trying to do something via an excel macro or other method.

 

The output from all of the REST calls is JSON format, so for this example the response body section/results include JSON output of all of the high level rooms/locations (folders) in ITA to which the account I used has access ... so yes, what you see is based on the security of the user account used to connect to ITA.

 

There are other calls in the assets section which allow you to query "children", so once you have this high list of rooms and folders, you can run a GET /asset/<asset-id> call to get a specific room and its "children" which would include floor devices, racks and so on. Some programming skills are required to make this work as you need to loop and test.

 

REST-Assets-GET-Result.JPG

 

Hope this helps get you started.

 

Regards

 

Greg Sterling

ChrisLaurentius
Lieutenant JG Lieutenant JG
Lieutenant JG
0 Likes
0
947

Re: ITA API Webservices

Alternatively, use ITA web client's equipment browser, select all columns, remove filters, or filter by location and export it out.

This filter can be saved, for future generation.

 

If going thru api ways, see Greg's explanation below. You'll need way to convert the response to CSV e,g

https://json-csv.com/

 

 

EquipmentBrowser-All.JPG