Overview
Configuration is provided for establishing connections with the Humanity service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
Base URL address: https://www.humanity.com/api/v2.
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
- username: Required. Specify user name.
- password: Required. Specify password.
The following request parameters will be automatically processed during the authentication process:
-
access_token:
{{=token.Access}}
Documentation: https://humanity-v2-publicapi.readme.io/v1.0/docs#section-the-guide.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-companies.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.id}}/settings.The following request parameters will be automatically processed:
-
item:
{{=item.settings}}
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-company-settings.
-
item:
- id
A key field. Data type: DT_I4
- name
Template: ShortText. A read-only field.
- parent
Template: LongText. A read-only field. A composite field.
- is_parent
Data type: DT_I4 A read-only field.
- domain
Template: ShortText. A read-only field.
- created
Template: DateTime. A read-only field.
- language
Template: ShortText. A read-only field.
- master
Data type: DT_I4 A read-only field.
- franchise
Data type: DT_I4 A read-only field.
- settings
Field components:
-
Uses template:
ShortText. - Contains the following components: admin_past_edit, book_days_off, book_days_off_adv, book_days_off_max, confirm_trade_before, confirm_trade_after, sms, email, pm, visible_staff, visible_staff_details, visible_coworkers, trade_shifts, coworkers_contacts, future_avail, weekly_avail, visible_overview, visible_own, timeout, message_wall_on, message_wall_emp, message_wall_comments, message_wall_uploads, on_now, shift_confirm, shift_autoconfirm, timeclock, tc_terminal_lock, tc_round_to, tc_round_to_in, tc_round_to_out, tc_clock_in_timeframe, tc_clock_out_timeframe, tc_autoclockout, tc_webcam, tc_empl_import, tc_empl_addtime, tc_empl_edittime, 24hr, draft, date, startday, currency, viewadvance, login_splogo, scosting, start_day, end_day, start_time, end_time, overtime, timezone.
-
Uses template:
- admin
Template: User. A read-only field.
- staff
A read-only field. Field components:
- An array.
-
Uses template:
User.
- locations
Template: LongText. A read-only field. A composite field.
- positions
A read-only field. Field components:
- An array.
- Contains the following components: id, name, l_name, l_id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-locations.
- [Create] action
-
Endpoint URL address:
/locations.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-location.
- [Update] action
-
Endpoint URL address:
/locations/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-location.
- [Delete] action
-
Endpoint URL address:
/locations/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-location.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- country
Template: ShortText.
- address
Template: ShortText.
- lat
Data type: DT_R8
- lon
Data type: DT_R8
- store
Data type: DT_I4
- type
Data type: DT_I4
- notes
Template: LongText.
- timezone_id
Data type: DT_I4
- map
Template: ShortText. A read-only field.
- directions
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/positions.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-positions.
- [Create] action
-
Endpoint URL address:
/positions.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-position.
- [Update] action
-
Endpoint URL address:
/positions/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-position.
- [Delete] action
-
Endpoint URL address:
/positions/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-position.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- active
Data type: DT_I4
- start_time
Template: ShortText.
- end_time
Template: ShortText.
- color
Data type: DT_I4
- ical
Template: ShortText. A read-only field.
- visible
Data type: DT_I4
- notify
Data type: DT_I4 A read-only field.
- job_code
Template: LongText. A read-only field. A composite field.
- location
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/employees.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-employees.
- [Create] action
-
Endpoint URL address:
/employees.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-empolyees.
- [Update] action
-
Endpoint URL address:
/employees/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-empolyees.
- [Delete] action
-
Endpoint URL address:
/employees/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-employee.
- id
A key field. Data type: DT_I4
- language
Template: ShortText.
- work_start_date
Data type: DT_DBTIMESTAMP
- eid
Data type: DT_I4
- name
Template: ShortText.
- firstname
Template: ShortText.
- middle_name
Template: ShortText.
- lastname
Template: ShortText.
- username
Template: ShortText.
Template: ShortText.
- group
Data type: DT_I4
- status
Data type: DT_I4
- wage
Data type: DT_I4
- nick_name
Template: ShortText.
- birth_day
Data type: DT_I4
- birth_month
Data type: DT_I4
- cell_phone
Template: ShortText.
- home_phone
Template: ShortText.
- avatar
Field components:
-
Uses template:
ShortText. - Contains the following components: small, medium, large.
-
Uses template:
- avatar_url
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- zip
Template: ShortText.
- notes
Template: LongText.
- ical
Template: ShortText.
- registered
Template: DateTime.
- last_active
Template: DateTime.
- p_phone
Data type: DT_I4
- p_email
Data type: DT_I4
- location
Data type: DT_I4
- timezone
Data type: DT_I4
- schedules
Template: LongText. A composite field.
- skills
Template: LongText. A composite field.
- timezone_name
Template: ShortText.
- group_name
Template: ShortText.
- status_name
Template: ShortText.
- custom
Template: LongText. A composite field.
- job_title
Template: ShortText.
- gender
Template: ShortText.
- smsgateway
Data type: DT_I4
- password
Template: ShortText.
- send_activation
Data type: DT_I4
Template: ShortText.
Template: ShortText.
- ldap
Template: ShortText.
- timezone_id
Data type: DT_I4
- undertime
Data type: DT_I4
- overtime
Data type: DT_I4
- daily_overtime
Data type: DT_I4
- max_days_row
Data type: DT_I4
- pref_shift_autoconfirm
Data type: DT_I4
- pref_vacation_max_days
Data type: DT_I4
- positions
Template: LongText. A composite field.
- monthly_overtime
Data type: DT_I4
- monthly_undertime
Data type: DT_I4
- pref_mtimebshifts
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/employees/{{=parameters.employee_id}}/positions.The action has the following user-defined parameters:
- employee_id: Required. Specify employee identifier to returns positions for.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-employees1.
- [Create] action
-
Endpoint URL address:
/employees/{{=item.employee_id}}/positions/{{=item.position_id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-employee-position.
- [Update] action
-
Endpoint URL address:
/employees/{{=item.employee_id}}/positions/{{=item.position_id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-employee-position.
- [Delete] action
-
Endpoint URL address:
/employees/{{=item.employee_id}}/positions/{{=item.position_id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-employee-position.
- id
Data type: DT_I4
- employee_id
A key field. Data type: DT_I4
- position_id
A key field. Data type: DT_I4
- created_by
Data type: DT_I4 A read-only field.
- date
Template: DateTime. A read-only field.
- payroll_ratecard_id
Data type: DT_I4
- payroll_wage
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/timeclocks.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}}
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-timeclocks.
-
page:
- [Create] action
-
Endpoint URL address:
/timeclocks.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-timeclocks.
- [Update] action
-
Endpoint URL address:
/timeclocks/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-timeclocks.
- [Delete] action
-
Endpoint URL address:
/timeclocks/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-timeclock.
- id
A key field. Data type: DT_I4
- start_date
Data type: DT_DBDATE
- start_time
Template: ShortText.
- end_date
Data type: DT_DBDATE
- end_time
Template: ShortText.
- store
Data type: DT_I4 A read-only field.
- status
Data type: DT_I4 A read-only field.
- schedule
Template: ShortText.
- notes
Template: LongText.
- tips
Template: LongText.
- created
Template: DateTime. A read-only field.
- in_timestamp
Template: DateTime. A read-only field.
- in_day
Data type: DT_I4 A read-only field.
- out_timestamp
Template: DateTime. A read-only field.
- out_day
Data type: DT_I4 A read-only field.
- in_hour
Data type: DT_I4 A read-only field.
- out_hour
Data type: DT_I4 A read-only field.
- in_location
Template: ShortText. A read-only field.
- out_location
Template: ShortText. A read-only field.
- in_terminal
Data type: DT_I4 A read-only field.
- out_terminal
Data type: DT_I4 A read-only field.
- approved
Data type: DT_I4
- approved_by
Data type: DT_I4 A read-only field.
- approved_time
Template: DateTime. A read-only field.
- approved_notes
Template: LongText. A read-only field.
- in_picture
Template: ShortText. A read-only field.
- out_picture
Template: ShortText. A read-only field.
- screenshots
Template: LongText. A read-only field. A composite field.
- break_time
Data type: DT_I4 A read-only field.
- start_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- end_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- in_picture_url
Template: ShortText. A read-only field.
- out_picture_url
Template: ShortText. A read-only field.
- in_gps
Template: ShortText. A read-only field.
- out_gps
Template: ShortText. A read-only field.
- shift
Template: ShortText. A read-only field.
- employee
Template: ShortText.
- in_time
Template: Timestamp. A read-only field.
- length
Template: TotalHours. A read-only field.
- out_time
Template: Timestamp. A read-only field.
- current_length
Template: TotalHours. A read-only field.
- events
A read-only field. Field components:
- An array.
- Contains the following components: id, type, timestamp, clock_time, data.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/timeclocks/locations.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-timeclock-location.
- [Create] action
-
Endpoint URL address:
/timeclocks/locations.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-timeclock-location.
- [Delete] action
-
Endpoint URL address:
/timeclocks/locations/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-timeclock-location.
- id
A key field. Data type: DT_I4
- store
Data type: DT_I4 A read-only field.
- user
Data type: DT_I4 A read-only field.
- name
Template: ShortText.
- description
Template: LongText.
- status
Data type: DT_I4 A read-only field.
- type
Data type: DT_I4
- ip
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/timeclocks/terminal.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-timeclocks-terminal.
- [Create] action
-
Endpoint URL address:
/timeclocks/terminal.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-timeclock-terminal.
- [Update] action
-
Endpoint URL address:
/timeclocks/terminal/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-timeclock-terminal.
- [Delete] action
-
Endpoint URL address:
/timeclocks/terminal/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-timeclock-terminal.
- id
A key field. Data type: DT_I4
- store
Data type: DT_I4 A read-only field.
- location
Data type: DT_I4
- key
Template: ShortText. A read-only field.
- name
Template: ShortText.
- pref_login
Data type: DT_I4
- pref_userid
Data type: DT_I4 A read-only field.
- pref_username
Data type: DT_I4 A read-only field.
- pref_password
Data type: DT_I4
- pref_userlist
Data type: DT_I4
- pref_webcam
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shifts.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-shifts.
- [Create] action
-
Endpoint URL address:
/shifts.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-shifts.
- [Update] action
-
Endpoint URL address:
/shifts/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-shifts.
- [Delete] action
-
Endpoint URL address:
/shifts/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-shift.
- id
A key field. Data type: DT_I4
- employee_id
Data type: DT_I4
- created
Template: DateTime. A read-only field.
- published
Template: DateTime. A read-only field.
- edited
Template: DateTime. A read-only field.
- deleted
Data type: DT_I4 A read-only field.
- schedule
Data type: DT_I4
- type
Data type: DT_I4
- needed
Data type: DT_I4
- working
Data type: DT_I4 A read-only field.
- user
Data type: DT_I4 A read-only field.
- start_date
Template: DateDetail.
- end_date
Template: DateDetail.
- length
Data type: DT_I4 A read-only field.
- title
Template: ShortText.
- location
Data type: DT_I4
- notes
Template: LongText.
- confirmed
Data type: DT_I4
- ref
Data type: DT_I4 A read-only field.
- start_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- end_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- traded
Data type: DT_I4 A read-only field.
- confirmed_start_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- confirmed_end_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- absent
Data type: DT_I4 A read-only field.
- perms
Data type: DT_I4 A read-only field.
- schedule_name
Template: ShortText. A read-only field.
- schedule_color
Data type: DT_I4 A read-only field.
- schedule_location_id
Data type: DT_I4 A read-only field.
- cost
A read-only field. Field components:
- Contains the following components: staff, hours, dollars.
- start_time
Template: ShortText.
- end_time
Template: ShortText.
- paidtime
Data type: DT_I4 A read-only field.
- employees
A read-only field. Field components:
- An array.
- Contains the following components: id, avatar, name, status, wage, notified_day, notified_hour, last_active, rate, ratecard, absent, cost, confirmed_start, confirmed_end.
- trades
Template: LongText. A read-only field. A composite field.
- approve_overtime
Data type: DT_I4
- add
Template: ShortText.
- remove
Data type: DT_I4
- detailed
Template: ShortText.
- force
Data type: DT_I4
- repeat
Data type: DT_I4
- repeat_until
Template: ShortText.
- repeat_staff
Data type: DT_I4
- repeat_custom
Template: ShortText.
- repeat_cycle
Template: ShortText.
- repeat_cycle_on
Template: ShortText.
- repeat_cycle_step
Data type: DT_I4
- update_series
Template: ShortText.
- update_staff
Data type: DT_I4
- update_time
Data type: DT_I4
- update_type
Data type: DT_I4
- update_notes
Data type: DT_I4
- update_schedule
Data type: DT_I4
- update_tasks
Data type: DT_I4
- copy_to
Template: ShortText.
- restore
Data type: DT_I4
- addOnCall
Data type: DT_I4
- removeOnCall
Data type: DT_I4
- do_not_initiate_conflicts
Data type: DT_I4
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/shifts/{{=item.id}}/approve.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-shifts-approve.
- [Update] action
-
Endpoint URL address:
/shifts/{{=item.id}}/approve.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-shifts-approve.
- [Delete] action
-
Endpoint URL address:
/shifts/{{=item.id}}/approve.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-shifts-approve.
- id
A key field. Data type: DT_I4
- employee
Data type: DT_I4
- absent
Data type: DT_I4
- start_time
Template: ShortText.
- end_time
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shifts/{{=parameters.shift_id}}/tradelist.
The result is extracted from:{{=_.map(response.data, function(item, key) { return _.extend({ id: key }, item); })}}.The action has the following user-defined parameters:
- shift_id: Required. Specify shift identifier.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-tradelist.
- id
Data type: DT_I4
- name
Template: ShortText.
- shifts
The gathered value is processed with
{{=_.map(item.shifts, function(item, key) { return _.extend({ id: key }, item); })}}expression. Field components:- An array.
- Contains the following components: id, start, end, name.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/trades.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#1.
- [Create] action
-
Endpoint URL address:
/trades.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-trade.
- [Update] action
-
Endpoint URL address:
/trades/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-trade.
- id
A key field. Data type: DT_I4
- tradewith
Data type: DT_I4
- action
Template: ShortText.
- status
Data type: DT_I4 A read-only field.
- user
Data type: DT_I4
- shift
Data type: DT_I4
- store
Data type: DT_I4 A read-only field.
- reference
Template: LongText. A read-only field. A composite field.
- reason
Template: ShortText.
- date
Template: DateTime. A read-only field.
- confirm_before
Data type: DT_I4 A read-only field.
- confirm_after
Data type: DT_I4 A read-only field.
- trade_to
Data type: DT_I4 A read-only field.
- shift_start_date
Template: DateDetail. A read-only field.
- shift_start
Data type: DT_I4 A read-only field.
- shift_end
Data type: DT_I4 A read-only field.
- shift_schedule
Data type: DT_I4 A read-only field.
- schedule_name
Template: ShortText. A read-only field.
- user_name
Template: ShortText. A read-only field.
- requested
Template: DateDetail. A read-only field.
- shift_start_time
Template: ShortText. A read-only field.
- shift_end_time
Template: ShortText. A read-only field.
- traders
A read-only field. Field components:
- Contains the following components: data.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collisions.The action has the following user-defined parameters:
- start_date: Required. Specifies start date.
- end_date: Required. Specifies end date.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-collisions.
- type
Data type: DT_I4
- user
Data type: DT_I4
- position
Data type: DT_I4
- extras
Field components:
-
Uses template:
ShortText. - Contains the following components: shift, name.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/conflicts.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-conflicts.
- employee
Data type: DT_I4
- title
Template: ShortText.
- date
Template: DateDetail.
- shift
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/leaves.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-leaves.
- [Create] action
-
Endpoint URL address:
/leaves.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-leaves.
- [Update] action
-
Endpoint URL address:
/leaves/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-leaves.
- [Delete] action
-
Endpoint URL address:
/leaves/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-leave.
- id
A key field. Data type: DT_I4
- user
Data type: DT_I4 A read-only field.
- store
Data type: DT_I4 A read-only field.
- date
Template: DateTime. A read-only field.
- requested_on
Template: DateDetail. A read-only field.
- approved_on
Template: DateTime. A read-only field.
- status
Data type: DT_I4
- admin
Data type: DT_I4 A read-only field.
- comments
Template: LongText.
- notes
Template: LongText.
- start_day
Template: DateDetail.
- end_day
Template: DateDetail.
- requested_on_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- start_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- end_timestamp
Data type: DT_DBTIMESTAMP A read-only field.
- leave_type
Data type: DT_I4
- approved_by
Data type: DT_I4 A read-only field.
- rejected_by
Data type: DT_I4 A read-only field.
- rejected_on
Template: DateTime. A read-only field.
- reason
Template: ShortText.
- employee_name
Template: ShortText. A read-only field.
- leave_type_name
Template: ShortText. A read-only field.
- employee
Data type: DT_I4
- until
Template: DateDetail. A read-only field.
- total_days
Data type: DT_I4 A read-only field.
- length
Data type: DT_I4 A read-only field.
- total_days_alotted
Data type: DT_I4 A read-only field.
- start_time
Template: ShortText.
- end_time
Template: ShortText.
- force_user_timezone
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/leave-types.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-leave-types.
- [Update] action
-
Endpoint URL address:
/leave-types/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-leave-type.
- id
A key field. Data type: DT_I4
- name
Template: ShortText. A read-only field.
- allow_hourly
Data type: DT_I4
- days_booked_in_advance
Data type: DT_I4
- do_not_deduct
Data type: DT_I4
- max_num_at_once
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payroll/ratecards.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-ratecards.
- [Create] action
-
Endpoint URL address:
/payroll/ratecards.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-ratecards.
- [Update] action
-
Endpoint URL address:
/payroll/ratecards/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-ratecards.
- [Delete] action
-
Endpoint URL address:
/payroll/ratecards/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-ratecards.
- id
A key field. Data type: DT_I4
- store_id
Data type: DT_I4 A read-only field.
- name
Template: ShortText.
- is_default
Data type: DT_I4 A read-only field.
- is_stack_enabled
Data type: DT_I4
- rules
Template: LongText. A composite field.
- created_by
Data type: DT_I4 A read-only field.
- updated_by
Data type: DT_I4 A read-only field.
- deleted_by
Data type: DT_I4 A read-only field.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
- deleted_at
Data type: DT_DBTIMESTAMP A read-only field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/sales/store.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-store.
- [Update] action
-
Endpoint URL address:
/sales/store/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-store.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
Template: ShortText.
- domain
Template: ShortText.
- business
Template: ShortText.
- phone
Template: ShortText.
- extra_setup
Template: ShortText.
- password
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- products
Template: ShortText.
- sms_phone
Template: ShortText.
- locations
Template: LongText.
- steps
Template: LongText.
- country
Template: ShortText.
- employees
Template: LongText.
- indistry
Data type: DT_I4
- timezone
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messages.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-messages.
- [Create] action
-
Endpoint URL address:
/messages.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-message.
- [Update] action
-
Endpoint URL address:
/messages/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-message.
- [Delete] action
-
Endpoint URL address:
/messages/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-message.
- id
A key field. Data type: DT_I4
- from
Template: User. A read-only field.
- to
Template: User.
- type
Data type: DT_I4 A read-only field.
- replyto
Data type: DT_I4 A read-only field.
- date_sent
Template: DateTime. A read-only field.
- date_read
Template: DateTime. A read-only field.
- subject
Template: ShortText.
- message
Template: LongText.
- message_formatted
Template: LongText. A read-only field.
- date_sent_formatted
Template: DateDetail. A read-only field.
- date_read_formatted
Template: DateDetail. A read-only field.
- read
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messages/wall.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-wall-messages.
- [Create] action
-
Endpoint URL address:
/messages/wall.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-wall-message.
- [Delete] action
-
Endpoint URL address:
/messages/wall/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-wall-message.
- id
A key field. Data type: DT_I4
- user
Template: User. A read-only field.
- date
Template: DateTime. A read-only field.
- sticky
Data type: DT_I4
- title
Template: ShortText.
- post
Template: LongText.
- title_formatted
Template: ShortText. A read-only field.
- post_formatted
Template: LongText. A read-only field.
- comments
A read-only field. Field components:
- An array.
- Contains the following components: id, user, date, comment, comment_formatted.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notices.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-notices.
- [Create] action
-
Endpoint URL address:
/notices.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-notice.
- [Update] action
-
Endpoint URL address:
/notices/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-notice.
- [Delete] action
-
Endpoint URL address:
/notices/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-nottice.
- id
A key field. Data type: DT_I4
- groups
Template: ShortText.
- subject
Template: ShortText.
- message
Template: LongText.
- start_timestamp
Data type: DT_DBTIMESTAMP
- end_timestamp
Data type: DT_DBTIMESTAMP
- visible_name
Data type: DT_I4
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/ical.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-ical.
- [Update] action
-
Endpoint URL address:
/ical/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-ical.
- [Delete] action
-
Endpoint URL address:
/ical/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-ical.
- id
A key field. Data type: DT_I4
- url
Template: ShortText.
- name
Template: ShortText.
- update_interval
Template: ShortText.
- sync
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/trainings/sections.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-training-sections.
- [Create] action
-
Endpoint URL address:
/trainings/sections.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-training-section.
- [Update] action
-
Endpoint URL address:
/trainings/sections/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-training-section.
- [Delete] action
-
Endpoint URL address:
/trainings/sections/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-training-section.
- id
A key field. Data type: DT_I4
- store
Data type: DT_I4 A read-only field.
- title
Template: ShortText.
- created
Template: DateTime. A read-only field.
- created_by
Data type: DT_I4 A read-only field.
- deleted
Data type: DT_I4 A read-only field.
- deleted_by
Data type: DT_I4 A read-only field.
- order
Data type: DT_I4 A read-only field.
- synced
Data type: DT_I4 The value is sent to
/trainings/sections/{{=item.id}}/syncaddress.- synced_by
Data type: DT_I4 A read-only field.
- global
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/trainings/modules.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-training-modules.
- [Create] action
-
Endpoint URL address:
/trainings/modules.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-training-modules.
- [Update] action
-
Endpoint URL address:
/trainings/modules/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-training-module.
- [Delete] action
-
Endpoint URL address:
/trainings/modules/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-training-module.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- section
Data type: DT_I4
- child_edit
Data type: DT_I4
- orig_cm_id
Data type: DT_I4 A read-only field.
- contents
Template: LongText.
- video
Template: ShortText.
- iframe
Template: ShortText.
- mintime
Data type: DT_I4
- tutorial
Data type: DT_I4
- duedate
Data type: DT_DBDATE
- est_time
Data type: DT_DBDATE
- addgroup
Data type: DT_I4
- removegroup
Data type: DT_I4
- add_group
Template: LongText. A composite field.
- remove_group
Template: LongText. A composite field.
- add_skill
Data type: DT_I4
- remove_skill
Data type: DT_I4
- add_user_training
Data type: DT_I4
- addlocation
Data type: DT_I4
- removelocation
Data type: DT_I4
- reset
Data type: DT_I4
- silent
Data type: DT_I4
- comment_type
Data type: DT_I4
- can_see_comment
Data type: DT_I4
- digital_signature
Data type: DT_I4 The value is gathered from
/trainings/modules/{{=item.id}}/digital_signatureaddress. The gathered value is processed with{{=response.data}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, store, user, type, text, file, status, module, created, updated, ip_address, name, avatar.
-
Uses template:
- download_pdf
Data type: DT_I4
- questions
Template: LongText. A composite field.
- comments
The value is gathered from
/trainings/modules/{{=item.id}}/commentsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, store, user, type, text, file, status, module, created, updated, ip_address, name, avatar.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shifts/work-units.The action has the following user-defined parameters:
- start_timestamp: Required. Start time.
- end_timestamp: Required. End time.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-workunits.
- [Read shift_id] action
-
Endpoint URL address:
/shifts/{{=parameters.shift_id}}/work-units.The action has the following user-defined parameters:
- shift_id: Required. Specify shift identifier.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-workunit.
- permissions
Field components:
- Contains the following components: manager.
- shift
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, start, end.
-
Uses template:
- schedule
Field components:
-
Uses template:
ShortText. - Contains the following components: id, active, notify, store, user, name, start, end, location, color, ical, visible, job_code.
-
Uses template:
- wuTypes
Template: LongText. A composite field.
- users
The gathered value is processed with
{{=_.values(item.users)}}expression. Field components:- An array.
- Contains the following components: id, name, shift_user_id, wu.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workunits/types.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-workunits-types.
- [Create] action
-
Endpoint URL address:
/workunits/types.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-workunits-types.
- [Update] action
-
Endpoint URL address:
/workunits/types/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-workunits-types.
- [Delete] action
-
Endpoint URL address:
/workunits/types/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-workunits-type.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: LongText.
- pay_rate
Template: ShortText.
- schedules
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports/schedule.
The result is extracted from:{{=_.values(response.data)}}.The action has the following user-defined parameters:
- start_date: Required. Start date
- end_date: Required. Start date
- type: Required.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-schedule-report.
- id
Data type: DT_I4
- series
Data type: DT_I4
- created
Template: DateTime.
- published
Template: DateTime.
- edited
Template: DateTime.
- deleted
Template: DateTime.
- recurs
Data type: DT_I4
- recur_rule
Data type: DT_I4
- schedule
Data type: DT_I4
- store
Data type: DT_I4
- type
Data type: DT_I4
- needed
Data type: DT_I4
- have
Data type: DT_I4
- working
Data type: DT_I4
- user
Data type: DT_I4
- start_date
Template: DateDetail.
- end_date
Template: DateDetail.
- start
Template: ShortText.
- end
Template: ShortText.
- length
Data type: DT_I4
- title
Template: ShortText.
- location
Data type: DT_I4
- notes
Template: LongText.
- confirmed
Data type: DT_I4
- schedule_name
Template: ShortText.
- schedule_color
Data type: DT_I4
- employee
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports/budget.The action has the following user-defined parameters:
- start_date: Required. Start date
- end_date: Required. Start date
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-budget-report.
- dates
Field components:
- An array.
- Contains the following components: id, year, week, last_day_in_week, formatted.
- weeks
The gathered value is processed with
{{=_.values(_.values(item.weeks))}}expression. Field components:- An array.
- Contains the following components: year, week, start, end.
- locations
The gathered value is processed with
{{=_.values(item.locations)}}expression. Field components:- An array.
- Contains the following components: id, name, budget, date, week.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports/timesheets.The action has the following user-defined parameters:
- start_date: Required. Start date
- end_date: Required. Start date
- type: Required.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-timesheets-report.
- id
Data type: DT_I4
- name
Template: ShortText.
- shifts
Data type: DT_I4
- hours_scheduled
Data type: DT_I4
- hours_clocked
Data type: DT_I4
- late
Data type: DT_I4
- absent
Data type: DT_I4
- karma
Data type: DT_I4
- percent
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports/employee.
The result is extracted from:{{=_.pluck(response.data.dates, 'date')}}.The action has the following user-defined parameters:
- start_date: Required. Start date
- end_date: Required. Start date
- type: Required.
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-employee-report.
The resource includes the fields from the DateDetail template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/skills.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-skills.
- [Create] action
-
Endpoint URL address:
/skills.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-skills.
- [Update] action
-
Endpoint URL address:
/skills/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-skill.
- [Delete] action
-
Endpoint URL address:
/skills/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-skill.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notes.
The result is extracted from:{{=_.map(response.data, function(item, key) { return _.extend({ id: key }, item); })}}.The action has the following user-defined parameters:
- start_date: Required. Start date
Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-notes.
- [Create] action
-
Endpoint URL address:
/notes.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#post-note.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#put-note.
- [Delete] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#delete-note.
- id
A key field. Data type: DT_I4
- note
Template: LongText.
- author
Template: ShortText. A read-only field.
- author_id
Data type: DT_I4 A read-only field.
- date
Data type: DT_I4
- created
Data type: DT_DBTIMESTAMP A read-only field.
- date_formatted
Template: ShortText. A read-only field.
- published
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dashboard/notifications.Documentation: https://humanity-v2-publicapi.readme.io/v2.0/reference#get-notifications.
Data type: DT_BOOL
- avatar
Data type: DT_BOOL
- logo
Data type: DT_BOOL
- vacation_approval
Data type: DT_I4
- shift_pickups_approval
Data type: DT_I4
- republish_shifts
Data type: DT_I4
- missing_assigments
Data type: DT_I4
- weekly_avail_requests
Data type: DT_I4
- future_avail_requests
Data type: DT_I4
- timeclock_notify
Data type: DT_I4
- shift_trades
Data type: DT_I4
- open_shifts
Data type: DT_I4
- [Read] action
-
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
item:
{{=item}}
-
item:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
item:
{{=item}}
-
item:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(parseInt(value) * 1000).toUTCString() || undefined}}expression.- Timestamp
Field components:
-
Uses template:
ShortText. - Contains the following components: time, day, timestamp.
-
Uses template:
- TotalHours
Field components:
- Contains the following components: hours, mins, total_hours.
- DateDetail
Field components:
-
Uses template:
ShortText. - Contains the following components: id, month, day, wday, year, weekday, mname, week, dayid, timeid, timeid_exact, formatted, time, timestamp, hours, minutes, seconds, date, day_of_year, week_adjusted, sp_wday.
-
Uses template:
- Time
Field components:
-
Uses template:
ShortText. - Contains the following components: id, time.
-
Uses template:
- User
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, email.
-
Uses template:
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.