Operation

Logged in User

Parameters

Body

Response

DELETE

key *

GET

key *

POST

Operation

Logged in User

Parameters

Body

Response

POST

Operation

Logged in User

Parameters

Body

Response

POST

Return all Workbench logs.

Operation

Logged in User

Parameters

Body

Response

GET
Returns Log Header info including service agreement and asset tasks.

logHeaderId

Operation

Logged in User

Parameters

Body

Response

POST

Operation

Logged in User

Parameters

Body

Response

DELETE

key *

GET

logHeaderId

POST

PULL

Operation

Logged in User

Parameters

Body

Response

POST
Create a new Log from service agreement.

serviceAgreementID
serviceAgreementCode
orderNo
description
allocatedPersonId
assetID
relatedRecord
relatedRecordID

ReportFields

TabletLogMaintenanceReportFields

Key

TabletLogMaintenanceKey

TimesheetGrid

GridResult_TabletTimesheetLine

JobOutputsGrid

GridResult_TabletJobOutputsLine

MaterialGrid

GridResult_TabletMaterialLine

PlantGrid

GridResult_TabletPlantLine

VerticalGrid

GridResult_WebEAVGridLine_WebEAVGridKey

ValidationErrors

Array [MvcValidationError]

AnalysisTranID

Integer

LogHeaderID

Integer

AssetID

Integer

Asset id.

TranReference

String

Transaction reference.

TranDate

String

Transaction date.

AnalysisGroupCode

String

Transaction Group code.

AnalysisCode

String

Analysis code.

Quantity

Number

Quantity.

TranStatus

String

Transaction status.

Details

String

Details.

JobOutputID

Integer

Id of the Job Output.

ExtraJobOutputID

Integer

UpdateFlag

Boolean

Update status.

LogHeaderID

Integer

Log header id

LogDate

String

Created date.

LogTime

String

LogBy

Integer

Log by person id.

LogByPerson

LogHeaderPersonApiModel

Log by person.

Status

String

Log status.

StreetNo

String

Address of the log.

Street

String

Address of the log.

Ward

String

Address of the log.

Suburb

String

Address of the log.

Phone

String

Phone number.

Priority

String

Log priority.

ContractRef

String

Contract referenced.

LogType

String

Log type.

ProfitCentreCode

String

Profit Centre related.

CompanyID

Integer

Client company.

OrderNo

String

Client order number.

InvContact

Integer

InvPhone

String

Parent

Integer

Parent log.

Child

Integer

Child log.

Allocation

Integer

Allocation status.

AllocationPerson

LogHeaderPersonApiModel

Allocated person.

LocationCode

String

Location code

ServiceType

String

Service type.

JobCode

String

Job code.

SchdDate

String

Scheduled date.

SchdTime

String

Scheduled time.

CompletedTime

String

Completed time.

CompletedDate

String

Completed date.

SiteContact

Integer

Site contact.

SitePhone

String

Site contact phone.

Description

String

Description text.

PONumber

String

Purchase Order number.

FinalDate

String

Final date.

FinalTime

String

Final time.

Escalation

String

Escalation status.

EscalationTime

String

Escalation time.

SalesOrderNo

Integer

Sales order number.

ExpectedHours

Number

Expected hours to complete the job.

ContactDetails

String

Contact detail.

ArriveDate

String

Onsite arrival date.

ArriveTime

String

Onsite arrival time.

SiteAddressID

Integer

Site address id.

RestoreDate

String

Restore date.

RestoreTime

String

Restore time.

CompletedByID

Integer

Id of person completed the job.

FinalisedByID

Integer

Id of person finalised the job.

Comment

String

Comments.

EventTimeStamp

String

DispatcherID

Integer

ServiceAgreementID

Integer

Service Agreement document id.

SiteContactName

String

Site contact person.

InvoiceContactName

String

Invoice contact person.

NextEscalationRunDate

String

City

String

City.

Country

String

Country.

Latitude

