Data Share : Data Model

tenant_id

string

Name of the Assignar instance

asset_external_id

string

Asset External ID
External ID is used for importing data from external systems.

asset_id

int

Asset ID

asset_name

string

Name of the Asset

avg_hourly_rate

numeric

This is the hourly rate of the asset.

client_company_name

string

Company name

client_external_id

string

Client’s External ID
External ID is used for importing data from external systems.

client_id

int

Client ID

client_name

string

Name of the client

fieldworker_user_id

int

Fieldworker ID

fw_dob

date

Fieldworker date of birth

fw_emergency_contact_name

string

Full Name of the Emergency Contact

fw_employee_id

string

Fieldworker Employee ID

fw_employment_type

string

Type of Employee, whether they are Permanent or Casual, Full Time or Part Time.

fw_first_name

string

First Name of the employee

fw_full_name

string

Full Name of the employee

fw_last_name

string

Last Name of the employee

fw_tags

string

This is a combination of all the tags associated with this Employee. they are separated by a '~'.

fw_user_age

int

Age of the Fieldworker

fw_user_type

string

Type of user - Fieldworker

notified_comment

string

This is the comment added to an order via the notify tab of the order

order_active_flag

boolean

Boolean representation of active or archived Order

True = order is still active
False = order is not active

order_date_created

timestamp

Date when the order was created

order_end_date

date

Date as to when the order is supposed to end.

order_id

int

Order ID

order_job_description

string

This is a short description of the Order

order_latitude

decimal

Order Location 1 gets converted to Latitude

order_location1

string

Address where the order will be completed

order_longitude

decimal

Order Location 1 gets converted to Longitude

order_purchase_order_number

string

Purchase Order Number

order_resource_status

string

Status of the resource allocation
i.e. pending, confirmed, declined

order_resource_total_time

numeric

Duration between check-in and check-out

order_shift_allocation_time_in_hours

numeric

Shift time in hours

order_shift_date

date

shift date for a task

order_shift_end_time

string

Order shift end time

order_shift_index

int

shifts within tasks

order_shift_start_time

string

Order shift start time

order_start_date

date

Date as to when the order will actually start. this date can be different from order date created.

order_status

string

Status of the order

order_tags

string

This is a combination of all the tags associated with this order. They are separated by a '~'.

order_task_description

string

Description of order task

order_type

string

Type of Order

order_work_order_number

string

Work Order Number

project_end_date

date

Project End Date

project_external_id

string

Project’s External ID

External ID is used for importing data from external systems.

project_id

int

Project ID

project_name

string

Name of Project

project_start_date

date

Project Start Date

task_external_id

string

Task’s External ID

External ID is used for importing data from external systems.

task_id

int

Task ID

task_name

string

Task Name

task_qty

int

Qty of the tasks required

timesheet_id

int

Timesheet ID

work_item_code

string

This is the code associated to an order task

work_item_id

int

Work Item ID

work_item_label

string

Work Item Label/Description

tenant_id

string

Name of the Assignar instance

allocation_order_resource_allocation_date

date

Date when the resource is allocated/assigned

allocation_order_shift_allocation_time_in_hours

numeric

Order shift time in hours

asset_active_flag

int

Boolean representation of active or archived Asset

1 = asset is still active
0 = asset is not active

asset_external_id

string

Asset’s External ID (used for linking the asset to an external system)

asset_id

int

Asset ID

asset_make

string

Asset Make

asset_model

string

Asset Model

asset_name

string

Name of the asset

asset_rego_number

string

Registration Number of an asset

asset_serial_number

string

Serial Number of an asset

asset_year

string

Asset Year

avg_hourly_rate

int

This is the hourly rate of the asset.

comments

string

Used to add extra context to an asset

number_reading

numeric

This is generally used to measure odometer readings or operating hours etc.

order_id

int

Order ID

project_name

string

Name of the project

tags

string

This column is a combination of all the tags associated with this asset. They are separated by a '~'.

tenant_id

string

Name of the Assignar instance

competency_id

int

Competency ID

competency_name

string

Competency Name

competency_user_date_of_expiry

date

User Competency Expiry Date

