Activities

Get All Activities

Get All Activities

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 the pull biditems that have been marked as "excluded" and are not used in calculations.

$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}/activities
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "currentTopValue": 100,
  • "currentSkipValue": 0,
  • "nextSkipValue": 100
}

Get an Activity by Id

Get an Activity 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 activity id.

businessUnitId
required
string <guid>

The required business unit id.

Responses
get/api/v2/integration/businessunits/{businessUnitId}/activities/{id}
Request samples
Response samples
application/json
{
  • "data": {
    }
}