CrewBrain MCP Tools Overview

Available CrewBrain tools and their parameters for MCP clients

282
Available Tools
getAbsenceCollection ▼
List Absences
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postAbsence ▼
Create new Absence
Parameters
Assignment string optional
Allowed values:
EMPLOYEE VEHICLE ROOM
AssignmentID integer optional
CategoryID integer optional
DailyRecurringPeriod boolean optional
DayFraction number optional
Format: float
DeputyID integer optional
ExternalID string optional
FixHours number optional
Format: float
From string optional
Format: date-time
Reason string optional
Until string optional
Format: date-time
postAbsenceBulkDelete ▼
Delete Absence for a multiple given ids at once
Parameters
ArrayIds array optional
deleteAbsence ▼
Delete Absence for a given absenceId
Parameters
absenceId integer required
A numeric id of a dataset
getAbsence ▼
Get Absence for a given absenceId
Parameters
absenceId integer required
A numeric id of a dataset
putAbsence ▼
Change Absence for a given absenceId
Parameters
Assignment string optional
Allowed values:
EMPLOYEE VEHICLE ROOM
AssignmentID integer optional
CategoryID integer optional
DailyRecurringPeriod boolean optional
DayFraction number optional
Format: float
DeputyID integer optional
ExternalID string optional
FixHours number optional
Format: float
From string optional
Format: date-time
Reason string optional
Until string optional
Format: date-time
absenceId integer required
A numeric id of a dataset
acceptDeputation ▼
Allows the user to accept a deputy request for a vacation record
Parameters
Boolean boolean optional
absenceId integer required
A numeric id of a dataset
approveAbsence ▼
Allows the user to change the approval status of an absence.
Parameters
Approve boolean optional
Remark string optional
absenceId integer required
A numeric id of a dataset
approveCancellation ▼
Allows the user to change the approval state of a vacation cancellation.
Parameters
Approve boolean optional
Remark string optional
absenceId integer required
A numeric id of a dataset
cancelAbsence ▼
Allows to cancel an approved record.
Parameters
Boolean boolean optional
absenceId integer required
A numeric id of a dataset
performAbsenceMatrix ▼
Allows the logged in user to create or change absences for multiple events & resources at once.
Parameters
deleteWithCategoryIDZero boolean optional
Delete, split and shorten absences with `CategoryID` set to zero
requestBody array optional
getAdditionalDataTypeCollection ▼
List AdditionalDataTypes
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postAdditionalDataType ▼
Create new AdditionalDataType
Parameters
Application boolean optional
Assignment string optional
Allowed values:
EMPLOYEE SUBCONTRACTOR VEHICLE ROOM TASK JOB PROJECT
AssignmentID integer optional
DefaultValue string optional
DropdownValues array optional
IsSelectMisc boolean optional
Mandatory boolean optional
Name string optional
Position integer optional
Print boolean optional
PrintStatements boolean optional
PrintTimerecording boolean optional
PrintTravelexpenses boolean optional
Private boolean optional
QuickEntry boolean optional
TextInputHeight integer optional
Title string optional
Type string optional
Allowed values:
ADDRESS EVENTRESSOURCE_BOOKED CHECKBOX DATE USER TEXTFIELD ROOM HYPERLINK WAGETABLE JOB CLIENT LOCATION DEPARTMENT NUMBER PROJECT DROPDOWN DOCUMENT_SINGLE RICHTEXT DIVIDER DATETIME SIGNATURE COUNTRY RICHTEXT_WITHOUT_TEMPLATES DOCUMENT_MULTIPLE EVENTRESSOURCE TIME
Validation object optional
deleteAdditionalDataType ▼
Delete AdditionalDataType for a given typeId
Parameters
typeId integer required
A numeric id of a dataset
getAdditionalDataType ▼
Get AdditionalDataType for a given typeId
Parameters
typeId integer required
A numeric id of a dataset
putAdditionalDataType ▼
Change AdditionalDataType for a given typeId
Parameters
Application boolean optional
Assignment string optional
Allowed values:
EMPLOYEE SUBCONTRACTOR VEHICLE ROOM TASK JOB PROJECT
AssignmentID integer optional
DefaultValue string optional
DropdownValues array optional
IsSelectMisc boolean optional
Mandatory boolean optional
Name string optional
Position integer optional
Print boolean optional
PrintStatements boolean optional
PrintTimerecording boolean optional
PrintTravelexpenses boolean optional
Private boolean optional
QuickEntry boolean optional
TextInputHeight integer optional
Title string optional
Type string optional
Allowed values:
ADDRESS EVENTRESSOURCE_BOOKED CHECKBOX DATE USER TEXTFIELD ROOM HYPERLINK WAGETABLE JOB CLIENT LOCATION DEPARTMENT NUMBER PROJECT DROPDOWN DOCUMENT_SINGLE RICHTEXT DIVIDER DATETIME SIGNATURE COUNTRY RICHTEXT_WITHOUT_TEMPLATES DOCUMENT_MULTIPLE EVENTRESSOURCE TIME
Validation object optional
typeId integer required
A numeric id of a dataset
getAssignmentSearchAssignments ▼
Returns a list of assignable objects for the given search string.
Parameters
assignmentid integer optional
A numeric id for a assigned object to search
mode string required
Allowed values for mode
Allowed values:
CLIENTS LOCATIONS EMPLOYEES EMPLOYEES_WITH_USER EMPLOYEES_TASKTEMPLATES EMPLOYEES_USERFIRST CONTACTPERSON_CLIENT CONTACTPERSON_LOCATION EVENTS EVENTS_WITHOUT_SUBEVENTS EVENTS_EMPLOYEE_SCHEDULE STATUS PROJECTS EVENTRESOURCES TASKS TASKS_WITHOUT_SUBTASKS EVENTS_PROJECTS DEPARTMENTS DEPARTMENTS_WITH_USER TASKLISTS USERGROUPS EVENTTYPES BRANCHES BRANCHES_WITH_USER WEBHOOKS VEHICLES CERTIFICATES ACTIVITYFIELDS RISKS RISKS_OF_ACTIVITYFIELDS VEHICLES_WITH_PRIVATE EMPLOYEECATEGORIES VEHICLECATEGORIES ROOMCATEGORIES TIMEOFFCATEGORIES TRAVELEXPENSES WAGECOMPONENTDEFINITIONS TASKTEMPLATES ROOMS ROOMS_EVENTLOCATION EVENTRESOURCES_EVENT EVENTRESOURCES_EVENT_WITH_SUBEVENTS EVENTRESOURCES_DRIVERCERTIFICATES SUBCONTRACTOREMPLOYEES LANGUAGES EVENTEMPLOYEES EVENTEMPLOYEES_BOOKED
onlyFutureEntries boolean optional
Shows only future entries from now or depending on `timestamp`, default: `true`
onlyOpenEntries boolean optional
Shows only open entries
parentid integer optional
A numeric id for a parent object to search it's children
search string optional
Search term
timestamp integer optional
An unix timestamp
value string optional
A numeric id or a comma separated list of ids
getBranchCollection ▼
List Branchs
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postBranch ▼
Create new Branch
Parameters
AddressAddition string optional
City string optional
CostCenterID integer optional
Country string optional
Description string optional
EMail string optional
GpsLat number optional
Format: float
GpsLon number optional
Format: float
HouseNumber string optional
IsGpsManual boolean optional
ManagerID integer optional
Name string optional
OfficialHolidayCategories array optional
Phone string optional
State string optional
Street string optional
ZipCode string optional
deleteBranch ▼
Delete Branch for a given branchId
Parameters
branchId integer required
A numeric id of a dataset
getBranch ▼
Get Branch for a given branchId
Parameters
branchId integer required
A numeric id of a dataset
putBranch ▼
Change Branch for a given branchId
Parameters
AddressAddition string optional
City string optional
CostCenterID integer optional
Country string optional
Description string optional
EMail string optional
GpsLat number optional
Format: float
GpsLon number optional
Format: float
HouseNumber string optional
IsGpsManual boolean optional
ManagerID integer optional
Name string optional
OfficialHolidayCategories array optional
Phone string optional
State string optional
Street string optional
ZipCode string optional
branchId integer required
A numeric id of a dataset
getCategoryGenericCollection ▼
List CategoryGenerics
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postCategoryGeneric ▼
Create new CategoryGeneric
Parameters
Assignment string optional
Allowed values:
FIXEDEXPENSES COSTCENTER JOB PERSONNELLEASING_DOCUMENT ROOM EMPLOYEEEQUIPMENT EQUIPMENT_OWNERS EMPLOYEE EMPLOYEEDOCUMENTS VEHICLE RISK_ACTIVITYFIELD RISK
Color string optional
Description string optional
ExternalID string optional
Favorite boolean optional
ParentID integer optional
Position integer optional
ShortRecord boolean optional
Title string optional
Type string optional
Allowed values:
CATEGORY SUBDIVISION
getCategoriesStructure ▼
Returns a structured list of all categories.
Parameters
No parameters required
deleteCategoryGeneric ▼
Delete CategoryGeneric for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
getCategoryGeneric ▼
Get CategoryGeneric for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
putCategoryGeneric ▼
Change CategoryGeneric for a given categoryId
Parameters
Assignment string optional
Allowed values:
FIXEDEXPENSES COSTCENTER JOB PERSONNELLEASING_DOCUMENT ROOM EMPLOYEEEQUIPMENT EQUIPMENT_OWNERS EMPLOYEE EMPLOYEEDOCUMENTS VEHICLE RISK_ACTIVITYFIELD RISK
Color string optional
Description string optional
ExternalID string optional
Favorite boolean optional
ParentID integer optional
Position integer optional
ShortRecord boolean optional
Title string optional
Type string optional
Allowed values:
CATEGORY SUBDIVISION
categoryId integer required
A numeric id of a dataset
getCategoryTimeCollection ▼
List CategoryTimes
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postCategoryTime ▼
Create new CategoryTime
Parameters
Account string optional
Allowed values:
NONE WORKINGHOUR STANDBY CALLOUT OVERTIME UNTERTIME ABSENT
Active boolean optional
AdditionalFunction string optional
Allowed values:
NONE ROUTE
Assignment string optional
Allowed values:
WORKINGHOURS
Calculation number optional
Format: float
Color string optional
Description string optional
ExternalID string optional
Favorite boolean optional
ParentID integer optional
Position integer optional
ShortRecord boolean optional
Title string optional
Type string optional
Allowed values:
CATEGORY SUBDIVISION
getCategoryTime ▼
Get CategoryTime for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
putCategoryTime ▼
Change CategoryTime for a given categoryId
Parameters
Account string optional
Allowed values:
NONE WORKINGHOUR STANDBY CALLOUT OVERTIME UNTERTIME ABSENT
Active boolean optional
AdditionalFunction string optional
Allowed values:
NONE ROUTE
Assignment string optional
Allowed values:
WORKINGHOURS
Calculation number optional
Format: float
Color string optional
Description string optional
ExternalID string optional
Favorite boolean optional
ParentID integer optional
Position integer optional
ShortRecord boolean optional
Title string optional
Type string optional
Allowed values:
CATEGORY SUBDIVISION
categoryId integer required
A numeric id of a dataset
deleteCategoryTime ▼
Delete CategoryTime for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
postCategoryVacation ▼
Create new CategoryVacation
Parameters
Account string optional
Allowed values:
VACATION FLEXTIME SCHOOL FREETIME BLOCKED SICK
Assignment string optional
Allowed values:
VACATION
AutoApprove boolean optional
Bookable boolean optional
Color string optional
Deputy boolean optional
Description string optional
ExternalID string optional
Favorite boolean optional
Icon string optional
IsSelectableForEmployee boolean optional
ParentID integer optional
Position integer optional
ShortRecord boolean optional
Title string optional
Type string optional
Allowed values:
TIMEOFF CALENDARBLOCK OFFICIALHOLIDAY SICKNOTES ABSENCEFREELANCER
getCategoryVacationCollection ▼
List CategoryVacations
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
deleteCategoryVacation ▼
Delete CategoryVacation for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
getCategoryVacation ▼
Get CategoryVacation for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
putCategoryVacation ▼
Change CategoryVacation for a given categoryId
Parameters
Account string optional
Allowed values:
VACATION FLEXTIME SCHOOL FREETIME BLOCKED SICK
Assignment string optional
Allowed values:
VACATION
AutoApprove boolean optional
Bookable boolean optional
Color string optional
Deputy boolean optional
Description string optional
ExternalID string optional
Favorite boolean optional
Icon string optional
IsSelectableForEmployee boolean optional
ParentID integer optional
Position integer optional
ShortRecord boolean optional
Title string optional
Type string optional
Allowed values:
TIMEOFF CALENDARBLOCK OFFICIALHOLIDAY SICKNOTES ABSENCEFREELANCER
categoryId integer required
A numeric id of a dataset
getClientCollection ▼
List Clients
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postClient ▼
Create new Client
Parameters
AddressAddition string optional
City string optional
Country string optional
CustomerNumber integer optional
DefaultPriceListPurchase integer optional
DefaultPriceListRetail integer optional
EMail string optional
ExternalID string optional
ExternalSystem string optional
HouseNumber string optional
Internet string optional
IsDefaultPersonnelLeasingSetForJobs boolean optional
IsPersonnelLeasing boolean optional
Name string optional
Notes string optional
PersonnelLeasingBreakPeriod integer optional
PersonnelLeasingMaxPeriod integer optional
Phone string optional
ShortName string optional
State string optional
Street string optional
ZipCode string optional
deleteClient ▼
Delete Client for a given clientId
Parameters
clientId integer required
A numeric id of a dataset
getClient ▼
Get Client for a given clientId
Parameters
clientId integer required
A numeric id of a dataset
putClient ▼
Change Client for a given clientId
Parameters
AddressAddition string optional
City string optional
Country string optional
CustomerNumber integer optional
DefaultPriceListPurchase integer optional
DefaultPriceListRetail integer optional
EMail string optional
ExternalID string optional
ExternalSystem string optional
HouseNumber string optional
Internet string optional
IsDefaultPersonnelLeasingSetForJobs boolean optional
IsPersonnelLeasing boolean optional
Name string optional
Notes string optional
PersonnelLeasingBreakPeriod integer optional
PersonnelLeasingMaxPeriod integer optional
Phone string optional
ShortName string optional
State string optional
Street string optional
ZipCode string optional
clientId integer required
A numeric id of a dataset
getAdditionalClientDataTypes ▼
Returns the additional data types associated with a client object.
Parameters
clientId integer required
A numeric id of a dataset
bulkPutToClientAdditionalData ▼
Allows the user to edit a multiple additional data types for a client object.
Parameters
clientId integer required
A numeric id of a dataset
requestBody array optional
addDocumentToClientAdditionalData ▼
Allows the user to upload a document if the additional data type for client is of type document.
Parameters
Base64String string optional
Filename string optional
Filetype string optional
clientId integer required
A numeric id of a dataset
overwriteSingleDocument boolean optional
Replaces the existing additional data document, if present
typeId integer required
A numeric id of a dataset
getClientContactPersonCollection ▼
List ClientContactPersons
Parameters
clientId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postClientContactPerson ▼
Create new ClientContactPerson
Parameters
AddressAddition string optional
City string optional
Country string optional
EMail string optional
ExternalID string optional
Firstname string optional
HouseNumber string optional
Lastname string optional
Mobile string optional
Phone string optional
Position string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
State string optional
Street string optional
ZipCode string optional
clientId integer required
A numeric id of a dataset
getClientContactPerson ▼
Get ClientContactPerson for a given contactPersonId
Parameters
clientId integer required
A numeric id of a dataset
contactPersonId integer required
A numeric id of a dataset
putClientContactPerson ▼
Change ClientContactPerson for a given contactPersonId
Parameters
AddressAddition string optional
City string optional
Country string optional
EMail string optional
ExternalID string optional
Firstname string optional
HouseNumber string optional
Lastname string optional
Mobile string optional
Phone string optional
Position string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
State string optional
Street string optional
ZipCode string optional
clientId integer required
A numeric id of a dataset
contactPersonId integer required
A numeric id of a dataset
deleteClientContactPerson ▼
Delete ClientContactPerson for a given contactPersonId
Parameters
clientId integer required
A numeric id of a dataset
contactPersonId integer required
A numeric id of a dataset
getContractCollection ▼
List Contracts
Parameters
eventId integer optional
Search for contracts by the given event id
eventRessourceId integer optional
Search for contracts by the given event ressource id
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
includeRessources boolean optional
Include contracts for event ressources when filtering by event id
includeSubevents boolean optional
Include contracts for subevents when filtering by event id
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
token string optional
Search for contracts by the given token
postContract ▼
Create new Contract
Parameters
Assignment string optional
Allowed values:
JOB CLIENT EMPLOYEE JOBEMPLOYEE
AssignmentIDs array optional
ContractText string optional
TemplateID integer optional
Type string optional
Allowed values:
EXTERNALWORKCONTRACT FRAMEWORKAGREEMENTCONTRACT PERSONNELLEASING_TRANSFERCONTRACT WORKCONTRACT PERSONNELLEASING_CONCRETIZATION PERSONNELLEASING_EMPLOYMENTOVERVIEW PERSONNELLEASING_EMPLOYMENTRECORDS PERSONNELLEASING_CUSTOM1 CALCULATION
getContractOverviewForEvent ▼
Returns an overview of all contracts associated with this event.
Parameters
eventId integer optional
The event that the contracts should be given for
includeSubevents boolean optional
Include contracts for subevents
deleteContract ▼
Delete Contract for a given contractId
Parameters
contractId integer required
A numeric id of a dataset
getContract ▼
Get Contract for a given contractId
Parameters
contractId integer required
A numeric id of a dataset
createContractDocument ▼
Creates the pdf document for a given contract.
Parameters
ContactPersonID integer optional
contractId integer required
A numeric id of a dataset
onlyCreate boolean optional
Only creates contract, but doesn't send it via email, default: true
sendContractDocument ▼
Sends the contract document to the recipient defined in the contract.
Parameters
ContactPersonID integer optional
contractId integer required
A numeric id of a dataset
sendAgain boolean optional
Allows to send a contract again, if already sent, default: false
getCountryCollection ▼
List Countrys
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
getCountryStateCollection ▼
List CountryStates
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
getAppDashboard ▼
Returns information used for the overview dashboard in our App.
Parameters
No parameters required
getDashboardCollection ▼
List Dashboards
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postDashboard ▼
Create new Dashboard
Parameters
Description string optional
EmployeeID integer optional
IsFix boolean optional
Layout string optional
Allowed values:
LAYOUT_100 LAYOUT_5050 LAYOUT_6633 LAYOUT_3366 LAYOUT_333333 LAYOUT_25252525
Name string optional
PublicVisibility string optional
Allowed values:
ONLYUSER ALL USERGROUPS DEPARTMENTS BRANCHES
deleteDashboard ▼
Delete Dashboard for a given dashboardId
Parameters
dashboardId integer required
A numeric id of a dataset
getDashboard ▼
Get Dashboard for a given dashboardId
Parameters
dashboardId integer required
A numeric id of a dataset
putDashboard ▼
Change Dashboard for a given dashboardId
Parameters
Description string optional
EmployeeID integer optional
IsFix boolean optional
Layout string optional
Allowed values:
LAYOUT_100 LAYOUT_5050 LAYOUT_6633 LAYOUT_3366 LAYOUT_333333 LAYOUT_25252525
Name string optional
PublicVisibility string optional
Allowed values:
ONLYUSER ALL USERGROUPS DEPARTMENTS BRANCHES
dashboardId integer required
A numeric id of a dataset
getDashboardWidgetCollection ▼
List DashboardWidgets
Parameters
dashboardId integer required
A numeric id of a dataset
expand array optional
Comma separated list of optional fields, options: `HtmlContent`, `JsonContent`
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postDashboardWidget ▼
Create new DashboardWidget
Parameters
Color string optional
Allowed values:
LIGHTGRAY BLUEGRAY VIOLET PINK LIGHTBLUE LIGHTGREEN ORANGE
Column integer optional
Data object optional
Name string optional
Allowed values:
ABSENCES MY_REPORTS ACTIVE_EMPLOYEES NOTES TASK_FILTER OPEN_REQUESTS TASK_OVERVIEW OPEN_BOOKINGS JOB_POSTINGS OPEN_JOBS PENDING_APPROVALS PERSONNEL_ACCOUNTS CHANGELOG DID_YOU_KNOW EXPIRING_CERTIFICATES SUBCONTRACTOR_REQUESTS EXTERNAL_WORKCONTRACTS TICKET_SALES FIXTEXT INVALID_WORK_TIMES UNSIGNED_CONTRACT UPCOMING_INSPECTIONS FREE_TIMES BIRTHDAYS JOB_FILTER VACATION JOBS_WITHOUT_TIME ONGOING_JOBS MY_TASKS MY_JOBS TIME_TRACKING CENTRAL_TIME_CLOCK WORKINGTIME_VIOLATIONS_DE
Position integer optional
dashboardId integer required
A numeric id of a dataset
deleteDashboardWidget ▼
Delete DashboardWidget for a given widgetId
Parameters
dashboardId integer required
A numeric id of a dataset
widgetId integer required
A numeric id of a dataset
getDashboardWidget ▼
Get DashboardWidget for a given widgetId
Parameters
dashboardId integer required
A numeric id of a dataset
expand array optional
Comma separated list of optional fields, options: `HtmlContent`, `JsonContent`
widgetId integer required
A numeric id of a dataset
putDashboardWidget ▼
Change DashboardWidget for a given widgetId
Parameters
Color string optional
Allowed values:
LIGHTGRAY BLUEGRAY VIOLET PINK LIGHTBLUE LIGHTGREEN ORANGE
Column integer optional
Data object optional
Position integer optional
dashboardId integer required
A numeric id of a dataset
widgetId integer required
A numeric id of a dataset
getDashboardWidgetDatamodel ▼
Returns the data model of a dashboard widget.
Parameters
dashboardId integer required
A numeric id of a dataset
widgetId integer required
A numeric id of a dataset
setDashboardWidgetData ▼
Allows the user to change the configuration data of a dashboard widget.
Parameters
dashboardId integer required
A numeric id of a dataset
widgetId integer required
A numeric id of a dataset
getDepartmentCollection ▼
List Departments
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postDepartment ▼
Create new Department
Parameters
CostCenterID integer optional
Description string optional
HeadID integer optional
Name string optional
ParentID integer optional
deleteDepartment ▼
Delete Department for a given departmentId
Parameters
departmentId integer required
A numeric id of a dataset
getDepartment ▼
Get Department for a given departmentId
Parameters
departmentId integer required
A numeric id of a dataset
putDepartment ▼
Change Department for a given departmentId
Parameters
CostCenterID integer optional
Description string optional
HeadID integer optional
Name string optional
ParentID integer optional
departmentId integer required
A numeric id of a dataset
getDriverslogCollection ▼
List Driverslogs
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postDriverslog ▼
Create new Driverslog
Parameters
Destination string optional
DriverID integer optional
EndCheck boolean optional
EndLat number optional
Format: float
EndLon number optional
Format: float
EndMileage number optional
Format: float
EndTime string optional
Format: date-time
EventID integer optional
Notes string optional
Purpose string optional
StartCheck boolean optional
StartLat number optional
Format: float
StartLon number optional
Format: float
StartMileage number optional
Format: float
StartTime string optional
Format: date-time
TravelExpensesID integer optional
VehicleID integer optional
deleteDriverslog ▼
Delete Driverslog for a given driverslogId
Parameters
driverslogId integer required
A numeric id of a dataset
getDriverslog ▼
Get Driverslog for a given driverslogId
Parameters
driverslogId integer required
A numeric id of a dataset
putDriverslog ▼
Change Driverslog for a given driverslogId
Parameters
Destination string optional
DriverID integer optional
EndCheck boolean optional
EndLat number optional
Format: float
EndLon number optional
Format: float
EndMileage number optional
Format: float
EndTime string optional
Format: date-time
EventID integer optional
Notes string optional
Purpose string optional
StartCheck boolean optional
StartLat number optional
Format: float
StartLon number optional
Format: float
StartMileage number optional
Format: float
StartTime string optional
Format: date-time
TravelExpensesID integer optional
VehicleID integer optional
driverslogId integer required
A numeric id of a dataset
performEventResourceMatrix ▼
Allows the logged in user to create or change event ressources for multiple events & resources at once.
Parameters
requestBody array optional
postEventResourceMatrixBulkDelete ▼
Delete EventResourceMatrix for a multiple given ids at once
Parameters
ArrayIds array optional
getEventCollection ▼
List Events
Parameters
expand array optional
Comma separated list of optional fields, options: `Scheduler`, `ProjectManager`, `ContactPersonLocation`, `ContactPersonClient`, `Location`, `Client`, `AdditionalDatas`, `EventResources`, `EventResourcesIncludeDeleted`, `EventResourceCategories`
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
includeSubevents boolean optional
Include subevents in event result, default: false
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEvent ▼
Create new Event
Parameters
Admission string optional
BillingFactor number optional
Format: float
BranchID integer optional
Break number optional
Format: float
BreakTimestamp string optional
CategoryID integer optional
Checkbox1Name string optional
Checkbox2Name string optional
Checkbox3Name string optional
Checkbox4Name string optional
Checkbox5Name string optional
Checkbox6Name string optional
ClientID integer optional
Completed boolean optional
DateFrom string optional
Format: date-time
DateUntil string optional
Format: date-time
DepartmentID integer optional
Description string optional
EventIDManual string optional
EventworxIDs string optional
ExternalDescription string optional
ExternalID string optional
ExternalStatus string optional
Allowed values:
UNKNOWN OK NO_EMPLOYEES NO_ACCESS NO_RESPONSE CANCELED
ExternalSystem string optional
Allowed values:
EASYJOB EASYJOB_BECAUSE_SOFTWARE EPIRENT FLEX CREWBRAIN HIREHOP BANKETTPROFI JOBTURA MOUSECLICK PRIAVA RENTMAN EVENTWORX EVENTWORX_2 E2E INTELLIEVENT
GuaranteedHours number optional
Format: float
GuaranteedHoursMethod string optional
Allowed values:
GUARANTEEDHOURS_DAY GUARANTEEDHOURS_JOB
HideInCalendar boolean optional
IsPersonnelLeasing boolean optional
Kind string optional
Allowed values:
WORKDAY TRAVELDAY OFFDAY
LastPurchaseCalculation string optional
Format: date-time
LastRetailCalculation string optional
Format: date-time
LocationID integer optional
OvertakeToSubevents object optional
PaidBreaks boolean optional
ParentID integer optional
Presale boolean optional
ProjectTimeCalculation boolean optional
Public boolean optional
PublicDescription string optional
PurchasePricelistID integer optional
RetailPrice number optional
Format: float
RetailPriceDailyRateAdditionalAmount number optional
Format: float
RetailPriceDailyRateAdditionalType string optional
RetailPriceDailyRateHours number optional
Format: float
RetailPriceMinimumHours number optional
Format: float
RetailPriceTier string optional
RetailPriceType string optional
RetailPricelistID integer optional
ShiftID integer optional
SkipInSync boolean optional
Start string optional
Status string optional
Allowed values:
GRAY GREEN ORANGE RED PURPLE YELLOW TURQUOISE PINK BROWN
TaskCalculation boolean optional
TasksCreated boolean optional
TicketStatus string optional
Allowed values:
UNKNOWN FREE_ENTRY FREE_WITH_TICKET TICKETS_AVAILABLE SOLD_OUT POSTPONED CANCELED
TicketURL string optional
TimeQuotas string optional
TimeRecording string optional
Allowed values:
NONE ALL SCHEDULERS PROJECTMANAGERS SCHEDULERS_PROJECTMANAGERS
Timezone string optional
TitelExport string optional
Title string optional
TotalHours number optional
Format: float
TotalPurchaseExpenses number optional
Format: float
TotalRetailExpenses number optional
Format: float
TotalTravelExpenses number optional
Format: float
Type string optional
Allowed values:
JOB PROJECT
postEventBulkDelete ▼
Delete Event for a multiple given ids at once
Parameters
ArrayIds array optional
deleteEvent ▼
Delete Event for a given eventId
Parameters
eventId integer required
A numeric id of a dataset
getEvent ▼
Get Event for a given eventId
Parameters
eventId integer required
A numeric id of a dataset
expand array optional
Comma separated list of optional fields, options: `Scheduler`, `ProjectManager`, `ContactPersonLocation`, `ContactPersonClient`, `Location`, `Client`, `AdditionalDatas`, `EventResources`, `EventResourcesIncludeDeleted`, `EventResourceCategories`
putEvent ▼
Change Event for a given eventId
Parameters
Admission string optional
BillingFactor number optional
Format: float
BranchID integer optional
Break number optional
Format: float
BreakTimestamp string optional
CategoryID integer optional
Checkbox1Name string optional
Checkbox2Name string optional
Checkbox3Name string optional
Checkbox4Name string optional
Checkbox5Name string optional
Checkbox6Name string optional
ClientID integer optional
Completed boolean optional
DateFrom string optional
Format: date-time
DateUntil string optional
Format: date-time
DepartmentID integer optional
Description string optional
EventIDManual string optional
EventworxIDs string optional
ExternalDescription string optional
ExternalID string optional
ExternalStatus string optional
Allowed values:
UNKNOWN OK NO_EMPLOYEES NO_ACCESS NO_RESPONSE CANCELED
ExternalSystem string optional
Allowed values:
EASYJOB EASYJOB_BECAUSE_SOFTWARE EPIRENT FLEX CREWBRAIN HIREHOP BANKETTPROFI JOBTURA MOUSECLICK PRIAVA RENTMAN EVENTWORX EVENTWORX_2 E2E INTELLIEVENT
GuaranteedHours number optional
Format: float
GuaranteedHoursMethod string optional
Allowed values:
GUARANTEEDHOURS_DAY GUARANTEEDHOURS_JOB
HideInCalendar boolean optional
IsPersonnelLeasing boolean optional
Kind string optional
Allowed values:
WORKDAY TRAVELDAY OFFDAY
LastPurchaseCalculation string optional
Format: date-time
LastRetailCalculation string optional
Format: date-time
LocationID integer optional
OvertakeToSubevents object optional
PaidBreaks boolean optional
ParentID integer optional
Presale boolean optional
ProjectTimeCalculation boolean optional
Public boolean optional
PublicDescription string optional
PurchasePricelistID integer optional
RetailPrice number optional
Format: float
RetailPriceDailyRateAdditionalAmount number optional
Format: float
RetailPriceDailyRateAdditionalType string optional
RetailPriceDailyRateHours number optional
Format: float
RetailPriceMinimumHours number optional
Format: float
RetailPriceTier string optional
RetailPriceType string optional
RetailPricelistID integer optional
ShiftID integer optional
SkipInSync boolean optional
Start string optional
Status string optional
Allowed values:
GRAY GREEN ORANGE RED PURPLE YELLOW TURQUOISE PINK BROWN
TaskCalculation boolean optional
TasksCreated boolean optional
TicketStatus string optional
Allowed values:
UNKNOWN FREE_ENTRY FREE_WITH_TICKET TICKETS_AVAILABLE SOLD_OUT POSTPONED CANCELED
TicketURL string optional
TimeQuotas string optional
TimeRecording string optional
Allowed values:
NONE ALL SCHEDULERS PROJECTMANAGERS SCHEDULERS_PROJECTMANAGERS
Timezone string optional
TitelExport string optional
Title string optional
TotalHours number optional
Format: float
TotalPurchaseExpenses number optional
Format: float
TotalRetailExpenses number optional
Format: float
TotalTravelExpenses number optional
Format: float
eventId integer required
A numeric id of a dataset
getAdditionalEventDataTypes ▼
Returns the additional data types associated with an event.
Parameters
eventId integer required
A numeric id of a dataset
bulkPutToEventAdditionalData ▼
Allows the user to edit a multiple additional data types for an event.
Parameters
eventId integer required
A numeric id of a dataset
requestBody array optional
addDocumentToEventAdditionalData ▼
Allows the user to upload a document if the additional data type for an event is of type document.
Parameters
Base64String string optional
Filename string optional
Filetype string optional
eventId integer required
A numeric id of a dataset
overwriteSingleDocument boolean optional
Replaces the existing additional data document, if present
typeId integer required
A numeric id of a dataset
getEventAttachmentCollection ▼
List EventAttachments
Parameters
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEventAttachment ▼
Create new EventAttachment
Parameters
Base64String string optional
Filename string optional
Filetype string optional
Visibility string optional
Allowed values:
ALL REQUESTED_BOOKED BOOKED SCHEDULERS USERGROUPS
VisibilityUsergroups array optional
eventId integer required
A numeric id of a dataset
postEventAttachmentBulkDelete ▼
Delete EventAttachment for a multiple given ids at once
Parameters
ArrayIds array optional
eventId integer required
A numeric id of a dataset
getEventAttachmentStructure ▼
Returns a structure of all attachments contained in this event and its subevents.
Parameters
eventId integer required
A numeric id of a dataset
startAtRoot boolean optional
Shows the structure starting from root event, default: false
deleteEventAttachment ▼
Delete EventAttachment for a given attachmentId
Parameters
attachmentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
getEventAttachment ▼
Get EventAttachment for a given attachmentId
Parameters
asBase64 boolean optional
Output document as base 64 string, default: false
attachmentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
billEvent ▼
Allows the user to change the billed state of an event
Parameters
Boolean boolean optional
eventId integer required
A numeric id of a dataset
cancelEvent ▼
Allows to cancel an event entirely. It will also notify all resources on this event about the cancellation.
Parameters
Boolean boolean optional
eventId integer required
A numeric id of a dataset
getEventCommentCollection ▼
List EventComments
Parameters
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
includeParentEvents boolean optional
Include parent event comments
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEventComment ▼
Create new EventComment
Parameters
Comment string optional
ParentID integer optional
Visibility string optional
Allowed values:
ALL BOOKED SCHEDULER PROJECTMANAGER SCHEDULERANDPROJECTMANAGER
eventId integer required
A numeric id of a dataset
deleteEventComment ▼
Delete EventComment for a given commentId
Parameters
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
getEventComment ▼
Get EventComment for a given commentId
Parameters
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
putEventComment ▼
Change EventComment for a given commentId
Parameters
Comment string optional
ParentID integer optional
Visibility string optional
Allowed values:
ALL BOOKED SCHEDULER PROJECTMANAGER SCHEDULERANDPROJECTMANAGER
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
getEventCommentAttachmentCollection ▼
List EventCommentAttachments
Parameters
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEventCommentAttachment ▼
Create new EventCommentAttachment
Parameters
Base64String string optional
Filename string optional
Filetype string optional
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
deleteEventCommentAttachment ▼
Delete EventCommentAttachment for a given attachmentId
Parameters
attachmentId integer required
A numeric id of a dataset
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
getEventCommentAttachment ▼
Get EventCommentAttachment for a given attachmentId
Parameters
asBase64 boolean optional
Output document as base 64 string, default: false
attachmentId integer required
A numeric id of a dataset
commentId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
convertEvent ▼
Allows to convert an event from project to job or to move it between projects and jobs.
Parameters
ParentID integer optional
Type string optional
Allowed values:
JOB PROJECT
eventId integer required
A numeric id of a dataset
copyEvent ▼
Allows to copy an event.
Parameters
Categories boolean optional
CopyInterval string optional
Allowed values:
DAILY WEEKLY MONTHLY YEARLY
CopyType string optional
Allowed values:
WITHOUT_DATE ONCE MULTIPLE TARGETEVENT
CopyTypeMultipleData object optional
CopyTypeOnceData object optional
CopyTypeTargetEventData object optional
Documents boolean optional
Employees boolean optional
EmployeesRequestType string optional
Allowed values:
REQUESTING BOOKING ENTERING OVERTAKE_STATUS
IndividualTabs boolean optional
Rooms boolean optional
RoomsRequestType string optional
Allowed values:
REQUESTING BOOKING ENTERING OVERTAKE_STATUS
Status string optional
Allowed values:
GRAY GREEN ORANGE RED PURPLE YELLOW TURQUOISE PINK BROWN
Subevents boolean optional
Tasks boolean optional
Tickets boolean optional
Vehicles boolean optional
VehiclesRequestType string optional
Allowed values:
REQUESTING BOOKING ENTERING OVERTAKE_STATUS
WorkingHours boolean optional
eventId integer required
A numeric id of a dataset
getHeadInfo ▼
Returns basic information about a specific event.
Parameters
eventId integer required
A numeric id of a dataset
getEventIndividualTabCollection ▼
List EventIndividualTabs
Parameters
eventId integer required
A numeric id of a dataset
expand array optional
Comma separated list of optional fields, options: `Fields`
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
getEventIndividualTab ▼
Get EventIndividualTab for a given tabId
Parameters
eventId integer required
A numeric id of a dataset
expand array optional
Comma separated list of optional fields, options: `Fields`
tabId integer required
A numeric id of a dataset
getEventIndividualTabDataCollection ▼
List EventIndividualTabDatas
Parameters
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
tabId integer required
A numeric id of a dataset
postEventIndividualTabData ▼
Create new EventIndividualTabData
Parameters
Data string optional
ForeignID string optional
Position integer optional
TabID integer optional
eventId integer required
A numeric id of a dataset
tabId integer required
A numeric id of a dataset
deleteEventIndividualTabData ▼
Delete EventIndividualTabData for a given dataId
Parameters
dataId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
tabId integer required
A numeric id of a dataset
getEventIndividualTabData ▼
Get EventIndividualTabData for a given dataId
Parameters
dataId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
tabId integer required
A numeric id of a dataset
putEventIndividualTabData ▼
Change EventIndividualTabData for a given dataId
Parameters
Data string optional
ForeignID string optional
Position integer optional
TabID integer optional
dataId integer required
A numeric id of a dataset
eventId integer required
A numeric id of a dataset
tabId integer required
A numeric id of a dataset
getMargincalculation ▼
Returns the totals for the margin calculation (purchase & retail) of an event
Parameters
eventId integer required
A numeric id of a dataset
getPrintviews ▼
Returns a list of all print views the user is allowed to view.
Parameters
eventId integer required
A numeric id of a dataset
savePrintviewSettings ▼
Allows the user to save the settings for a specific print view to then be able to create a pdf document with these settings.
Parameters
Settings object optional
Variant string optional
eventId integer required
A numeric id of a dataset
getEventResourceCategoryCollection ▼
List EventResourceCategorys
Parameters
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEventResourceCategory ▼
Create new EventResourceCategory
Parameters
CategoryID integer optional
ExternalDescription string optional
ExternalID string optional
Note string optional
OriginID integer optional
PurchasePrice number optional
Format: float
PurchasePriceDailyRateExtraAmount number optional
Format: float
PurchasePriceDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
PurchasePriceDailyRateHours number optional
Format: float
PurchasePriceMinimumHours number optional
Format: float
PurchasePriceScale string optional
PurchasePriceType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
Quantity integer optional
RetailPrice number optional
Format: float
RetailPriceDailyRateExtraAmount number optional
Format: float
RetailPriceDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
RetailPriceDailyRateHours number optional
Format: float
RetailPriceMinimumHours number optional
Format: float
RetailPriceScale string optional
RetailPriceType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
Skilllevel integer optional
Splitted boolean optional
eventId integer required
A numeric id of a dataset
deleteEventResourceCategory ▼
Delete EventResourceCategory for a given resourceCategoryId
Parameters
eventId integer required
A numeric id of a dataset
resourceCategoryId integer required
A numeric id of a dataset
getEventResourceCategory ▼
Get EventResourceCategory for a given resourceCategoryId
Parameters
eventId integer required
A numeric id of a dataset
resourceCategoryId integer required
A numeric id of a dataset
putEventResourceCategory ▼
Change EventResourceCategory for a given resourceCategoryId
Parameters
CategoryID integer optional
ExternalDescription string optional
ExternalID string optional
Note string optional
OriginID integer optional
PurchasePrice number optional
Format: float
PurchasePriceDailyRateExtraAmount number optional
Format: float
PurchasePriceDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
PurchasePriceDailyRateHours number optional
Format: float
PurchasePriceMinimumHours number optional
Format: float
PurchasePriceScale string optional
PurchasePriceType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
Quantity integer optional
RetailPrice number optional
Format: float
RetailPriceDailyRateExtraAmount number optional
Format: float
RetailPriceDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
RetailPriceDailyRateHours number optional
Format: float
RetailPriceMinimumHours number optional
Format: float
RetailPriceScale string optional
RetailPriceType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
Skilllevel integer optional
Splitted boolean optional
deleteQuantityZeroCategoryWithoutResources boolean optional
Deletes event resource category without event resources, if the quantity is zero
eventId integer required
A numeric id of a dataset
resourceCategoryId integer required
A numeric id of a dataset
getEventResourceCollection ▼
List EventResources
Parameters
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEventResource ▼
Create new EventResource
Parameters
Activity string optional
Alternative integer optional
Assignment string optional
Allowed values:
EMPLOYEE SUBCONTRACTOR VEHICLE ROOM
AssignmentID integer optional
Available boolean optional
BillingFactor number optional
Format: float
Booked boolean optional
ChangeAvailabilityNoDate string optional
Format: date-time
ChangeAvailabilityNoID integer optional
ChangeAvailabilityYesDate string optional
Format: date-time
ChangeAvailabilityYesID integer optional
Checkbox1 boolean optional
Checkbox2 boolean optional
Checkbox3 boolean optional
Checkbox4 boolean optional
Checkbox5 boolean optional
Checkbox6 boolean optional
DriverID integer optional
EmailBooking string optional
Format: date-time
EmailInquiry string optional
Format: date-time
EmailRequest string optional
Format: date-time
ExternalID string optional
FreeEmployee string optional
FreeEmployeePhone string optional
InquiryYesDate string optional
Format: date-time
JobChanges boolean optional
JobResourceCategoryID integer optional
Locked boolean optional
Notes string optional
OverlapsIgnoreEventResourceIDs array optional
PassengerIDs string optional
Payload number optional
Format: float
Remark string optional
RetailPrice number optional
Format: float
RetailPriceDailyRateExtraAmount number optional
Format: float
RetailPriceDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
RetailPriceDailyRateHours number optional
Format: float
RetailPriceMinimumHours number optional
Format: float
RetailPriceType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
Seats integer optional
SubEmployeeID integer optional
Wage number optional
Format: float
WageDailyRateExtraAmount number optional
Format: float
WageDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
WageDailyRateHours number optional
Format: float
WageMinimumHours number optional
Format: float
WageScale string optional
WageType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
eventId integer required
A numeric id of a dataset
getEventAllNames ▼
Returns a list of all the persons (resources) in this event.
Parameters
eventId integer required
A numeric id of a dataset
includeActiveWorkinghours boolean optional
Include current active working hours of all employees if present
includeEventdetails boolean optional
Include details for each event like title & date
includeSubjobs boolean optional
Show also resources of subjobs, default: true
onlyAvailable boolean optional
Only available resources, default: false
onlyBooked boolean optional
Only booked resources, default: false
deleteEventResource ▼
Delete EventResource for a given resourceId
Parameters
eventId integer required
A numeric id of a dataset
resourceId integer required
A numeric id of a dataset
getEventResource ▼
Get EventResource for a given resourceId
Parameters
eventId integer required
A numeric id of a dataset
resourceId integer required
A numeric id of a dataset
putEventResource ▼
Change EventResource for a given resourceId
Parameters
Activity string optional
Alternative integer optional
Assignment string optional
Allowed values:
EMPLOYEE SUBCONTRACTOR VEHICLE ROOM
AssignmentID integer optional
Available boolean optional
BillingFactor number optional
Format: float
Booked boolean optional
ChangeAvailabilityNoDate string optional
Format: date-time
ChangeAvailabilityNoID integer optional
ChangeAvailabilityYesDate string optional
Format: date-time
ChangeAvailabilityYesID integer optional
Checkbox1 boolean optional
Checkbox2 boolean optional
Checkbox3 boolean optional
Checkbox4 boolean optional
Checkbox5 boolean optional
Checkbox6 boolean optional
DriverID integer optional
EmailBooking string optional
Format: date-time
EmailInquiry string optional
Format: date-time
EmailRequest string optional
Format: date-time
ExternalID string optional
FreeEmployee string optional
FreeEmployeePhone string optional
InquiryYesDate string optional
Format: date-time
JobChanges boolean optional
JobResourceCategoryID integer optional
Locked boolean optional
Notes string optional
OverlapsIgnoreEventResourceIDs array optional
PassengerIDs string optional
Payload number optional
Format: float
Remark string optional
RetailPrice number optional
Format: float
RetailPriceDailyRateExtraAmount number optional
Format: float
RetailPriceDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
RetailPriceDailyRateHours number optional
Format: float
RetailPriceMinimumHours number optional
Format: float
RetailPriceType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
Seats integer optional
SubEmployeeID integer optional
Wage number optional
Format: float
WageDailyRateExtraAmount number optional
Format: float
WageDailyRateExtraType string optional
Allowed values:
HOUR HALFHOUR
WageDailyRateHours number optional
Format: float
WageMinimumHours number optional
Format: float
WageScale string optional
WageType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
eventId integer required
A numeric id of a dataset
resourceId integer required
A numeric id of a dataset
setWageForRootEventChildrens ▼
Set wage of this resources for all resouces in same root event
Parameters
eventId integer required
A numeric id of a dataset
resourceId integer required
A numeric id of a dataset
getEventResponsiblePersonCollection ▼
List EventResponsiblePersons
Parameters
eventId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postEventResponsiblePerson ▼
Create new EventResponsiblePerson
Parameters
ResponsibleID integer optional
Type string optional
Allowed values:
SCHEDULER PROJECTMANAGER CONTACTPERSON_CLIENT CONTACTPERSON_LOCATION
eventId integer required
A numeric id of a dataset
deleteEventResponsiblePerson ▼
Delete EventResponsiblePerson for a given responsiblePersonId
Parameters
eventId integer required
A numeric id of a dataset
responsiblePersonId integer required
A numeric id of a dataset
sendEventBookingNotifications ▼
Sends booking notifications to resources.
Parameters
ChangeBookingStatus boolean optional
EventResourceIDs array optional
Remarks string optional
eventId integer required
A numeric id of a dataset
sendEventConfirmationNotifications ▼
Sends confirmation notifications to resources.
Parameters
EventResourceIDs array optional
Remarks string optional
eventId integer required
A numeric id of a dataset
sendEventFreetextNotifications ▼
Sends freetext notifications to resources.
Parameters
EventResourceIDs array optional
Remarks string optional
eventId integer required
A numeric id of a dataset
sendEventRequestNotifications ▼
Sends request notifications to resources.
Parameters
EventResourceIDs array optional
Remarks string optional
eventId integer required
A numeric id of a dataset
sendEventTenderMails ▼
Sends tender mails for events and employees based on their categories
Parameters
AttachInformation boolean optional
CategoryIDs array optional
EmployeeIDs array optional
EventIDs array optional
Text string optional
eventId integer required
A numeric id of a dataset
getEventStructure ▼
Returns the whole structure of a given event.
Parameters
allMaineventsUntil integer optional
Show all main events without paging until n datasets (max & defailt: 50). Use this parameter to test the paging behavior of this endpoint for smaller projects and test cases. Do not use this parameter in production environments to avoid performance loss.
eventId integer required
A numeric id of a dataset
excludeSelf boolean optional
Exclude self object with `eventId` and only show sub elements. Can be used if the structure is larger than the maximum of allowed elements to fetch previous or next events using `limit` and `offset`.
fullStructureUntil integer optional
Show full structure without paging until n datasets (max & default: 200). Use this parameter to test the paging behavior of this endpoint for smaller projects and test cases. Do not use this parameter in production environments to avoid performance loss.
includeResCatsCount boolean optional
Include and calculate total resource categories count for each object
includeSubeventsNeeds boolean optional
Include and calculate total staff and vehicle needs for subevents for each object
limit integer optional
Number of datasets to be returned (first level only). The endpoint will set individual limits for each level in the structure based on the size of the project requested. Projects with up to 200 elements will be returned without the need of paging, for larger ones the result set will not contain all subelements. Your code always has to check `limit` and `offset` parameters in the result sets and it might occur that previous elements have to be fetched in a separate call. Use `fullStructureUntil` and `allMaineventsUntil` to simulate that behavior also for smaller projects and test cases.
offset integer optional
Number of datasets to skip at the beginning of the result (first level only, default: `0`. Note: if `startAtRoot` is set to `true` the endpoint might set another default value to assure the requested `eventId` is contained in one of the subevents result set. Your code always has to check `limit` and `offset` parameters in the result sets and it might occur that previous elements have to be fetched in a separate call. Use `fullStructureUntil` and `allMaineventsUntil` to simulate that behavior also for smaller projects and test cases.
onlyEventsWithStaffId boolean optional
Show only events where the specified user, room or vehicle is involved as a resource.
roomId integer optional
Show booking state from the perspective of the specified room
staffId integer optional
Show booking state from the perspective of the specified user, default: current user
startAtRoot boolean optional
Shows the structure starting from root event, default: `false`. Note: if set to `true`, the endpoint will always try to include the requested `eventId` in the subevents list(s). Therefore it might occur that the endpoint will start with an `offset > 0` for some but not all of the subevents lists. Your code always has to check `limit` and `offset` parameters in the result sets and it might occur that previous elements have to be fetched in a separate call. Use `fullStructureUntil` and `allMaineventsUntil` to simulate that behavior also for smaller projects and test cases.
vehicleId integer optional
Show booking state from the perspective of the specified vehicle
getEventTenderCategories ▼
Returns a list of unique categories based on the event IDs specified as query parameter
Parameters
eventId integer required
A numeric id of a dataset
eventIds string required
Comma-separated list of event IDs to include categories from
getEventTenderRecipients ▼
Returns a list of recipients of sent tenders
Parameters
eventId integer required
A numeric id of a dataset
includeSubevents boolean optional
Add tender recipients of subevents
getFilterFavoriteCollection ▼
List FilterFavorites
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postFilterFavorite ▼
Create new FilterFavorite
Parameters
EmployeeID integer optional
Filter object optional
Name string optional
Type string optional
Allowed values:
CALENDAR EMPLOYEES VEHICLES REQUESTDIALOG
deleteFilterFavorite ▼
Delete FilterFavorite for a given filterId
Parameters
filterId integer required
A numeric id of a dataset
getFilterFavorite ▼
Get FilterFavorite for a given filterId
Parameters
filterId integer required
A numeric id of a dataset
putFilterFavorite ▼
Change FilterFavorite for a given filterId
Parameters
EmployeeID integer optional
Filter object optional
Name string optional
Type string optional
Allowed values:
CALENDAR EMPLOYEES VEHICLES REQUESTDIALOG
filterId integer required
A numeric id of a dataset
getLocationCollection ▼
List Locations
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postLocation ▼
Create new Location
Parameters
AddressAddition string optional
City string optional
Country string optional
Description string optional
EMail string optional
ExternalClientID integer optional
ExternalID string optional
ExternalSystem string optional
GpsLat number optional
Format: float
GpsLon number optional
Format: float
HouseNumber string optional
Internet string optional
IsGpsManual boolean optional
Notes string optional
Phone string optional
State string optional
Street string optional
ZipCode string optional
deleteLocation ▼
Delete Location for a given locationId
Parameters
locationId integer required
A numeric id of a dataset
getLocation ▼
Get Location for a given locationId
Parameters
locationId integer required
A numeric id of a dataset
putLocation ▼
Change Location for a given locationId
Parameters
AddressAddition string optional
City string optional
Country string optional
Description string optional
EMail string optional
ExternalClientID integer optional
ExternalID string optional
ExternalSystem string optional
GpsLat number optional
Format: float
GpsLon number optional
Format: float
HouseNumber string optional
Internet string optional
IsGpsManual boolean optional
Notes string optional
Phone string optional
State string optional
Street string optional
ZipCode string optional
locationId integer required
A numeric id of a dataset
getAdditionalLocationDataTypes ▼
Returns the additional data types associated with a location object.
Parameters
locationId integer required
A numeric id of a dataset
bulkPutToLocationAdditionalData ▼
Allows the user to edit a multiple additional data types for a location object.
Parameters
locationId integer required
A numeric id of a dataset
requestBody array optional
addDocumentToLocationAdditionalData ▼
Allows the user to upload a document if the additional data type for location is of type document.
Parameters
Base64String string optional
Filename string optional
Filetype string optional
locationId integer required
A numeric id of a dataset
overwriteSingleDocument boolean optional
Replaces the existing additional data document, if present
typeId integer required
A numeric id of a dataset
getLocationContactPersonCollection ▼
List LocationContactPersons
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
locationId integer required
A numeric id of a dataset
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postLocationContactPerson ▼
Create new LocationContactPerson
Parameters
AddressAddition string optional
City string optional
Country string optional
EMail string optional
ExternalID string optional
Firstname string optional
HouseNumber string optional
Lastname string optional
Mobile string optional
Phone string optional
Position string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
State string optional
Street string optional
ZipCode string optional
locationId integer required
A numeric id of a dataset
deleteLocationContactPerson ▼
Delete LocationContactPerson for a given contactPersonId
Parameters
contactPersonId integer required
A numeric id of a dataset
locationId integer required
A numeric id of a dataset
getLocationContactPerson ▼
Get LocationContactPerson for a given contactPersonId
Parameters
contactPersonId integer required
A numeric id of a dataset
locationId integer required
A numeric id of a dataset
putLocationContactPerson ▼
Change LocationContactPerson for a given contactPersonId
Parameters
AddressAddition string optional
City string optional
Country string optional
EMail string optional
ExternalID string optional
Firstname string optional
HouseNumber string optional
Lastname string optional
Mobile string optional
Phone string optional
Position string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
State string optional
Street string optional
ZipCode string optional
contactPersonId integer required
A numeric id of a dataset
locationId integer required
A numeric id of a dataset
getMe ▼
Get user information
Parameters
No parameters required
putMe ▼
Change user information
Parameters
AddressAddition string optional
Birthdate string optional
Format: date
Birthplace string optional
BranchID integer optional
City string optional
Country string optional
DateEntry string optional
Format: date
DateExit string optional
Format: date
DepartmentID integer optional
EMail string optional
ExtendedPersonnelRequirements boolean optional
ExternalID string optional
Firstname string optional
Gender string optional
Allowed values:
UNKNOWN MALE FEMALE DIVERS
GoogleMapsPrivacyAccepted string optional
Format: date-time
HouseNumber string optional
Language string optional
Allowed values:
GERMAN ENGLISH FRENCH SPANISH ICELANDIC
Languages array optional
Lastname string optional
Notes string optional
Phone string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
StaffNumber integer optional
State string optional
Status string optional
Allowed values:
ADMIN GUEST EMPLOYEE SCHEDULER LOCKED
Street string optional
SubcontractorID integer optional
Type string optional
Allowed values:
EMPLOYEE FREELANCER SUBCONTRACTOR APPLICANT
Username string optional
VacationDefaultDeputyId integer optional
WorkcontractActivity string optional
ZipCode string optional
changeUserPassword ▼
Allows the logged in user to change their password.
Parameters
Password string optional
PasswordNew string optional
getUserIdCard ▼
Allows the logged in user to retrieve its idcard.
Parameters
No parameters required
getMeNotificationCollection ▼
List MeNotifications
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
getNotificationForJob ▼
Returns a list of notifications for a given job
Parameters
JobId integer optional
Numeric id of a job
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
getOverlapsForResourcesIds ▼
Returns a list of overlaps associated with the resource ids.
Parameters
ArrayIds array optional
getOverlapsForEventAndStaff ▼
Returns a list of overlaps for the given staff id if this staff would be added to the event id.
Parameters
EventID integer optional
StaffID integer optional
getEventsForOverlap ▼
Returns a list of overlapping events.
Parameters
resourceId integer required
A numeric id of a dataset
postPendingNotificationBulkDelete ▼
Delete PendingNotification for a multiple given ids at once
Parameters
ArrayIds array optional
getReceivers ▼
Returns a list of receivers of pending notifications for an event
Parameters
HighestParentID integer optional
The highest parent id that the notifications are created
sendNotifications ▼
Allows to user to send notifications for a given event
Parameters
HighestParentIDs array optional
ReceiverIDs object optional
deletePendingNotification ▼
Delete PendingNotification for a given pendingNotificationId
Parameters
pendingNotificationId integer required
A numeric id of a dataset
getPricelistCollection ▼
List Pricelists
Parameters
expand array optional
Comma separated list of optional fields, options: `CategoryWageList`
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postPricelist ▼
Create new Pricelist
Parameters
Assignment string optional
Allowed values:
EMPLOYEE CLIENT
AssignmentID integer optional
DailyRate number optional
Format: float
DailyRateAdditionalAmount number optional
Format: float
DailyRateAdditionalType string optional
Allowed values:
HOUR HALFHOUR
DailyRateHours number optional
Format: float
Description string optional
Flatrate number optional
Format: float
HolydayWork boolean optional
HolydayWorkSurcharge number optional
Format: float
HourlyRate number optional
Format: float
HourlyRateScale string optional
MinimumHours number optional
Format: float
NightWork1 boolean optional
NightWork1From string optional
NightWork1Until string optional
NightWork2 boolean optional
NightWork2From string optional
NightWork2Surcharge number optional
Format: float
NightWork2Until string optional
NightWork3 boolean optional
NightWork3From string optional
NightWork3Surcharge number optional
Format: float
NightWork3Until string optional
NightWorkOnlyAlone boolean optional
NightWorklSurcharge number optional
Format: float
Notes string optional
Overtime boolean optional
OvertimeAndNightWork boolean optional
OvertimeHours number optional
Format: float
OvertimeSurcharge number optional
Format: float
OvertimekOnlyAlone boolean optional
Round integer optional
SaturdayWork boolean optional
SaturdayWorkSurcharge number optional
Format: float
SundayWork boolean optional
SundayWorkSurcharge number optional
Format: float
SurchargeBreaks boolean optional
SurchargeFollowingDay boolean optional
SurchargeFollowingDayUntil string optional
WageComponentDefinitionID integer optional
WageType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
deletePricelist ▼
Delete Pricelist for a given pricelistId
Parameters
pricelistId integer required
A numeric id of a dataset
getPricelist ▼
Get Pricelist for a given pricelistId
Parameters
expand array optional
Comma separated list of optional fields, options: `CategoryWageList`
pricelistId integer required
A numeric id of a dataset
putPricelist ▼
Change Pricelist for a given pricelistId
Parameters
Assignment string optional
Allowed values:
EMPLOYEE CLIENT
AssignmentID integer optional
DailyRate number optional
Format: float
DailyRateAdditionalAmount number optional
Format: float
DailyRateAdditionalType string optional
Allowed values:
HOUR HALFHOUR
DailyRateHours number optional
Format: float
Description string optional
Flatrate number optional
Format: float
HolydayWork boolean optional
HolydayWorkSurcharge number optional
Format: float
HourlyRate number optional
Format: float
HourlyRateScale string optional
MinimumHours number optional
Format: float
NightWork1 boolean optional
NightWork1From string optional
NightWork1Until string optional
NightWork2 boolean optional
NightWork2From string optional
NightWork2Surcharge number optional
Format: float
NightWork2Until string optional
NightWork3 boolean optional
NightWork3From string optional
NightWork3Surcharge number optional
Format: float
NightWork3Until string optional
NightWorkOnlyAlone boolean optional
NightWorklSurcharge number optional
Format: float
Notes string optional
Overtime boolean optional
OvertimeAndNightWork boolean optional
OvertimeHours number optional
Format: float
OvertimeSurcharge number optional
Format: float
OvertimekOnlyAlone boolean optional
Round integer optional
SaturdayWork boolean optional
SaturdayWorkSurcharge number optional
Format: float
SundayWork boolean optional
SundayWorkSurcharge number optional
Format: float
SurchargeBreaks boolean optional
SurchargeFollowingDay boolean optional
SurchargeFollowingDayUntil string optional
WageComponentDefinitionID integer optional
WageType string optional
Allowed values:
HOURLYRATE FLATRATE DAILYRATE NOPAYMENT
pricelistId integer required
A numeric id of a dataset
getRiskassessmentCollection ▼
List Riskassessments
Parameters
eventId integer optional
A numeric id of an event to which the risk assessments are assigned
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
includeSubevents boolean optional
Include subevents when selecting the risk assessment for an event
limit integer optional
Number of datasets to be returned
locationId integer optional
A numeric id of a location to which the risk assessments are assigned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
staffcategoryId integer optional
A numeric id of a staff category to which the risk assessments are assigned
vehicleId integer optional
A numeric id of a vehicle to which the risk assessments are assigned
getSafetybriefingCollection ▼
List Safetybriefings
Parameters
includeSubevents boolean optional
Include subevents when selecting the safety briefings for an event
roadmapSearch ▼
Allows the user to search the global CrewBrain roadmap.
Parameters
Query string optional
getSettings ▼
Returns a list of all system wide settings.
Parameters
No parameters required
getSignatureCollection ▼
List Signatures
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
signObjects ▼
Allows the user to sign contract objects.
Parameters
Base64Signature string optional
City string optional
Name string optional
ToSignObjects array optional
deleteSignature ▼
Delete Signature for a given signatureId
Parameters
signatureId integer required
A numeric id of a dataset
getSignature ▼
Get Signature for a given signatureId
Parameters
signatureId integer required
A numeric id of a dataset
getStaffCollection ▼
List Staffs
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postStaff ▼
Create new Staff
Parameters
AddressAddition string optional
Birthdate string optional
Format: date
Birthplace string optional
BranchID integer optional
City string optional
Country string optional
DateEntry string optional
Format: date
DateExit string optional
Format: date
DepartmentID integer optional
EMail string optional
ExternalID string optional
Firstname string optional
Gender string optional
Allowed values:
UNKNOWN MALE FEMALE DIVERS
HouseNumber string optional
Language string optional
Allowed values:
GERMAN ENGLISH FRENCH SPANISH ICELANDIC
Languages array optional
Lastname string optional
Notes string optional
Phone string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
StaffNumber integer optional
State string optional
Status string optional
Allowed values:
ADMIN GUEST EMPLOYEE SCHEDULER LOCKED
Street string optional
SubcontractorID integer optional
Type string optional
Allowed values:
EMPLOYEE FREELANCER SUBCONTRACTOR APPLICANT
Username string optional
VacationDefaultDeputyId integer optional
WorkcontractActivity string optional
ZipCode string optional
deleteStaff ▼
Delete Staff for a given staffId
Parameters
staffId integer required
A numeric id of a dataset
getStaff ▼
Get Staff for a given staffId
Parameters
staffId integer required
A numeric id of a dataset
putStaff ▼
Change Staff for a given staffId
Parameters
AddressAddition string optional
Birthdate string optional
Format: date
Birthplace string optional
BranchID integer optional
City string optional
Country string optional
DateEntry string optional
Format: date
DateExit string optional
Format: date
DepartmentID integer optional
EMail string optional
ExternalID string optional
Firstname string optional
Gender string optional
Allowed values:
UNKNOWN MALE FEMALE DIVERS
HouseNumber string optional
Language string optional
Allowed values:
GERMAN ENGLISH FRENCH SPANISH ICELANDIC
Languages array optional
Lastname string optional
Notes string optional
Phone string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
StaffNumber integer optional
State string optional
Status string optional
Allowed values:
ADMIN GUEST EMPLOYEE SCHEDULER LOCKED
Street string optional
SubcontractorID integer optional
Type string optional
Allowed values:
EMPLOYEE FREELANCER SUBCONTRACTOR APPLICANT
Username string optional
VacationDefaultDeputyId integer optional
WorkcontractActivity string optional
ZipCode string optional
staffId integer required
A numeric id of a dataset
getAdditionalStaffDataTypes ▼
Returns the additional data types associated with a staff object.
Parameters
staffId integer required
A numeric id of a dataset
bulkPutToStaffAdditionalData ▼
Allows the user to edit a multiple additional data types for a staff object.
Parameters
requestBody array optional
staffId integer required
A numeric id of a dataset
addDocumentToStaffAdditionalData ▼
Allows the user to upload a document if the additional data type for staff is of type document.
Parameters
Base64String string optional
Filename string optional
Filetype string optional
overwriteSingleDocument boolean optional
Replaces the existing additional data document, if present
staffId integer required
A numeric id of a dataset
typeId integer required
A numeric id of a dataset
postStaffCategory ▼
Create new StaffCategory
Parameters
Assignment string optional
Allowed values:
EMPLOYEE
AssignmentID integer optional
CategoryID integer optional
Skilllevel integer optional
staffId integer required
A numeric id of a dataset
getStaffCategoryCollection ▼
List StaffCategorys
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
staffId integer required
A numeric id of a dataset
deleteStaffCategory ▼
Delete StaffCategory for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
staffId integer required
A numeric id of a dataset
getStaffCategory ▼
Get StaffCategory for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
staffId integer required
A numeric id of a dataset
putStaffCategory ▼
Change StaffCategory for a given categoryId
Parameters
Skilllevel integer optional
categoryId integer required
A numeric id of a dataset
staffId integer required
A numeric id of a dataset
getStaffContactPersonCollection ▼
List StaffContactPersons
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
staffId integer required
A numeric id of a dataset
postStaffContactPerson ▼
Create new StaffContactPerson
Parameters
AddressAddition string optional
City string optional
Country string optional
EMail string optional
ExternalID string optional
Firstname string optional
HouseNumber string optional
Lastname string optional
Mobile string optional
Phone string optional
Position string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
State string optional
Street string optional
ZipCode string optional
staffId integer required
A numeric id of a dataset
deleteStaffContactPerson ▼
Delete StaffContactPerson for a given contactPersonId
Parameters
contactPersonId integer required
A numeric id of a dataset
staffId integer required
A numeric id of a dataset
getStaffContactPerson ▼
Get StaffContactPerson for a given contactPersonId
Parameters
contactPersonId integer required
A numeric id of a dataset
staffId integer required
A numeric id of a dataset
putStaffContactPerson ▼
Change StaffContactPerson for a given contactPersonId
Parameters
AddressAddition string optional
City string optional
Country string optional
EMail string optional
ExternalID string optional
Firstname string optional
HouseNumber string optional
Lastname string optional
Mobile string optional
Phone string optional
Position string optional
Salutation string optional
Allowed values:
INFORMAL MR MRS FORMAL
State string optional
Street string optional
ZipCode string optional
contactPersonId integer required
A numeric id of a dataset
staffId integer required
A numeric id of a dataset
resetStaffPassword ▼
Allows to reset a password for a user.
Parameters
staffId integer required
A numeric id of a dataset
sendWelcomemail ▼
Sends out the welcomemail with login credentials and information to a user.
Parameters
staffId integer required
A numeric id of a dataset
updateStaffRfid ▼
Allows to update the rfid tag id connected with the user dataset
Parameters
Token string optional
staffId integer required
A numeric id of a dataset
getStatementDefInfoForResourcesIds ▼
Returns a list of statement definition data associated with the resource ids.
Parameters
ArrayIds array optional
getTaskmanagementTasklistFoldersCollection ▼
List TaskmanagementTasklistFolderss
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postTaskmanagementTasklistFolders ▼
Create new TaskmanagementTasklistFolders
Parameters
EmployeeID integer optional
Expanded boolean optional
Name string optional
ParentID integer optional
Position number optional
Format: float
getTaskmanagementTasklistFolders ▼
Get TaskmanagementTasklistFolders for a given tasklistfoldersId
Parameters
tasklistfoldersId integer required
A numeric id of a dataset
putTaskmanagementTasklistFolders ▼
Change TaskmanagementTasklistFolders for a given tasklistfoldersId
Parameters
EmployeeID integer optional
Expanded boolean optional
Name string optional
ParentID integer optional
Position number optional
Format: float
tasklistfoldersId integer required
A numeric id of a dataset
getTaskmanagementTasklistCollection ▼
List TaskmanagementTasklists
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postTaskmanagementTasklist ▼
Create new TaskmanagementTasklist
Parameters
Description string optional
Name string optional
putTaskmanagementTasklist ▼
Change TaskmanagementTasklist for a given tasklistsId
Parameters
Description string optional
Name string optional
tasklistsId integer required
A numeric id of a dataset
getTaskmanagementTasklist ▼
Get TaskmanagementTasklist for a given tasklistsId
Parameters
tasklistsId integer required
A numeric id of a dataset
getTaskmanagementTasklistParticipantsCollection ▼
List TaskmanagementTasklistParticipantss
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
tasklistsId integer required
A numeric id of a dataset
postTaskmanagementTasklistParticipants ▼
Create new TaskmanagementTasklistParticipants
Parameters
CreateTasks boolean optional
EditTasklist boolean optional
ParticipantID integer optional
ParticipantType string optional
Allowed values:
USERGROUP EMPLOYEE DEPARTMENTS
ShareTasklist boolean optional
tasklistsId integer required
A numeric id of a dataset
getTaskmanagementTasklistParticipants ▼
Get TaskmanagementTasklistParticipants for a given participantId
Parameters
participantId integer required
A numeric id of a dataset
tasklistsId integer required
A numeric id of a dataset
putTaskmanagementTasklistParticipants ▼
Change TaskmanagementTasklistParticipants for a given participantId
Parameters
CreateTasks boolean optional
EditTasklist boolean optional
ParticipantID integer optional
ParticipantType string optional
Allowed values:
USERGROUP EMPLOYEE DEPARTMENTS
ShareTasklist boolean optional
participantId integer required
A numeric id of a dataset
tasklistsId integer required
A numeric id of a dataset
getTasklistStructure ▼
Returns a structure of all tasklists a user is allowed to read.
Parameters
No parameters required
getTaskmanagementTaskCollection ▼
List TaskmanagementTasks
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postTaskmanagementTask ▼
Create new TaskmanagementTask
Parameters
Assignment string optional
Allowed values:
NONE TASK JOB PROJECT TASKLIST
AssignmentID integer optional
DateFrom string optional
Format: date-time
DateUntil string optional
Format: date-time
Description string optional
ExternalID string optional
Position number optional
Format: float
Priority integer optional
Repeat string optional
Status integer optional
Title string optional
getTaskmanagementTask ▼
Get TaskmanagementTask for a given taskId
Parameters
taskId integer required
A numeric id of a dataset
putTaskmanagementTask ▼
Change TaskmanagementTask for a given taskId
Parameters
Assignment string optional
Allowed values:
NONE TASK JOB PROJECT TASKLIST
AssignmentID integer optional
DateFrom string optional
Format: date-time
DateUntil string optional
Format: date-time
Description string optional
ExternalID string optional
Position number optional
Format: float
Priority integer optional
Repeat string optional
Status integer optional
Title string optional
taskId integer required
A numeric id of a dataset
getAdditionalTaskDataTypes ▼
Returns the additional data types associated with a task object.
Parameters
taskId integer required
A numeric id of a dataset
bulkPutToTaskAdditionalData ▼
Allows the user to edit a multiple additional data types for a task object.
Parameters
requestBody array optional
taskId integer required
A numeric id of a dataset
addDocumentToTaskAdditionalData ▼
Allows the user to upload a document if the additional data type for task is of type document.
Parameters
Base64String string optional
Filename string optional
Filetype string optional
overwriteSingleDocument boolean optional
Replaces the existing additional data document, if present
taskId integer required
A numeric id of a dataset
typeId integer required
A numeric id of a dataset
getTaskmanagementTaskAttachmentCollection ▼
List TaskmanagementTaskAttachments
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
taskId integer required
A numeric id of a dataset
postTaskmanagementTaskAttachment ▼
Create new TaskmanagementTaskAttachment
Parameters
Base64String string optional
Filename string optional
Filetype string optional
taskId integer required
A numeric id of a dataset
deleteTaskmanagementTaskAttachment ▼
Delete TaskmanagementTaskAttachment for a given attachmentId
Parameters
attachmentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
getTaskmanagementTaskAttachment ▼
Get TaskmanagementTaskAttachment for a given attachmentId
Parameters
asBase64 boolean optional
Output document as base 64 string, default: false
attachmentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
getTaskmanagementTaskCommentCollection ▼
List TaskmanagementTaskComments
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
taskId integer required
A numeric id of a dataset
postTaskmanagementTaskComment ▼
Create new TaskmanagementTaskComment
Parameters
Comment string optional
ParentID integer optional
Visibility string optional
Allowed values:
ALL BOOKED SCHEDULER PROJECTMANAGER SCHEDULERANDPROJECTMANAGER
taskId integer required
A numeric id of a dataset
deleteTaskmanagementTaskComment ▼
Delete TaskmanagementTaskComment for a given commentId
Parameters
commentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
getTaskmanagementTaskComment ▼
Get TaskmanagementTaskComment for a given commentId
Parameters
commentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
putTaskmanagementTaskComment ▼
Change TaskmanagementTaskComment for a given commentId
Parameters
Comment string optional
ParentID integer optional
Visibility string optional
Allowed values:
ALL BOOKED SCHEDULER PROJECTMANAGER SCHEDULERANDPROJECTMANAGER
commentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
getTaskmanagementTaskCommentAttachmentCollection ▼
List TaskmanagementTaskCommentAttachments
Parameters
commentId integer required
A numeric id of a dataset
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
taskId integer required
A numeric id of a dataset
postTaskmanagementTaskCommentAttachment ▼
Create new TaskmanagementTaskCommentAttachment
Parameters
Base64String string optional
Filename string optional
Filetype string optional
commentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
deleteTaskmanagementTaskCommentAttachment ▼
Delete TaskmanagementTaskCommentAttachment for a given attachmentId
Parameters
attachmentId integer required
A numeric id of a dataset
commentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
getTaskmanagementTaskCommentAttachment ▼
Get TaskmanagementTaskCommentAttachment for a given attachmentId
Parameters
asBase64 boolean optional
Output document as base 64 string, default: false
attachmentId integer required
A numeric id of a dataset
commentId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
markTaskDone ▼
Allows the user to mark a task as done.
Parameters
taskId integer required
A numeric id of a dataset
markTaskUndone ▼
Allows the user to mark a task as undone.
Parameters
taskId integer required
A numeric id of a dataset
getTaskmanagementTaskResponsibleCollection ▼
List TaskmanagementTaskResponsibles
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
taskId integer required
A numeric id of a dataset
postTaskmanagementTaskResponsible ▼
Create new TaskmanagementTaskResponsible
Parameters
ResponsibleID integer optional
taskId integer required
A numeric id of a dataset
deleteTaskmanagementTaskResponsible ▼
Delete TaskmanagementTaskResponsible for a given responsibleId
Parameters
responsibleId integer required
A numeric id of a dataset
taskId integer required
A numeric id of a dataset
getTextTemplateCollection ▼
List TextTemplates
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postTextTemplate ▼
Create new TextTemplate
Parameters
Active boolean optional
CategoryID integer optional
Description string optional
Text string optional
TextTemplateGetPlaceholders ▼
Returns all possible placeholders that can be used in text templates
Parameters
No parameters required
getTextTemplateStructure ▼
Returns the structure of all text templates including their categories.
Parameters
No parameters required
getTextTemplate ▼
Get TextTemplate for a given textTemplateId
Parameters
textTemplateId integer required
A numeric id of a dataset
putTextTemplate ▼
Change TextTemplate for a given textTemplateId
Parameters
Active boolean optional
CategoryID integer optional
Description string optional
Text string optional
textTemplateId integer required
A numeric id of a dataset
deleteTextTemplate ▼
Delete TextTemplate for a given textTemplateId
Parameters
textTemplateId integer required
A numeric id of a dataset
getTimezones ▼
Returns a list of all timezones supported in CrewBrain.
Parameters
No parameters required
getUsergroupCollection ▼
List Usergroups
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
getUsergroup ▼
Get Usergroup for a given groupId
Parameters
groupId integer required
A numeric id of a dataset
getVehicleCollection ▼
List Vehicles
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
postVehicle ▼
Create new Vehicle
Parameters
Avatar string optional
BranchID integer optional
Description string optional
ExternalID string optional
LicensePlate string optional
MileageAllowance number optional
Format: float
Notes string optional
Payload number optional
Format: float
Seats integer optional
Type string optional
Allowed values:
CAR TRAILER
putVehicle ▼
Change Vehicle for a given vehicleId
Parameters
Avatar string optional
BranchID integer optional
Description string optional
ExternalID string optional
LicensePlate string optional
MileageAllowance number optional
Format: float
Notes string optional
Payload number optional
Format: float
Seats integer optional
Type string optional
Allowed values:
CAR TRAILER
vehicleId integer required
A numeric id of a dataset
deleteVehicle ▼
Delete Vehicle for a given vehicleId
Parameters
vehicleId integer required
A numeric id of a dataset
getVehicle ▼
Get Vehicle for a given vehicleId
Parameters
vehicleId integer required
A numeric id of a dataset
getAdditionalVehicleDataTypes ▼
Returns the additional data types associated with a vehicle object.
Parameters
vehicleId integer required
A numeric id of a dataset
bulkPutToVehicleAdditionalData ▼
Allows the user to edit a multiple additional data types for a vehicle object.
Parameters
requestBody array optional
vehicleId integer required
A numeric id of a dataset
addDocumentToVehicleAdditionalData ▼
Allows the user to upload a document if the additional data type for vehicle is of type document.
Parameters
Base64String string optional
Filename string optional
Filetype string optional
overwriteSingleDocument boolean optional
Replaces the existing additional data document, if present
typeId integer required
A numeric id of a dataset
vehicleId integer required
A numeric id of a dataset
getVehicleCategoryCollection ▼
List VehicleCategorys
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
vehicleId integer required
A numeric id of a dataset
postVehicleCategory ▼
Create new VehicleCategory
Parameters
Assignment string optional
Allowed values:
EMPLOYEE
AssignmentID integer optional
CategoryID integer optional
Skilllevel integer optional
vehicleId integer required
A numeric id of a dataset
deleteVehicleCategory ▼
Delete VehicleCategory for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
vehicleId integer required
A numeric id of a dataset
getVehicleCategory ▼
Get VehicleCategory for a given categoryId
Parameters
categoryId integer required
A numeric id of a dataset
vehicleId integer required
A numeric id of a dataset
putVehicleCategory ▼
Change VehicleCategory for a given categoryId
Parameters
Skilllevel integer optional
categoryId integer required
A numeric id of a dataset
vehicleId integer required
A numeric id of a dataset
postWorkinghour ▼
Create new Workinghour
Parameters
Activity string optional
Assignment string optional
Allowed values:
INDEPENDENTHOURS JOBEMPLOYEE PROJECT TASK
AssignmentID integer optional
CaptureMode string optional
CategoryID integer optional
DateFrom string optional
Format: date-time
DateUntil string optional
Format: date-time
EmployeeID integer optional
EndLatitude number optional
Format: float
EndLongitude number optional
Format: float
ExternalID string optional
SignatureID integer optional
StartLatitude number optional
Format: float
StartLongitude number optional
Format: float
Type string optional
getWorkinghourCollection ▼
List Workinghours
Parameters
fields array optional
Comma separated list of fields to be returned; use this to reduce the result to necessary fields only
limit integer optional
Number of datasets to be returned
offset integer optional
Number of datasets to skip at the beginning of the result
search string optional
Search text that gets searched across multiple predefined columns
sort array optional
Comma separated list of fields the result should be sorted after, ASC by default; prefix a field with `-` for DESC.
bulkApproveWorkingHour ▼
Allows the user to change the approval state of a list of working hours.
Parameters
Approve boolean optional
ArrayIds array optional
Remark string optional
postWorkinghourBulkDelete ▼
Delete Workinghour for a multiple given ids at once
Parameters
ArrayIds array optional
deleteWorkinghour ▼
Delete Workinghour for a given workinghourId
Parameters
workinghourId integer required
A numeric id of a dataset
getWorkinghour ▼
Get Workinghour for a given workinghourId
Parameters
workinghourId integer required
A numeric id of a dataset
putWorkinghour ▼
Change Workinghour for a given workinghourId
Parameters
Activity string optional
Assignment string optional
Allowed values:
INDEPENDENTHOURS JOBEMPLOYEE PROJECT TASK
AssignmentID integer optional
CaptureMode string optional
CategoryID integer optional
DateFrom string optional
Format: date-time
DateUntil string optional
Format: date-time
EmployeeID integer optional
EndLatitude number optional
Format: float
EndLongitude number optional
Format: float
ExternalID string optional
SignatureID integer optional
StartLatitude number optional
Format: float
StartLongitude number optional
Format: float
workinghourId integer required
A numeric id of a dataset
approveWorkingHour ▼
Allows the user to change the approval state of a working hour.
Parameters
Approve boolean optional
Remark string optional
workinghourId integer required
A numeric id of a dataset