competency_user_description

string

Free text field to add descriptions and more context

competency_user_expired

string

Shows if the user competency has expired.

competency_user_issue_date

date

User Competency Issue Date

expiry_date_required_flag

int

If an expiry date is required or not. If the flag is 1, this indicates that this competency will expire and hence  will have an expiry date

fieldworker_user_id

int

Fieldworker ID

fw_active_flag

boolean

Yes = Worker is still active

No = Worker is not active

fw_employee_id

int

Worker Employee id

fw_employment_type

string

Type of Employee, whether they are Permanent or Casual, Full Time or Part Time.

fw_full_name

string

Full Name of the worker

fw_no_of_competencies

int

count of Competencies acquired by worker

fw_tags

string

This column is a combination of all the tags associated with the worker separated by a '~'

issue_date_required_flag

int

If the flag is 1, this indicates that this competency will need to have an issue date

skill_name

string

Skill Name

tenant_id

string

Name of the Assignar instance

answer_asset_id

int

If the question type is asset then the answer (Asset ID) is stored here

answer_asset_name

string

If the question type is asset then the answer (Asset Name) is stored here

answer_shift_break_time

int

Shift break time answer

answer_shift_end

timestamp

Shift end datetime answer

answer_shift_start

timestamp

Shift start datetime answer

answer_shift_total_time

int

Shift total time answer

answer_task_id

int

If the question type is task then the answer (Task ID) is stored here

answer_task_name

string

If the question type is task then the answer (Task Name) is stored here

answer_worker_id

int

If the question type is worker then the answer (Worker ID) is stored here

answer_worker_name

string

If the question type is worker then the answer (Worker Name) is stored here

client_id

int

Client ID

client_name

string

Name of the client

created_by_fieldworker_name

string

Worker name who created the docket

created_by_fieldworker_user_id

int

Worker ID who created docket

digital_docket_id

int

Digital docket id

digital_docket_template_id

int

ID of the docket template. 

digital_docket_template_title

string

Title of the digital docket template

docket_date

timestamp

Docket Created Date

fieldworker_supervisor_user_id

int

Fieldworker’s supervisor ID

order_id

int

Order ID

project_id

int

Project ID

project_name

string

Name of the project

question

string

The actual written question on the Docket

question_array_index

int

Group question Index

question_id

int

Question ID

result_answers

string

The actual written answer to the question on the Docket

sub_question

string

Group question/Sub question

submission_date

timestamp

Docket Submitted date

tenant_id

string

Name of the Assignar instance

allocation_order_resource_allocation_date

date

Date when the resource is allocated/assigned

fieldworker_user_id

int

Fieldworker ID

fw_active_flag

boolean

True = worker is still active
False = worker is not active

fw_address

string

Address of the worker

fw_contact_info

string

Contact Information of the worker

fw_email

string

Email address of worker

fw_emergency_contact

string

Emergency Contact Information

fw_emergency_contact_name

string

Full Name of the Emergency Contact

fw_employee_id

string

Worker employee ID

fw_employment_type

string

Type of Employee (Permanent, Casual, Full Time, Part Time)

fw_full_name

string

Full Name of the employee

fw_postcode

string

Worker’s postcode

fw_state

string

Worker’s state

fw_suburb

string

Worker’s suburb

fw_tags

string

This column is a combination of all the tags associated with this worker separated by a '~'

leave_end_datetime

timestamp

Leave end date

leave_start_datetime

timestamp

Leave start date

leave_type

string

Worker Leave type

order_id

int

Order ID

order_work_order_number

string

Work Order Number

tenant_id

string

Name of the Assignar instance

answer_asset_name

string

If the question type is asset then the answer gets stored here

answer_datetime

string

If the question type is datetime then the answer gets stored here

answer_number

int

If the question type is int then the answer gets stored here

answer_status

string

Status of the answer

answer_text

string

If the question type is string (free text) then the answer gets stored here

answer_worker_name

string

If the question type is worker then the answer gets stored here

asset_id

int

Asset ID

asset_name

string

Asset Name

asset_rego_number

string

Asset Registration Number

asset_tags

string

This column is a combination of all the tags associated with this asset separated by a '~'

