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!

RESTful Api Question/Requests

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
  • RESTful Api Question/Requests
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
64
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 04:29 AM . Last Modified: ‎2024-04-08 11:38 PM

0 Likes
3
689
  • 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 04:29 AM . Last Modified: ‎2024-04-08 11:38 PM

RESTful Api Question/Requests

Awesome job on the new web api, are there any plans to expand it.

I have a few questions/concerns.

  • Connection Between Devices
    • at the moment it seems that you are only able to request power connections between the devices, is there an endpoint to get comm connections or other custom connection.
    • include the connections as part of the asset object just like children that you need to specify include to get the connections.
      • ex: /asset/{id}?include=connections

          • {
                toAssetId:"string",
                id:"string",
                type:"string", //power, comms, custom ??
                cableType:"string", //cat5, fiber multimode, thhn
                terminationType:"string", //rj45,st,sc,bnc,lug, etc...
                conducts:"string" //L1, L2, L3, network, phone, etc
            }
  • Include=children behavior
    • I would like to be able to use include=children with the /assets endpoint that gets the root location for a user, at the moment i have to call /assets and then /assets/{id}?include=children for every asset
    • If you dont use include=children you get a null value in children which tells  me that i haven't pull the children for that asset but if i use include=children all children have children set to [] which mean empty list, i would suggest returning the empty list for children that don't have any children and null when the child has children but you haven't pull them yet. That way i know when to make another request.
    • Another suggestion is an option to make children recursive if possible so that i dont need to call /asset/{id}?include=children for every descendant to be able to get the full tree.
  • /assets/search
    • Is there a way to specify which field to search in?
      • be able to search just the name or in the path ex:
        • /search?q=test&field=name&field=location
        • /search?q=test&fields=name,test
      • Be able to search by path:
        • to get everything under the path"
          • /search?q=Global/NorthAmerica&field=path

(CID:106210687)

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 3
DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 04:29 AM . Last Modified: ‎2024-04-08 11:38 PM

0 Likes
1
689
  • 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 04:29 AM . Last Modified: ‎2024-04-08 11:38 PM

Thanks for the feedback.

The plan is that together with new features there will be new APIs. As more data and functionality is shared between the different clients the existing APIs will also be expanded and new APIs will be created as needed.

  • Connection Between Devices

You are correct that only power connections are exposed in our REST API at the moment.

As the connections are related to an asset it could make sense to add this information as an include option as you described.

  • Include=children behavior

The "children" include option is not added to /assets for performance reasons. Depending on the users permissions all rooms with their floor mounted equipment could be loaded by this request if that option were available for /assets.

I can see the use-case for indicating whether a child of an asset has children. I will create a feature request for this. In any case I can see that having an empty list is misleading when the asset might have children.

The "children" include option is not recursive for performance reasons. On large solutions it could affect all users when trying to load all assets.

  • /assets/search

Currently that are no way to specify a field when searching. A use-case for that feature makes sense though.

Searching in a location makes sense as well. We will keep these suggestions in mind when working on search in the future.

(CID:106210724)

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 04:29 AM . Last Modified: ‎2024-04-08 11:38 PM

In response to DCIM_Support
0 Likes
0
689
  • 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 04:29 AM . Last Modified: ‎2024-04-08 11:38 PM

Hi, has any progress been made for exposing network connections to the REST API?

(CID:110004268)

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 04:29 AM . Last Modified: ‎2023-10-31 11:33 PM

0 Likes
0
689
  • 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 04:29 AM . Last Modified: ‎2023-10-31 11:33 PM

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