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!

How to use the DCO 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
  • How to use the DCO 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
64
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
DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

0 Likes
8
1516
  • 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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

How to use the DCO REST API?

Hi team:

    I'm using the DCO offline demo 8.0 to do development, I want to get information of the datacenter such as assets of customer ,  display of the sensors in the rack...which I can see in the client, when I use  https:///api/current  I have some troubles.

such as I want to see the assets of a customer, I need to fill the blank in the red retc, but how can i get or set the id? I tried username but the response is wrong. In other api asset-id,room-id...are needed,where can i find the id?   Is there some examples for the using of api? I'm a newbie.

 

Looking forward to your answer.

(CID:110007532)

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

Accepted Solutions
DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

0 Likes
3
1516
  • 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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

Hi Ren

Under the customer webservice, please take a look at the first GET method. The method gets all the customers the current user has access to. In the response you can then see the customer-id - which is typically a number.

An example reply:

[ { "id": "110", "company": "Some company name", "department": "110", "customerType": "EXTERNAL_CUSTOMER", "contact": null, "phoneNumber": null, "tenantPortalState": "NOT_ACTIVATED", "technicalContact": { "name": null, "email": null } } ]

So here the customer-id is 110.

Hope this helps.

Best,

Niels

(CID:110007542)

See Answer In Context

Reply

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

Replies 8
DCIM_Support
Picard DCIM_Support
Picard

Posted: ‎2020-07-03 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

0 Likes
3
1517
  • 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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

Hi Ren

Under the customer webservice, please take a look at the first GET method. The method gets all the customers the current user has access to. In the response you can then see the customer-id - which is typically a number.

An example reply:

[ { "id": "110", "company": "Some company name", "department": "110", "customerType": "EXTERNAL_CUSTOMER", "contact": null, "phoneNumber": null, "tenantPortalState": "NOT_ACTIVATED", "technicalContact": { "name": null, "email": null } } ]

So here the customer-id is 110.

Hope this helps.

Best,

Niels

(CID:110007542)

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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

In response to DCIM_Support
0 Likes
0
1516
  • 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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

Thanks for your answer, it helps me a lot. I have another question, can I get the detail information of the server in the DC, such as the temperature & the power consumption of a server ? if it can be, what should i do? hoping your answer. Best,

(CID:110007618)

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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

In response to DCIM_Support
0 Likes
0
1516
  • 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 08:51 AM . Last Modified: ‎2024-04-08 03:44 AM

Can i got these information from the RESTful API ? if not ,what can i do? Please show me an example,thank you. Best Regards.

(CID:110007620)

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 08:52 AM . Last Modified: ‎2024-04-08 03:44 AM

In response to DCIM_Support
0 Likes
0
1516
  • 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 08:52 AM . Last Modified: ‎2024-04-08 03:44 AM

Hi Ren, sorry I didn't see the comments here. Will answer you in the new question you posted.

(CID:110007801)

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 08:52 AM . Last Modified: ‎2024-04-08 03:44 AM

0 Likes
1
1516
  • 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 08:52 AM . Last Modified: ‎2024-04-08 03:44 AM

Here is a video tutorial Introduction to REST API

To get 'customer-id' you could use GET customers, which will list all customers accessible to the current user.

https://dcimsupport.apc.com/DCOAPIdoc/#!/customers/getCustomers

 

(CID:110007548)

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 08:52 AM . Last Modified: ‎2024-04-08 03:43 AM

In response to DCIM_Support
0 Likes
0
1516
  • 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 08:52 AM . Last Modified: ‎2024-04-08 03:43 AM

Thanks for your answer, it helps me a lot. I have another question, can I get the detail information of the server in the DC, such as the temperature & the power consumption of a server ? if it can be, what should i do? Are these information gotten from the restful api ? Please show me an example, thanks. hoping your answer. Best,

(CID:110007619)

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 08:52 AM . Last Modified: ‎2024-04-08 03:43 AM

0 Likes
0
1516
  • 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 08:52 AM . Last Modified: ‎2024-04-08 03:43 AM

To get the ids required by specific operations you first need to query the operations that provide the required ids.

You can get the customer-id by querying the /customers GET operation.

The asset-id and room-id you can get from the /asset GET operation or the /assets/search GET operation. 

The response from the queries depends on your permissions.

(CID:110007549)

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 08:52 AM . Last Modified: ‎2023-10-22 02:36 AM

0 Likes
0
1516
  • 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 08:52 AM . Last Modified: ‎2023-10-22 02:36 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