client_external_id

string

Client External ID

client_id

int

Client ID

client_name

string

Client name

fieldworker_user_id

int

Fieldworker ID

form_id

int

Form ID

form_name

string

Form Name

form_result_created_date

timestamp

Date when the form was created

form_result_id

int

Form Result ID

form_result_status

string

Status of the form result

form_result_submitted_date

timestamp

Date when the form was submitted

fw_employee_id

string

Worker Employee ID

fw_full_name

string

Full Name of the worker

order_id

int

Order ID

order_job_description

string

Detailed description of what the order entails

order_location1

string

Address where the order will be completed

order_tag

string

This column is a combination of all the tags associated with this order separated by a '~'

project_external_id

string

Project External ID

project_id

int

Project ID

project_name

string

Project Name

question

string

Actual question text within the form

question_array_index

int

Question index for sub questions

result_answers

string

Actual text answer to the question

sub_question

string

Sub question within the form

supplier_name

string

Supplier Name

tenant_id

string

Name of the Assignar instance

client_name

string

Name of the client

fw_active_flag

boolean

True = worker is still active
False = worker is not active

fw_employee_id

string

Worker employee ID

fw_employment_type

string

Type of Employee (Casual, Full Time, Part Time...)

fw_full_name

string

Worker full name

fw_no_of_inductions

int

Count of inductions acquired by worker

induction_expiry_date_required_flag

int

A value of 1 indicates the induction requires an issue date

induction_id

int

Induction ID

induction_issue_date_required_flag

int

A value of 1 indicates the induction requires an issue date

induction_name

string

Name of induction

induction_user_date_of_creation

timestamp

User Induction creation date

induction_user_date_of_expiry

date

User Induction expiry date

induction_user_disabled

int

If the user induction is disabled

induction_user_issue_date

date

User Induction issue date

project_name

string

Name of the project

tenant_id

string

Name of the Assignar instance

activity_id

int

Activity ID

activity_name

string

Name of the activity

activity_quantity_unit

string

Unit of the activity quantity (i.e. sqft, lbs, kgs)

daily_activity_progress

int

How much progress was made in this entry (i.e. 50)

daily_labour_hours

numeric

Daily labour hours against the activity

order_id

int

Order ID

order_job_description

string

This is a short description of the Order

order_progress_created_at

date

Date when the order progress was created

target_activity_progress

int

Target activity progress (i.e. 1000)

total_activity_progress

int

Total activity progress (today 50 ft of pipe were laid, bringing the total to 400 ft, and the completion target is 1000 ft)

total_labour_hours

numeric

Total labour hours logged against the activity

tenant_id

string

Name of the Assignar instance

job_description

string

This is a short description of the Order

order_id

int

Order ID

order_status_created_at

date

Created time of order status

order_status_name

string

Order status name

tenant_id

string

Name of the Assignar instance

client_external_id

string

Client’s External ID, used for importing data from external systems

client_id

int

Client ID

client_name

string

Name of the client

dashboard_user_full_name

string

Full name of the dashboard user

order_active_flag

boolean

True = order is still active
False = order is not active

order_comments

string

Any additional information or comments that need to be given for this order

order_end_date

date

Date as to when the order is supposed to end

order_id

int

Order ID

order_job_description

string

This is a short description of the Order

order_location1

string

Address where the order will be completed

order_purchase_order_number

string

Purchase Order Number

order_shift_date

date

shift date for a task

order_shift_end_time

string

Order shift end time

order_shift_index

int

shifts within tasks

order_shift_start_time

string

Order shift start time

order_start_date

date

Date as to when the order will actually start (can be different from order date created)

order_status

string

Status of the order

order_tags

string

This is a combination of all the tags associated with this order separated by a '~'

order_task_description

string

Description of order task

order_type

string

Type of Order

order_work_order_number

string

Work Order Number

parent_project

string

Parent project name

project_active_flag

boolean

True = project is still active
False = project is not active

project_duration_in_days

int

Number of days required to complete a project

project_duration_in_months

numeric

Number of months required to complete a project

project_end_date

date

Project End Date

project_external_id

string

