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

Ask Me About Webinar: Data Center Assets - Modeling, Cooling, and CFD Simulation
Join our 30-minute expert session on July 10, 2025 (9:00 AM & 5:00 PM CET), to explore Digital Twins, cooling simulations, and IT infrastructure modeling. Learn how to boost resiliency and plan power capacity effectively. Register now to secure your spot!

DCO 8.1 REST API

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
  • DCO 8.1 REST API
Options
  • 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
110
gsterling
Captain gsterling Captain
71
APC_Steve
Captain APC_Steve Captain
65
View All

Invite a Colleague

Found this content useful? Share it with a Colleague!

Invite a Colleague Invite
Back to EcoStruxure IT forum
DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:04 PM . Last Modified: ‎2024-04-07 11:13 PM

0 Likes
17
1567
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:04 PM . Last Modified: ‎2024-04-07 11:13 PM

DCO 8.1 REST API

For the life of me I can't figure out how to perform the equivalent of "getAllDataCenterItems" or "getDataCenterItemsIn" using the Rest API. Maybe its just me, but it seems like the SOAP API was much easier to work with.

Any help is much appreciated.

(CID:123996374)

Labels
  • Labels:
  • Data Center Operation
Reply

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

  • All forum topics
  • Previous Topic
  • Next Topic
Replies 17
DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:04 PM . Last Modified: ‎2024-04-07 11:13 PM

0 Likes
15
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:04 PM . Last Modified: ‎2024-04-07 11:13 PM

Hi David,

A few options:

Try get/asset/{asset ID} and use children option

  1. If  the asset ID provided is for the room, it will return racks, CRACs, UPS, perforated floor etc within that room
  2. If the asset ID provided is for a rack, it will return everything within that racks, e.g servers, rack PDu etc.

These might be related:

1.get / assets/search, where you can specify the asset type, like location, server-room, rack for the query.

Leaving the type empty, and providing the room name will output all the assets within the room, from rack, down to server, so this might be of use to you.

 

2.get/assets/types, listing all the available asset type, that can be used with get/assets/search

 

Regards,

Chris

(CID:123996408)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:04 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:04 PM . Last Modified: ‎2024-04-07 11:12 PM

As an entry point GET /assets will return the top-level elements the user has access to.

Just a note on the GET /assets/search operation: for performance reasons there is a limit to how many elements will be returned. I am pretty sure the limit is 50 items.

 

(CID:123996470)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

I did notice the 50 item return limit. I couldn't locate any info on increasing this limit such as "maxResults=XXXX"

(CID:123996733)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

That is a hardcoded limit that cannot be manipulated at runtime.

(CID:123997063)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

a 50 count limit makes the api calls not useful at all. what if we have more than 50 items to pull back... ?

(CID:128760602)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

The item limit is only for the search API.

If you use the approach Christopherus Laurentius mentioned above with the GET /assets/{asset ID} API with the children option approach you will be able to retrieve all your items. That might require more than one call though.

(CID:128760802)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

Soooo since the ID strings aren't sequential, I have to DDOS the site in order have a script cycle through the search ID call, then pass any hits on and determine if there are available child datasets? Am I missing something?

(CID:129403586)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

Joe, what we have resorted to is use the ETL for queries, then use the API from that point on. The ci_id is the {asset ID}. Maybe there is a better way, but that's what I've been able to use to accomplish most of my tasks. Plus ETL give you everything you may need. Im sorta disappointed with all the API limitation. I really hope that SE sees the value of automation and further development of API functionality on this side of things.

(CID:129404374)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

jda4u - what is your use case? If you want to extract all devices you can follow the scenario I described in the first comment to have a starting point for ids. Then afterwards use the GET /asset/{asset ID} with the children option as suggested by Christopherus Laurentius

That will make you able to create a script that extracts all assets without using the search API.

 

(CID:129405001)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

I agree with Joe: it's so not useful a search api with with a hardcoded limit of 50 items.

I've tried to used GET /asset/{asset ID}, but at the moment I can find all devices I've in my rooms.

Please give us some other hints or examples.


(CID:129407521)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:05 PM . Last Modified: ‎2024-04-07 11:12 PM

Not being able to pull everything I want whenever I want via the search API made me drop the automated ingestion from my project... For the love of god remove the hardcoded limit on the search API and allow customers to set whatever limit they want and monitor our own resources. It's not like I'm going to be pulling the data every minute. It's likely to be a monthly data pull. I've told our DCIM console admin that it's a bad vendor design/decision and to log a DCIM support ticket/feature request on this. If/when the hardcoded cap is removed we would circle back to automate easily/in 5 minutes. Our other engineer said that some of the parent/child relationships aren't actually there to make what was described above to be able to work. I just want to pull all data into our log server for tracking/have other more pressing items to do.

(CID:129407603)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

Please give us an answer: I must read some devices properties in my datacenter (every day or else less frequently).

I can't find  a parent/child relation in my doc  assets, so at the moment Christopherus Laurentiushint isn't useful for me.

I completely agree with Joe: remove hardcoded limit, or give useful suggestions to retry devices 

 

thanks

 

(CID:129407922)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

Hi all,

The search functionality is viable for searching specific rooms, locations or assets. It is an indexed search and limited to 50 items.

It is not build to return all assets from a server.

If the need is to have an API that could return all assets, then that may be posted as a feature request (Feature requests).

Thanks,

Kind regards

(CID:129409017)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

Yep thanks, That's what I advised our internal DCIM admin to request from Support. I recommend having the default limit set to 50, but allow us an option via the API to pull all items where 0=unlimited or such.

(CID:129409194)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

I've just submitted a Feature request as well - thanks.

"I advised our internal DCIM admin to request this, however here is my request as well. I recommend having the default API search limit set to 50, but allow us an option via the API to pull all items where 0=unlimited or such. This would make ingestion into our Log collector much easier and reduce the time needed to spend on developing a script and supporting such a script/process etc. Instead we can just pull all of the data stored in DCIM into our Logs for correlation/metrics etc just one API search command and we're done. Having a hard cap on the API search command forces an undue burden on us and limits the usefulness of the API.

See below for the related thread that I've been commenting on:
http://sxwhelpcenter.ecostruxureit.com/questions/123996374/dco-8.1-rest-api

Thanks for your time and consideration,
Joe Agler"

(CID:129409211)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

In response to DCIM_Support
0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:06 PM . Last Modified: ‎2024-04-07 11:12 PM

Thanks Joe,

Your posted feature request is registered as well, thanks.

Kind regards

(CID:129409255)

Reply

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

DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 10:06 PM . Last Modified: ‎2023-10-22 01:31 AM

0 Likes
0
1566
  • Mark as New
  • Bookmark
  • Subscribe
  • Mute
  • 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-07-03 10:06 PM . Last Modified: ‎2023-10-22 01:31 AM

superhero.png

This question is closed for comments. You're welcome to start a new topic if you have further comments on this issue.

Reply

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

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