Estimates

Get All Estimates

Get All Estimates

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
path Parameters
businessUnitId
required
string <guid>

The required business unit id.

query Parameters
includeExcludedEstimates
boolean
Default: false

Whether to include excluded estimates.

includeDeletedEstimates
boolean
Default: false

Whether to include deleted estimates.

$top
string
Default: ""

The max number of records. (e.g. $top=10)

$skip
string
Default: ""

The number of records to skip. (e.g. $skip=5)

$filter
string
Default: ""

A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b)

$orderby
string
Default: ""

Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc)

Responses
get/api/v2/integration/businessunits/{businessUnitId}/estimates
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "currentTopValue": 100,
  • "currentSkipValue": 0,
  • "nextSkipValue": 100
}
Get an Estimate by Id
Get an Estimate by Id


For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <guid> 
The required id.


 
businessUnitId
required
string <guid> 
The required business unit id.


 
Responses 
get/api/v2/integration/businessunits/{businessUnitId}/estimates/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Key Indicators for an Estimate
Get Key Indicators for an Estimate


For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
businessUnitId
required
string <guid> 
The required business unit id.


 
id
required
string <guid> 
The required estimate id.


 
query Parameters
$top
string
 Default:  ""
The max number of records. (e.g. $top=10)


 
$skip
string
 Default:  ""
The number of records to skip. (e.g. $skip=5)


 
$filter
string
 Default:  ""
A function that must evaluate to true for a record to be returned. (e.g. $filter=estimateId eq c9804e19-acbf-4db2-adaa-04d344dbcc1b)


 
$orderby
string
 Default:  ""
Determines what values are used to order a collection of records. (e.g. $orderby=filters/typeOfWork desc)


 
Responses 
get/api/v2/integration/businessunits/{businessUnitId}/estimates/{id}/kpis
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "currentTopValue": 100,
  • "currentSkipValue": 0,
  • "nextSkipValue": 100
}