Number

Latitude of address in map.

Longitude

Number

Longitude of address in map.

LogAddress

String

Log address.

ReviewByID

Integer

id of reviewed person.

AssetTaskID

Integer

Task id.

RunID

Integer

Run id.

SchdDateNext

String

Next scheduled date.

SchdTimeNext

String

Next schedule time.

PercentComplete

Number

Percent complete.

ActualTimeUnitsQuantity

Number

Actual

WorkGroupID

Integer

Workgroup id

SequenceNumber

Integer

Sequence number.

SchdDateOriginal

String

Original scheduled date.

SchdTimeOriginal

String

Original scheduled time.

SentFlag

Integer

Sent status.

WorkOrderNo

Integer

Work Order number

OutputQuantity

Number

Output quanity.

SchdDateHours

Number

SchdDateMaximumHours

Number

RestoreDateTargetHours

Number

CompleteDateTargetHours

Number

StartedDateActualHours

Number

RestoreDateActualHours

Number

CompletedDateLDHours

Number

SchdDateUnits

String

SchdDateMaximumUnits

String

RestoreDateTargetUnits

String

CompleteDateTargetUnits

String

StartedDateActualUnits

String

RestoreDateActualUnits

String

CompletedDateLDUnits

String

SchdDateTarget

String

SchdTimeTarget

String

SchdDateMaximum

String

SchdTimeMaximum

String

RestoreDateTarget

String

RestoreTimeTarget

String

StartedDateActual

String

Actual started date.

StartedTimeActual

String

Actual started time.

RestoreDateActual

String

Actual restored date.

RestoreTimeActual

String

Actual restored time.

CompleteDateTarget

String

CompleteTimeTarget

String

ArriveDateLDHours

Number

ArriveDateLDUnits

String

FinalDateLDHours

Number

FinalDateLDUnits

String

CancelledDate

String

Cancelled date.

CancelledTime

String

Cancelled time.

CancelledByID

Integer

Person who cancelled by id.

AssetID

Integer

Asset id.

CompletionDetails

String

Details of completion.

WorkCentreCode

String

Work Centre code.

AssetLocation

String

Asset location.

Run

LogHeaderWorkGroupApiModel

AssetTask

LogHeaderAssetTaskApiModel

ServiceAgreement

LogHeaderServiceAgreementApiModel

Service agreement

Asset

LogHeaderAssetApiModel

StoredFiles

Array [StoredFilesApiModel]

LogDetails

Array [LogHeaderDetailsApiModel]

AnalysisTransactions

Array [LogHeaderAnalysisTransactionApiModel]

Extensions

Array [LogHeaderExtension]

AssetID

Integer

Asset id.

AssetCode

String

Asset code.

ExternalCode

String

External code

Description

String

Description text.

JobCode

String

Job code.

ScheduleCode

String

Schedule code.

Quantity

Number

Quantity.

Unit

String

Unit measurement.

Details

String

Details.

Inactive

Integer

Inactive status.

CompanyID

Integer

Company id.

CompanyName

String

Company name.

ParentAssetID

Integer

Parent asset id.

AssetLocation

String

Asset location.

StreetNo

String

Asset location field.

Street

String

Asset location field.

Suburb

String

Asset location field.

City

String

Asset location field.

Country

String

Asset location field.

AssetAttributeValues

Array [LogHeaderAssetAttributeValueApiModel]

AssetContracts

Array [LogHeaderAssetContractApiModel]

DataLabel

String

DataType

Integer

DateData

String

NumericData

Number

TextData

String

Delete

Boolean

AssetContractID

Integer

Asset contract id.

ContractCode

String

Contract code.

Delete

Boolean

AssetTaskID

Integer

AssetTaskDescription

String

AssetTaskDetails

String

ContractCode

String

Contract code.

ScheduleCode

String

Schedule code.

AssetContractID

Integer

Asset contract id.

TaskID

Integer

Task id.

WorkGroupID

Integer

