JobEquipment

Creates and updates job-equipment relationships.

Note that passing a null value for operatorPayClassCode will not null out and reset an already filled in value, since this is a PATCH request.

Securitybearer
Request
Request Body schema:
required

The list of job-equipment relations to be created or updated.

Array ([ 1 .. 100 ] items)
jobId
required
string <uuid>

The job ID.

equipmentId
required
string <uuid>

The equipment ID.

operatorPayClassId
string or null <uuid>

The equipment operator pay class ID.

Responses
204

No Content

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.

patch/api/v1/jobEquipment
Request samples
[
  • {
    }
]

Returns job equipment

This call returns a list of job equipment for the specified business unit, job or equipment.

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

The business unit ID.

jobId
string <uuid>

The job ID.

equipmentId
string <uuid>

The equipment ID.

limit
integer <int32>
Default: 1000

The maximum number of results that should be returned.

cursor
string

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

Responses
get/api/v1/jobEquipment
Request samples 
Response samples 
application/json
[
  • {
    }
]
Delete job-equipment relationships.
Securitybearer 
Request 
query Parameters
businessUnitId
string <uuid> 
The business unit ID.


 
jobId
string <uuid> 
The job ID.


 
equipmentId
string <uuid> 
The equipment ID.


 
Responses 
204
No Content


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.


delete/api/v1/jobEquipment
Request samples