Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Notifications
Login / Register
Community
Community
Notifications
close
  • Forums
  • Knowledge Center
  • Events & Webinars
  • Ideas
  • Blogs
Help
Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Login / Register
Sustainability
Sustainability

Join our "Ask Me About" community webinar on May 20th at 9 AM CET and 5 PM CET to explore cybersecurity and monitoring for Data Center and edge IT. Learn about market trends, cutting-edge technologies, and best practices from industry experts.
Register and secure your Critical IT infrastructure

ITA API Webservices

EcoStruxure IT forum

Schneider Electric support forum about installation and configuration for DCIM including EcoStruxure IT Expert, IT Advisor, Data Center Expert, and NetBotz

cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
  • Home
  • Schneider Electric Community
  • EcoStruxure IT
  • EcoStruxure IT forum
  • ITA API Webservices
Options
  • Subscribe to RSS Feed
  • Mark Topic as New
  • Mark Topic as Read
  • Float this Topic for Current User
  • Bookmark
  • Subscribe
  • Mute
  • Printer Friendly Page
Invite a Co-worker
Send a co-worker an invite to the portal.Just enter their email address and we'll connect them to register. After joining, they will belong to the same company.
You have entered an invalid email address. Please re-enter the email address.
This co-worker has already been invited to the Exchange portal. Please invite another co-worker.
Please enter email address
Send Invite Cancel
Invitation Sent
Your invitation was sent.Thanks for sharing Exchange with your co-worker.
Send New Invite Close
Top Experts
User Count
Cory_McDonald
Admiral Cory_McDonald Admiral
124
Jef
Admiral Jef Admiral
108
gsterling
Captain gsterling Captain
71
APC_Steve
Captain APC_Steve Captain
62
View All

Invite a Colleague

Found this content useful? Share it with a Colleague!

Invite a Colleague Invite
Solved Go to Solution
Back to EcoStruxure IT forum
Solved
Mark1
Mark1
Cadet

Posted: ‎2020-04-10 03:40 AM

0 Likes
2
2105
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2020-04-10 03:40 AM

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

 

Labels
  • Labels:
  • IT Advisor
Reply

Link copied. Please paste this link to share this article on your social media post.

  • All forum topics
  • Previous Topic
  • Next Topic

Accepted Solutions
gsterling
Captain gsterling Captain
Captain

Posted: ‎2020-04-10 04:33 AM

0 Likes
0
2096
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2020-04-10 04:33 AM

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

See Answer In Context

Reply

Link copied. Please paste this link to share this article on your social media post.

Replies 2
gsterling
Captain gsterling Captain
Captain

Posted: ‎2020-04-10 04:33 AM

0 Likes
0
2097
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2020-04-10 04:33 AM

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

Reply

Link copied. Please paste this link to share this article on your social media post.

ChrisLaurentius
ChrisLaurentius Schneider Alumni (Retired)
Schneider Alumni (Retired)

Posted: ‎2020-04-13 06:06 PM

0 Likes
0
2083
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • Subscribe to RSS Feed
  • Permalink
  • Print
  • Email to a Friend
  • Report Inappropriate Content

Link copied. Please paste this link to share this article on your social media post.

Posted: ‎2020-04-13 06:06 PM

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

 

 

 

Reply

Link copied. Please paste this link to share this article on your social media post.

Preview Exit Preview

never-displayed

You must be signed in to add attachments

never-displayed

 
To The Top!

Forums

  • APC UPS Data Center Backup Solutions
  • EcoStruxure IT
  • EcoStruxure Geo SCADA Expert
  • Metering & Power Quality
  • Schneider Electric Wiser

Knowledge Center

Events & webinars

Ideas

Blogs

Get Started

  • Ask the Community
  • Community Guidelines
  • Community User Guide
  • How-To & Best Practice
  • Experts Leaderboard
  • Contact Support
Brand-Logo
Subscribing is a smart move!
You can subscribe to this board after you log in or create your free account.
Forum-Icon

Create your free account or log in to subscribe to the board - and gain access to more than 10,000+ support articles along with insights from experts and peers.

Register today for FREE

Register Now

Already have an account? Login

Terms & Conditions Privacy Notice Change your Cookie Settings © 2025 Schneider Electric

This is a heading

With achievable small steps, users progress and continually feel satisfaction in task accomplishment.

Usetiful Onboarding Checklist remembers the progress of every user, allowing them to take bite-sized journeys and continue where they left.

of