Work group id

RunID

Integer

RunCode

Integer

FrequencyCode

String

Recurring

Integer

OutputCode

String

SequenceNumber

Integer

BudgetTimeUnitsQuantity

Number

BudgetTimeUnit

String

RunDayNumber

Integer

RunDay

String

Inactive

Integer

Inactive status.

ScheduledStartDate

String

Scheduled start date.

UseExemptionDates

Integer

AssetCode

String

Asset code.

AssetID

Integer

Asset id.

WorkOrderNo

Integer

Work Order number.

ServiceAgreementID

Integer

Service agreement id.

ExpectedAnnualQuantity

Number

ServiceType

String

Service type.

ScheduledEndDate

String

Schedule end date.

Task

LogHeaderTaskApiModel

LogDetailID

Integer

LogHeaderID

Integer

Log header id.

DetailDate

String

Date.

DetailTime

String

Time.

DetailType

String

Type.

PersonID

Integer

Id of person.

Comments

String

Comments.

TSCreated

Integer

TimesheetDate

String

ActivityCode

String

Activity code.

Hours

Number

JobTranID

Integer

Id of job transaction.

WorkCentreCode

String

Work Centre code.

Reference

String

Reference.

ReferenceDescription

String

Reference description.

Name

String

Type

String

='String', 'Int', 'Bool', 'Decimal', 'DateTime'.

ValueStr

String

Value string.

ValueInt

Integer

Value integer.

ValueBool

Boolean

Value boolean.

ValueDec

Number

Value decimal.

ValueDate

String

Value date.

PersonID

Integer

Person id.

FullName

String

Person full name.

RunID

Integer

RunCode

String

RunDescription

String

RunDetails

String

WorkGroupID

Integer

DefaultPersonID

Integer

Duration

Integer

RunDay

String

RouteCode

String

Inactive

Integer

ScheduleCode

String

OutputCode

String

ID

Integer

Code

String

Service Agreement code.

Description

String

SA description.

Details

String

SA detail

ClientSource

String

The source of the Client

CompanyID

Integer

Client company id.

DefaultJobCode

String

The default job code.

DefaultParentJobCode

String

The Job Code used as the default Parent Job.

DefaultAgreement

Integer

Default agreement status.

DefaultLogDescription

String

The default description on new logs created under this Service Agreement

DefaultAllocation

Integer

The default person in the Allocate To field on new logs.

DefaultDispatcherID

Integer

The default dispatcher id on new logs.

Inactive

Integer

Inactive status.

JobTemplateCode

String

Job template code

DefaultReportID

Integer

The default report on new logs.

DefaultCity

String

The default city on new logs.

DefaultCountry

String

The default country on new logs.

TaskID

Integer

Task id.

TaskCode

String

Task code.

Description

String

Task description.

Details

String

Details.

JobCode

String

Job code.

StartDate

String

Start date.

EndDate

String

End date.

WorkDays

Integer

Working days.

TaskManagerID

Integer

Id of task manager.

Inactive

Integer

Inactive status.

PercentCompleteOnSummary

Integer

Percent of complete.

WorkCentreCode

String

Work Centre code.

WorkCentreDesc

String

Work Centre description.

BudgetHours

Number

Number of hours budgeted.

ActualHours

Number

Actual hours.

EstimateHours

Number

Number of hours estimated.

Completed

Number

MachineID

Integer

Machine id.

SequenceNo

Integer

Sequence number.

ProductionQty

Number

Quanity of production.

ParentTaskID

Integer

Id of parent task.

DefFrequencyCode

String

DefRecurring

Integer

WorkGroupID

Integer

Work group id.

TaskTypeID

Integer

Task type by id.

TaskLag

Integer

DefServiceAgreementID

Integer

Service Agreement id.

WorkGroupID

Integer

Work group id.

Description

String

Description.

LogHeaderId

Integer

Log header id.

ServiceAgreementID

Integer

Id of Service agreement.

