Net3 API Interface for Customer Portal

<back to all web services

Cost

Requires Authentication
The following routes are available for this service:
POST/cost
Cost Parameters:
NameParameterData TypeRequiredDescription
userIdbodystringNo
CostResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeCostNo
ResponseStatusformResponseStatusNo
TypeCost Parameters:
NameParameterData TypeRequiredDescription
ComputeCostformSimpleReportResponsesNo
ComputeTotalCostformdoubleNo
BRSTotalCostformdoubleNo
DRSTotalCostformdoubleNo
TotalCostformdoubleNo
SimpleReportResponses Parameters:
NameParameterData TypeRequiredDescription
resultformList<SimpleReportResponse>No
TotalCostformdoubleNo
SimpleReportResponse Parameters:
NameParameterData TypeRequiredDescription
DatacenterLocationformDatacenterLocationsNo
ReportDescriptionformstringNo
CostModelNameformstringNo
TotalCostformdoubleNo
TotalEntitiesformintNo
reportIdformintNo
reportPDFLinkformstringNo
reportXLSLinkformstringNo
EntitiesformList<SimpleReportResponseEntity>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
errorMessageformstringNo
errorCodeformintNo
errorStatusformboolNo
DatacenterLocations Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL
SimpleReportResponseEntity Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformintNo
ParentformintNo
TotalCostformdoubleNo
EntityCostformdoubleNo
CostModelformSimpleReportResponseEntityCostModelNo
reportEntityIdformintNo
parentReportEntityIdformintNo
idformintNo
SimpleReportResponseEntityCostModel Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EntityCostformdoubleNo
TotalCostformdoubleNo
VarianceDataformSimpleReportResponseEntityCostModelVarianceDataNo
ResourcesformList<SimpleReportResponseEntityCostModelResource>No
FixedCostsformSimpleReportResponseEntityCostModelFixedCostsNo
idformintNo
SimpleReportResponseEntityCostModelVarianceData Parameters:
NameParameterData TypeRequiredDescription
GranularityformstringNo
TimeformstringNo
CostformstringNo
SimpleReportResponseEntityCostModelResource Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UsageformdecimalNo
CostformdoubleNo
idformintNo
SimpleReportResponseEntityCostModelFixedCosts Parameters:
NameParameterData TypeRequiredDescription
FixedCostformdoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /cost HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"userId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"computeCost":{"result":[{"datacenterLocation":"GMU","reportDescription":"String","costModelName":"String","totalCost":0,"totalEntities":0,"reportId":0,"reportPDFLink":"String","reportXLSLink":"String","entities":[{"name":"String","type":0,"parent":0,"totalCost":0,"entityCost":0,"costModel":{"name":"String","entityCost":0,"totalCost":0,"varianceData":{"granularity":"String","time":"String","cost":"String"},"resources":[{"name":"String","usage":0,"cost":0,"id":0}],"fixedCosts":{"fixedCost":0},"id":0},"reportEntityId":0,"parentReportEntityId":0,"id":0}],"content":"String","errorMessage":"String","errorCode":0,"errorStatus":false}],"totalCost":0},"computeTotalCost":0,"brsTotalCost":0,"drsTotalCost":0,"totalCost":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}