Overview

???

Provides access to Workbench Activity data.

Endpoints

The resources available in this module.

ActivitiesListApi

Return all Workbench Activities.

/api/ActivityListApi
Method	Description	Performed As	Request Query	Request Body	Response
POST	Returns all Workbench Activities as in the Activity list screen.	Logged in User	-	-

ActivityLookupApi

Return filtered Workbench Activities.

/api/ActivityLookupApi
Method	Description	Performed As	Request Query	Request Body	Response
POST	Returns all filtered Workbench Activities	Logged in User	-	-

Models

The definitions of models specific to endpoints in this module.

AdminActivityLine

Field	Description
ActivityCode	The unique code for the activity.
Description	Description of the activity.
ActivityCodeDescription	???
ActivityType	Determines what kind of activity this is and where it can be used in Workbench.
CostCategory	Category of activity
ActivitySubType	Subcategory of activity.
GstType	Type of GST
WorkCentreCode	The default Work Centre for this activity.
SalesCode	The Sales Code attributed to this activity.
DrGLAccount	The General Ledger account that this activity will debit to.
CrGLAccount	The General Ledger account that this activity will credit to.
UpdatedDate	Date of last update.
ActivityCodeValue	The code for the activity.
DescriptionValue	Activity description
ActivityTypeValue	Activity type
CostCategoryValue	??? Cost category
CostCategorySequenceNo	???
GstTypeValue	Type of GST
ActivitySubTypeValue ???	Sub type of Activity
WorkCentreCodeValue ???	Code of the Work centre
SalesCodeValue	??? Sale code
DrGLAccountValue	???	CrGLAccountValue	??? The General Ledger account that this activity will debit to.
CrGLAccountValue	The General Ledger account that this activity will credit to.
BaseCostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
OverheadCostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
OtherCostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
AllowanceCostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
Time1CostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
Time2CostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
Time3CostValue	The cost areas of the Employee Class will be transferred to the transaction, and which ones will be ignored.
InactiveValue	???
Select	???
IncludedValue	???
Included	???
Inactive	???
Selected	???
Delete	???
Status	???
ReadonlyFlag	???
ReadonlyMessage	???
OriginalKey	???
CurrentKey	???
Key	???
Index	???

AdminActivityKey

Field	Description
ActivityCode	???
RetentionActivityCode	???
CopyFromActivity	???

Examples

Get the list of Activities.

Expand

title	Click to view.

Request

Code Block

language	json

{
 "predicate": {
  "PredicateRows": [{
    "LeftOperand": "ActivityCode",
    "Operator": "Eq",
    "RightOperand": [ "" ],
    "Display": true
   }
  ]
 },
 "sidx": "ActivityCode",
 "sord": "asc",
 "page": 1,
 "rows": 20
}

Response

Code Block

language	json