ServiceAgreementCode

String

Code of Service agreement

OrderNo

String

Order number.

LogHeaderID

Integer

Log header id.

AssetID

Integer

Related asset id

LogHeaderIdLink

CellData

EscalationFlag

String

LogHeaderId

Integer

Log header id.

LogDate

CellData

Log date.

LogStatus

String

Log status.

Description

String

Description.

LogPriorityDescription

String

Priority description.

SchdDate

String

Scheduled date.

LogByPerson

String

Created person.

JobCode

String

Job code.

JobDescription

String

Job description.

Client

String

Client company.

SchdDateOriginal

String

Original scheduled date.

Allocation

Integer

Allocated person.

FromTime

String

JSON

String

ServiceAgreementID

Integer

The related Service Agreement.

ServiceType

String

Service type.

ProfitCentreCode

String

Profit Centre code.

JobProfitCentreCode

String

Job Profit Centre code.

LogType

String

Log type.

ActivityCode

String

Activity code.

WorkCentreCode

String

Work centre code.

CompletedDate

String

Completed date.

FinalDate

String

Finalised date.

EventTimeStamp

String

UpdatedDate

String

Updated date.

Status

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

ServiceDeskKey

CurrentKey

ServiceDeskKey

Key

ServiceDeskKey

Index

Integer

LogNo

StringViewData

Log number

AllocatedTo

PickerViewData

Allocated person.

LogDate

DateViewData

Log date.

LogTime

TimeViewData

Log time.

OriginalLogDate

StringViewData

Original log date.

Description

StringViewData

Description.

Client

PickerViewData

Client company.

SiteContact

StringViewData

Site contact.

ContactPhoneNo

StringViewData

Contact phone.

Address

StringViewData

Address.

ContactDetail

StringViewData

Contact detail.

JobCode

PickerViewData

Job code.

Status

StringViewData

Status.

Details

StringViewData

Details.

ArrivedOnSiteDate

DateViewData

Date arrived on Site.

ArrivedOnSiteTime

DateViewData

Time arrived on Site.

CompletedDate

DateViewData

Completed date.

CompletedTime

TimeViewData

Completed time.

CompletionDetails

StringViewData

Completed details.

ExpectedHours

DecimalViewData

Number of hours expected.

Priority

PickerViewData

Priority status.

AssetID

PickerViewData

Asset id.

ExtensionFields

ExtensionFieldsViewData

Extension fields.

RetailSummaryHours

DecimalViewData

RetailSummaryLabour

DecimalViewData

RetailSummaryMaterial

DecimalViewData

RetailSummaryPlant

DecimalViewData

RetailSummaryTotal

DecimalViewData

OutputSummary

GridModel

Output summary.

DocketId

Integer

Docket id.

ScheduleCode

String

Schedule code.

OutputCode

String

Output code.

JobCode

String

Job code.

DocketDate

String

Docket date.

JobCode

CellData

Job code.

ScheduleCode

CellData

Schedule code.

OutputCode

CellData

Output code.

Unit

String

Unit measurement.

Rate

CellData

Rate.

Quantity

CellData

Quantity.

Value

CellData

Value.

Details

CellData

Details

Delete

CellData

DocketNo

CellData

Docket number.

Status

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

TabletJobOutputsKey

CurrentKey

TabletJobOutputsKey

Key

TabletJobOutputsKey

Index

Integer

DocketId

Integer

Docket id.

CatalogLineId

Integer

Catalogue line id

MaterialCode

String

CompanyId

Integer

Company id

ActivityCode

String

Activity code.

ItemId

Integer

RateCode

String

Rate code.

WorkCentreCode

String

Work centre code.

JobCode

String

Job code.

FormId

String

Form id.

DocketDate

String

Docket date.

JobCode

CellData

Job code.

MaterialCode

CellData

Material code.

Supplier

String

Supplier name.

SupplierValue

CellData

RateCode

String

DocketNo

CellData

Docket number.

