API Documentation

Modules

Calendar

Event

Certificates

CompanyCertificate UserCertificate UserCompanyCertificate

CollectiveAgreements

CollectiveAgreement

Company Forms

CompanyForm CompanyFormAcknowledgement CompanyFormRecurring FormMarketplaceCategory FormMarketplaceTemplate FormShareGroup

Company Forms Management

FormChildTemplate FormTemplate FormTemplateCategory

Contacts

Contact ContactFile ContactLocation

Contracts

ServiceContract ServiceContractFile ServiceContractProduct ServiceContractTask ServiceProduct

Customer Assets

CustomerAsset CustomerAssetCategory CustomerAssetFile CustomerAssetTemplate CustomerAssetTemplateCategory UserAsset UserAssetCategory

Equipment

Equipment EquipmentCategory EquipmentFile EquipmentFormAlert EquipmentMaintenanceEventReminder EquipmentMaintenanceEventType EquipmentMaintenanceLog EquipmentType

Expenses

Expense ReceiptImage

Job Invoices

JobInvoice JobInvoiceTask

Jobs

Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeQuote JobChangeQuoteObject JobContact JobEstimate JobFile JobNote JobReport JobTask JobUser

Labour Actions

LabourAction LabourActionCategory

Library

Locates

Locate LocateTicket

Materials

AssemblyTag Material MaterialAssembly MaterialAssemblyItem MaterialCategory

Messages

Message MessageThread MessageThreadUser

Purchase Orders

PurchaseOrder PurchaseOrderFile

Safety

SafetyControl SafetyForm SafetyFormTemplate SafetyHazard SafetyHazardCategory SafetyJobTask

Schedule

ScheduleEvent ScheduleLog

Service Quotes/Invoices

ServiceInvoice ServiceInvoiceObject ServiceQuoteTemplate ServiceQuoteTemplateObject

Service Requests

ServiceRequest

Services

Service ServiceChecklist ServiceContact ServiceFile ServiceSnapshot ServiceUser ServiceWorksheet ServiceWorksheetImage

Settings

AddonApp AddonAppInstalled Category ClassificationGroup CompanyAddress CompanySetting EmployeeClassification ExpenseCode ExpenseGroup FileTag JobFileTag PayBoost PermissionTemplate RevenueCode TimeLogSetting Union

TimeLogs

OpenTimeLog PayPeriod PayPeriodUserReport PendingOvertimeTransfer TimeLog TimeLogDetailedClaim

Users

EmployeeSetting LibraryAcknowledgement User UserLocation WorkHistory

Other

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

LibraryFile Resource
In Library Module

Endpoints

Endpoints URI Access Control Description
save POST /api/LibraryFile/save Admin or Module WRITE
get GET /api/LibraryFile/get Allowed with an active employment connection
find GET /api/LibraryFile/find Allowed with an active employment connection
delete POST /api/LibraryFile/delete Admin or Module WRITE
save-batch POST /api/LibraryFile/save-batch Admin or Module WRITE
compileCachedRelations GET /api/LibraryFile/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
file_id number
caption string
permissions_json string
message_thread_id number
expiry_date date
acknowledgement_interval string
created_by number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order By insertion order

Relationships

Related Resource Key Relationship to LibraryFile Property
UploadFile file_id Belongs To UploadFile
LibraryUpload file_id Belongs To LibraryUpload
FileTag tag_id Owns Many FileTag
LibraryAcknowledgement library_file_id Owns Many LibraryAcknowledgement
MessageThread message_thread_id Belongs To MessageThread
User created_by Belongs To CreatedBy