JobEmployee

Returns job employees

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

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

The business unit ID.

jobId
string <uuid>

The job ID.

employeeId
string <uuid>

The employee 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/jobEmployees
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Delete job-employee relationships.
Either jobId or employeeId need to be provided


Securitybearer 
Request 
query Parameters
businessUnitId
string <uuid> 
The business unit ID.


 
jobId
string <uuid> 
The job ID.


 
employeeId
string <uuid> 
The employee 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/jobEmployees
Request samples 
Creates and updates job-employee relationships.
Note that passing a null value for defaultPayClassId or assignedEquipmentId 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-employee relations to be created or updated.


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


 
employeeId
required
string <uuid> 
The employee id.


 
defaultPayClassId
string or null <uuid> 
The pay class id for the employee on the job.


 
assignedEquipmentId
string or null <uuid> 
The assigned 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.


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