ActivityCode

String

Activity code.

ActivityCodeValue

CellData

Activity code.

WorkCentreCode

CellData

Work centre code.

Description

CellData

Description.

Quantity

CellData

Quantity.

Unit

String

Unit measurements.

Delete

CellData

EnteredRate

CellData

Manual entered rate.

EnteredCost

CellData

Manual entered cost.

Status

String

Status

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

TabletMaterialDetailKey

CurrentKey

TabletMaterialDetailKey

Key

TabletMaterialDetailKey

Index

Integer

Idx

Integer

PersonId

Integer

Person id.

DocketId

Integer

Docket id.

CatalogLineId

CatalogLineId

Catalogue line id.

PlantCode

String

Plant code.

CompanyId

Integer

Client company id.

ActivityCode

String

Activity code.

ItemId

Integer

RateCode

String

Rate code

WorkCentreCode

String

Work centre code.

HasOtherTimesheetGroup

Boolean

Other Timesheet Group

TranType

String

JobCode

String

Job code.

FormId

Form id.

DocketDate

String

Docket date

JobCode

CellData

Job code

PlantCodeExternal

CellData

Plant code external

PlantCodeInternal

CellData

Plant code Internal.

TranType

String

Supplier

String

Supplier name.

SupplierValue

CellData

RateCode

String

Rate code.

DocketNo

CellData

Docket number

ActivityCode

String

Activity code.

ActivityCodeValue

CellData

Activity code.

WorkCentreCode

CellData

Work Centre code.

Description

CellData

Description.

Comments

CellData

Comments.

Quantity

CellData

Quanity.

Unit

String

Unit measurement.

Delete

CellData

Value in ‘Delete’ check box.

CostRate

CellData

Cost rate.

EnteredRate

CellData

Manual entered rate.

EnteredCost

CellData

Manual entered cost.

ActivityCodeLookup

CellData

SupplierControl

PickerViewData

RateCodeControl

PickerViewData

ActivityCodeControl

PickerViewData

Status

String

Status

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

TabletPlantDetailKey

CurrentKey

TabletPlantDetailKey

Key

TabletPlantDetailKey

Index

Integer

LogHeaderId

Integer

Log header id.

DocketId

Integer

Docket id.

PersonId

Integer

Person id.

JobCode

String

Job code.

ActivityCode

String

Activity code.

ActivityType

String

Activity type.

ActivitySubType

String

Activity sub type.

TimeCode

String

Time code.

WorkCentreCode

String

Work Centre code.

PersonCode

String

Person code.

TimesheetGroupID

Integer

Timesheet group id.

ProfileID

Integer

BreakDuration

Number

Break duration.

Selected

CellData

Person

CellData

Person.

DocketDate

String

Docket date.

JobCode

String

Job code.

JobCodeLookup

CellData

Action

CellData

Action.

ActivityCode

CellData

Activity code.

WorkCentreCode

CellData

Work Centre code.

Allowance

CellData

Allowance.

ActivityType

String

Activity type.

StartTime

CellData

Start time.

EndTime

CellData

End time.

TimeCode

String

Time code.

Description

CellData

Description.

Quantity

CellData

Quantity.

Details

String

Details

Delete

CellData

Value in ‘Delete’ check box.

OutputMeasure

CellData

To indicate the number of Outputs completed by that person in the period of time.

ActivitySubType

String

Activity sub type.

TimeCodes

Array [Tuple_String]

Time code.

EmployeeProfiles

Array [KeyValuePair]

Employee profile.

SubContractor

Boolean

Subcontractor info.

PlantIssues

CellData

Plant issue for is for users who also enter their plant items.

DocketNo

CellData

Docket number.

EmployeeProfile

CellData

Employee profile

TimesheetBreaks

CellData

Timesheet break.

Status

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

TabletTimesheetDetailKey

CurrentKey

TabletTimesheetDetailKey

Key

TabletTimesheetDetailKey

Index

Integer