External ID is used for importing data from external systems.

project_id

int

Project ID

project_latitude

decimal

Project address gets converted to Latitude

project_longitude

decimal

Project address gets converted to Longitude

project_name

string

Name of the project

project_start_date

date

Project Start Date

project_state

string

State of the project

project_suburb

string

Suburb where the project is ongoing

project_tags

string

This column is a combination of all the tags associated with this project separated by a '~'

supplier_external_id

string

External ID is used for importing data from external systems.

supplier_name

string

Name of the supplier

task_active_flag

int

1 = task is still active
0 = task is not active

task_external_id

string

Task external ID, used for importing data from external systems.

task_id

int

Task ID

task_name

string

Name of the task

task_qty

int

qty of the tasks required

task_require_assets_flag

int

1 = asset is required for this task
0 = asset is not required for this task

task_supervisor_flag

int

1 = supervisor is required for this task
0 = supervisor is not required for this task

tenant_id

string

Name of the Assignar instance

actual_amount

int

Actual quantity recorded

answer

string

Answer

answer_status

boolean

Status of answer

created_time

timestamp

Date when the site diary was created

has_status_change

boolean

Yes = Status is changed

No = Status is not changed

is_conditional

boolean

Yes = question is conditional

No = question is not conditional

is_required

boolean

Yes = question is required

No = question is not required

quantity_comment

string

question

string

Site diary additional question

question_id

string

question ID

question_type

string

This is the type of question (radio button, checkbox or a numeric question)

site_diary_date

date

Site diary date

site_diary_id

int

Site diary ID

site_diary_note

string

Additional notes in site diary

weather

string

Weather details in site diary

tenant_id

string

Name of the Assignar instance

activities_external_id

string

Activity’s external ID, used for importing data from external systems

activity_billable

int

activity_end_time

timestamp

Time when the activity ended

activity_id

int

Activity ID

activity_name

string

Name of the activity

activity_start_time

timestamp

Time when the activity started

activity_time

int

Total activity time

activity_time_in_hours

numeric

Total activity time in hours

allowance_list

string

List of allowances as per the timesheets.

asset_id

int

Asset ID

asset_name

string

Name of the asset

client_external_id

string

Client’s external ID, used for importing data from external systems

client_id

int

Client ID

client_name

string

Name of the client

fieldworker_user_id

int

Fieldworker ID

fw_active_flag

boolean

True = worker is still active
False = worker is not active

fw_employee_id

string

Worker External ID

fw_employment_type

string

Worker Employment Type

fw_full_name

string

Worker Full Name

order_id

int

Order ID

order_work_order_number

string

Work Order Number

pay_code

string

Timesheet pay code

pay_code_description

string

Description to timesheet pay code

pay_rates

numeric

Timesheet pay rates

pay_units

numeric

Timesheet pay units

project_id

int

Project ID

project_name

string

Name of the project

site_diary_id

int

Site diary ID

task_external_id

string

Task’s external ID, used for importing data from external systems

task_id

int

Task ID

task_name

string

Name of the task

timesheet_break_time

numeric

Break time

timesheet_checked

int

1 = timesheet is approved

0 = timesheet is not yet approved

timesheet_comments

string

Comments on the timesheet

timesheet_end_datetime

timestamp

When the work ended as mentioned in the timesheet.

timesheet_end_time

string

When the work ended as mentioned in the timesheet

timesheet_id

int

Timesheet Id

timesheet_is_deleted_flag

int

1 = timesheet is deleted

0 = timesheet is not deleted

timesheet_modified_at

timestamp

Timestamp of last timesheet modification

timesheet_signature_name

string

Person who has signed off on the timesheet

timesheet_start_datetime

timestamp

When the work started as mentioned in the timesheet

timesheet_start_time

string

When the work started according to timesheet

timesheet_submitted_date

date

Timesheet Submitted Date

timesheet_total_time

decimal

Total time required (in decimal) to complete the Job as mentioned in the timesheet.

timesheet_travl_from_time

string

Time used to travel from the job site

timesheet_travl_to_time

string

Time used to travel to job site

total_time

string

Total time required to complete the Job as mentioned in the timesheet.