invantive documentation
Invantive Support ForumsLog In / Sign Up

Employees: Bouw7 Employees

popular read only REST

  • Catalog: Bouw7
  • Schema: Organization
  • Label: Employees

Return a list of employees associated with your organization. Return a list of employees associated with your organization.

Can only retrieve data.

Summary

Return a list of employees associated with your organization.

API Source

  • Endpoint: /list/employees
  • Operation: get /list/employees

Performance Characteristics

Characteristic Value
Average access latency (ms) 79
Full scan rows per minute 85,400
Point query rows per minute 666

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
q `` A Heimdall Query Language string

Table Columns

The columns of the table Employees are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
address varchar2 Address filters on the platform, writable, address The address, consisting of street name and house/building number, of the employee.
avatarFileHash varchar2 This field is dynamically hydrated by the 'addFileInformation'-method in the schema factory. filters on the platform, writable, avatarFileHash The hash of the avatar/profile picture of this employee.
birthDate datetime Birth Date filters on the platform, writable, birthDate The birth date of the employee.
caCaMedewerkerDatumtijd datetime CA Medewerker Datumtijd filters on the platform, writable, caCaMedewerkerDatumtijd
caTataPas2Maanden datetime TATA pas - 2 maanden filters on the platform, writable, caTataPas2Maanden
caVcaDatum4Maanden datetime VCA datum - 4 maanden filters on the platform, writable, caVcaDatum4Maanden
city varchar2 City filters on the platform, writable, city The city of residence of this employee.
createdAt datetime Created at filters on the platform, writable, createdAt The creation date of the object in ATOM/ISO-8601 format
createdBy_id int64 Created by ID filters on the platform, writable, createdBy.id The ID of the user.
createdBy_username varchar2 Created by User Name filters on the platform, writable, createdBy.username The username of the user.
dateOfEmployment varchar2 Date of Employment filters on the platform, writable, dateOfEmployment The employment date of the employee.
dateOfResignation varchar2 Date of Resignation filters on the platform, writable, dateOfResignation The resignation date of the employee.
department_branchId int64 Department Branch ID filters on the platform, writable, department.branchId The branch ID of the department.
department_branchName varchar2 Department Branch Name filters on the platform, writable, department.branchName The branch name of this department.
department_id int64 Department ID filters on the platform, writable, department.id The ID of the department.
department_isActive char Department Is Active filters on the platform, writable, department.isActive Whether this department is currently active.
department_name varchar2 Department Name filters on the platform, writable, department.name Display name of the department.
emailAddress varchar2 Email Address filters on the platform, writable, emailAddress The email address of the employee.
external char External filters on the platform, writable, external True if employee is external, otherwise false.
firstName varchar2 First Name filters on the platform, writable, firstName The given name of the employee.
functionTitle varchar2 Function Title filters on the platform, writable, functionTitle The function title of this employee.
hasSignature char Has Signature filters on the platform, writable, hasSignature Whether the employee has a signature file configured.
hourlyRate varchar2 Hourly Rate filters on the platform, writable, hourlyRate The hourly rate.
id int64 ID filters on the platform, writable, id The ID of this employee.
lastName varchar2 Last Name filters on the platform, writable, lastName The family name of the employee.
phoneNumber varchar2 Phone Number filters on the platform, writable, phoneNumber The phone number of the employee.
scabEmployeeId int64 SCAB Employee ID filters on the platform, writable, scabEmployeeId The internal scab employee ID associated with this employee.
sellingHourlyRate varchar2 Selling Hourly Rate filters on the platform, writable, sellingHourlyRate The selling hourly rate.
updatedAt datetime Updated At filters on the platform, writable, updatedAt The creation date of the object in ATOM/ISO-8601 format
updatedBy_id int64 Updated by ID filters on the platform, writable, updatedBy.id The ID of the user.
updatedBy_username varchar2 Updated by User Name filters on the platform, writable, updatedBy.username The username of the user.
user_activatedAt varchar2 User Activated at filters on the platform, writable, user.activatedAt The date the user link was activated in ATOM-format. Null if the user link is inactive.
user_id int64 User ID filters on the platform, writable, user.id The ID of the user.
user_linkId int64 User Link ID filters on the platform, writable, user.linkId The ID of the relation object towards the user.
user_type int64 User Type filters on the platform, writable, user.type The type of user. 0 = No account, 1 = Administrator, 2 = Basic, 3 = Platform
user_username varchar2 User User Name filters on the platform, writable, user.username The username. The e-mail address the user uses to sign in.
workload varchar2 Work Load filters on the platform, writable, workload The amount of hours this employee is working on a weekly basis.
zipCode varchar2 ZIP Code filters on the platform, writable, zipCode The zip code, also known as postal code, associated with the address.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: