Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Anchor | ||||
---|---|---|---|---|
|
Property
Description
???
POST
ActivityLookupApi
Return filtered Activity in Workbench.
/api/ActivityLookupApi |
---|
Method |
Description |
Description
Returns all Workbench Activities filtered by
Info |
---|
The description of common function fields is listed on this Common functions |
POST
Description
GridRequestParametersApi: link
DynamicPredicateApi: link
DynamicPredicateRowApi: link
Performed As | Request Query | Request Body | Response | ||
POST | Returns all filtered Workbench Activities | Logged in User | - |
Model
Request
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
{
"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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|