RESTful knowledge exchange
Post Reply
Cragdoo
Veeam Vanguard
Posts: 526
Liked: 212 times
Joined: Sep 27, 2011 12:17 pm
Full Name: Craig Dalrymple
Location: Scotland
Contact:

API units for retrieved values

Post by Cragdoo » 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&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.

veremin
Product Manager
Posts: 16710
Liked: 1396 times
Joined: Oct 26, 2012 3:28 pm
Full Name: Vladimir Eremin
Contact:

Re: API units for retrieved values

Post by veremin » 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.

Cragdoo
Veeam Vanguard
Posts: 526
Liked: 212 times
Joined: Sep 27, 2011 12:17 pm
Full Name: Craig Dalrymple
Location: Scotland
Contact:

Re: API units for retrieved values

Post by Cragdoo » Jul 28, 2017 9:06 am

if the API is not for public consumption, then why put it in a public document?

veremin
Product Manager
Posts: 16710
Liked: 1396 times
Joined: Oct 26, 2012 3:28 pm
Full Name: Vladimir Eremin
Contact:

Re: API units for retrieved values

Post by veremin » 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.

Post Reply

Who is online

Users browsing this forum: No registered users and 2 guests