GridResult_AdminActivityLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[AdminActivityLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
AdminActivityLine {
ActivityCode (string, optional),
Description (string, optional),
ActivityCodeDescription (string, optional),
ActivityType (string, optional),
CostCategory (string, optional),
ActivitySubType (string, optional),
GstType (string, optional),
WorkCentreCode (string, optional),
SalesCode (string, optional),
DrGLAccount (string, optional),
CrGLAccount (string, optional),
UpdatedDate (string, optional),
ActivityCodeValue (CellData, optional),
DescriptionValue (CellData, optional),
ActivityTypeValue (CellData, optional),
CostCategoryValue (string, optional),
CostCategorySequenceNo (integer, optional),
GstTypeValue (CellData, optional),
ActivitySubTypeValue (CellData, optional),
WorkCentreCodeValue (CellData, optional),
SalesCodeValue (CellData, optional),
DrGLAccountValue (CellData, optional),
CrGLAccountValue (CellData, optional),
BaseCostValue (boolean, optional),
OverheadCostValue (boolean, optional),
OtherCostValue (boolean, optional),
AllowanceCostValue (boolean, optional),
Time1CostValue (boolean, optional),
Time2CostValue (boolean, optional),
Time3CostValue (boolean, optional),
InactiveValue (boolean, optional),
Select (CellData, optional),
IncludedValue (CellData, optional),
Included (boolean, optional),
Inactive (integer, optional),
Selected (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (AdminActivityKey, optional),
CurrentKey (AdminActivityKey, optional),
Key (AdminActivityKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
AdminActivityKey {
ActivityCode (string, optional),
RetentionActivityCode (string, optional),
CopyFromActivity (boolean, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response Sample

Code Block

language	json

GridResult_AdminActivityLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[AdminActivityLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
AdminActivityLine {
ActivityCode (string, optional),
Description (string, optional),
ActivityCodeDescription (string, optional),
ActivityType (string, optional),
CostCategory (string, optional),
ActivitySubType (string, optional),
GstType (string, optional),
WorkCentreCode (string, optional),
SalesCode (string, optional),
DrGLAccount (string, optional),
CrGLAccount (string, optional),
UpdatedDate (string, optional),
ActivityCodeValue (CellData, optional),
DescriptionValue (CellData, optional),
ActivityTypeValue (CellData, optional),
CostCategoryValue (string, optional),
CostCategorySequenceNo (integer, optional),
GstTypeValue (CellData, optional),
ActivitySubTypeValue (CellData, optional),
WorkCentreCodeValue (CellData, optional),
SalesCodeValue (CellData, optional),
DrGLAccountValue (CellData, optional),
CrGLAccountValue (CellData, optional),
BaseCostValue (boolean, optional),
OverheadCostValue (boolean, optional),
OtherCostValue (boolean, optional),
AllowanceCostValue (boolean, optional),
Time1CostValue (boolean, optional),
Time2CostValue (boolean, optional),
Time3CostValue (boolean, optional),
InactiveValue (boolean, optional),
Select (CellData, optional),
IncludedValue (CellData, optional),
Included (boolean, optional),
Inactive (integer, optional),
Selected (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (AdminActivityKey, optional),
CurrentKey (AdminActivityKey, optional),
Key (AdminActivityKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
AdminActivityKey {
ActivityCode (string, optional),
RetentionActivityCode (string, optional),
CopyFromActivity (boolean, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Get list of filtered activity

Expand

title	Click to view.

Request

Code Block

language	json

GridRequestParametersApi {
predicate (DynamicPredicateApi),
sidx (string),
sord (string),
page (integer),
rows (integer),
jobCode (string, optional),
finCoCode (string, optional),
functionalCode (string, optional) = ['General', 'PurchaseOrders', 'PurchaseOrderApproval', 'PurchaseRequisitions', 'Timesheets', 'TimesheetReviews', 'TimesheetApproval', 'TimesheetApprovalList', 'ServiceLog', 'ServiceDesk', 'ExpenseClaims', 'ExpenseClaimReviews', 'ExpenseClaimApproval', 'ExpenseClaimAdminApproval', 'TabletTimesheet', 'TabletTimePlant', 'Scheduler', 'LeaveManagement', 'LeaveTypeManagement', 'CrewTimesheets', 'Refueling', 'HumanResources', 'DailyDiary', 'Datasheets', 'Stock', 'LogDaysheet', 'PortalPeople', 'PortalCompany', 'Workflow', 'Reporting', 'ProfitCentres', 'ExternalSalesCodes', 'InternalSalesCodes', 'ActivityReportCode', 'ProfitCentreReportCode', 'SalesCodeReportCode', 'Batch', 'Budget', 'Billing', 'TimeCodes', 'Disbursement', 'Jobs', 'ApInvoices', 'Adjustments', 'Plant', 'NonStockLocation', 'JobContract', 'Processes', 'JobReceipt', 'Forecast', 'SubContracts', 'WorkOrderApproval', 'StockItem', 'ApInvoiceApproval', 'ApCreditApproval', 'TimesheetAdminApproval', 'DocketEntry', 'Revenue', 'Vouchers', 'VoucherApproval', 'Quotes', 'ProductionMeasures', 'StockIssue', 'Utilities', 'SubcontractClaimWorkflowApproval', 'BulkInvoice', 'WorkOrder', 'DocumentRegister', 'Activities', 'SalesCodes', 'ContractorDaysheet', 'Materials', 'ExternalPlant', 'JobInvoices', 'BillOfMaterials', 'Users', 'Daysheet', 'Procurement', 'DocketReconciliation', 'Imports', 'ScheduleStoredProcedure', 'Internal', 'TrustAccount', 'Impersonation', 'SubContractRetentionTrustAccount', 'ContractRetentionTrustAccount'],
IntValue (integer, optional),
StringValue (string, optional),
BoolValue (boolean, optional),
DateValue (string, optional)
}
DynamicPredicateApi {
PredicateRows (Array[DynamicPredicateRowApi]),
IsOr (boolean, optional)
}
DynamicPredicateRowApi {
LeftOperand (string),
Operator (string) = ['Lt', 'Gt', 'Eq', 'Ne', 'Le', 'Ge', 'Like', 'IsOneOf', 'IsNotOneOf', 'Between', 'StartsWith', 'StartsWithIsOneOf', 'Either'],
RightOperand (Array[string]),
Display (boolean, optional)
}

Response

Code Block

language	json

GridResult_LookupsActivityLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[LookupsActivityLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
LookupsActivityLine {
ActivityType (string, optional),
ActivitySubType (string, optional),
Code (CellData, optional),
Description (string, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (LookupsLookupKey, optional),
CurrentKey (LookupsLookupKey, optional),
Key (LookupsLookupKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
LookupsLookupKey {
Code (string, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response Sample

Code Block

language	json

{
  "total": 0,
  "page": 0,
  "records": 0,
  "rows": [
    {
      "ActivityType": "string",
      "ActivitySubType": "string",
      "Code": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-03-27T00:42:16.507Z",
        "CellValueInt": 0
      },
      "Description": "string",
      "Status": "string",
      "ReadonlyFlag": 0,
      "ReadonlyMessage": "string",
      "OriginalKey": {
        "Code": "string"
      },
      "CurrentKey": {
        "Code": "string"
      },
      "Key": {
        "Code": "string"
      },
      "Index": 0
    }
  ],
  "form": {},
  "widgets": [
    {
      "WidgetId": 0,
      "LayoutCode": "string",
      "Name": "string",
      "Colour": "string",
      "BGColour": "string",
      "Icon": "string",
      "Type": "string",
      "Visible": true,
      "Order": 0,
      "Count": 0,
      "WidgetLines": [
        {
          "WidgetLineId": 0,
          "WidgetId": 0,
          "Name": "string",
          "Predicate": "string",
          "Order": 0,
          "Count": 0
        }
      ]
    }
  ]
}

⬆️ Back to top

On this page

Table of Contents

minLevel	1
maxLevel	2
outline	false
style	default
type	list
printable	false

Versions Compared

Old Version 10

New Version 11

Key

Overview

Provides access to Workbench Activity data.

Endpoints

ActivitiesListApi

ActivityLookupApi

Models

AdminActivityLine

AdminActivityKey

Examples

Get the list of Activities.

Request

Response

Response Sample

Get list of filtered activity

Request

Response

Response Sample

Page Comparison

Versions Compared

Old Version 10

New Version 11

Key

Overview

Provides access to Workbench Activity data.

Endpoints

ActivitiesListApi

ActivityLookupApi

Models

AdminActivityLine

AdminActivityKey

Examples

Get the list of Activities.

Request

Response

Response Sample

Get list of filtered activity

Request

Response

Response Sample