API units for retrieved values

RESTful knowledge exchange

API units for retrieved values

Veeam Logoby Cragdoo » Tue Jul 25, 2017 3:02 pm

Would it be possible to update the API documentation to detail the unit for retrieved values?

For example if I call http://<Enterprise-Manager>:9399/api/reports/summary/repository

I get something like

Code: Select all
<RepositoryReportFrame xmlns="http://www.veeam.com/ent/v1.0" CapacityPlanningReportLink="Workspace/ViewReport.aspx?definition=62221565-102c-4ec8-851b-d61c03d972d1&amp;ShowParams=1">
 <Period>
   <Name>Omega Cloud Vol2</Name>
   <Capacity>322122547200</Capacity>
   <FreeSpace>321163100160</FreeSpace>
   <BackupSize>959447040</BackupSize>
 </Period>


Now is <Capacity> in bits,bytes, kilobytes? I now have to verify the value in say the VBR console, work out the appropriate math function to convert to GB etc

I know it sounds like a small thing, but can make a big difference in the long run.
Cragdoo
Veeam Vanguard
 
Posts: 423
Liked: 144 times
Joined: Tue Sep 27, 2011 12:17 pm
Location: Scotland
Full Name: Craig Dalrymple

Re: API units for retrieved values

Veeam Logoby v.Eremin » Thu Jul 27, 2017 11:21 am

Actually, /reports section has been designed mostly for our internal service needs, it is not intended to be used by RESTful API consumer.

Most of other external entities often contain property describing used unit, /cloud/Tenants/id/ (<ThrottlingSpeedUnit>), for instance.

Thanks.
v.Eremin
Veeam Software
 
Posts: 13563
Liked: 1007 times
Joined: Fri Oct 26, 2012 3:28 pm
Full Name: Vladimir Eremin

Re: API units for retrieved values

Veeam Logoby Cragdoo » Fri Jul 28, 2017 9:06 am

if the API is not for public consumption, then why put it in a public document?
Cragdoo
Veeam Vanguard
 
Posts: 423
Liked: 144 times
Joined: Tue Sep 27, 2011 12:17 pm
Location: Scotland
Full Name: Craig Dalrymple

Re: API units for retrieved values

Veeam Logoby v.Eremin » Fri Jul 28, 2017 1:03 pm

My comment was more about the fact why this section is structured the way it is, not the fact that customers cannot benefit from the information present there. Thanks.
v.Eremin
Veeam Software
 
Posts: 13563
Liked: 1007 times
Joined: Fri Oct 26, 2012 3:28 pm
Full Name: Vladimir Eremin


Return to RESTful API



Who is online

Users browsing this forum: No registered users and 2 guests