Returns a list of equipment.

post

https://api.hcssapps.com/heavyjob/api/v1/equipment/advancedRequest

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A POCO that represents a request for equipment.

businessUnitId

uuid

required

The business unit id.

equipmentCodes

array of strings | null

List of equipment codes.

equipmentCodes

equipmentIds

array of uuids | null

List of equipment ids.

equipmentIds

jobIds

array of uuids | null

List of job ids.

jobIds

jobTagIds

array of uuids | null

List of job tag ids.

jobTagIds

accountingTemplateName

string | null

The accounting template name.

isActive

boolean | null

The active flag.

isActiveInAnyActiveJobs

boolean | null

The flag to filter equipment to the active status in any of the active jobs.

isDeleted

boolean | null

The soft-deleted flag.

cursor

string | null

Optional.
When there are additional results, the metadata nextCursor field
should be passed to retrieve the next page of results.

limit

int32 | null

The maximum number of results that should be returned.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK