Overview

Provides access to Workbench Work Breakdown data.

Endpoints

The resources available in this module.

WorkBreakDownApi

Provides API access to Job, Activity, and Work Centre data.

/api/WorkBreakDownApi

/api/WorkBreakDownApi

Method

Performed As

Request Query

Request Body

Response

GET

Retrieve a user’s recently updated Jobs, Activities, Work Centres and Time Codes.

Logged in User

WorkbenchBreakdownKey

-

WorkBreakDownApiModel

WorkCentreListApi

Provides API access to the Work Centres (#/Admin/WorkCentreList.aspx) Web Workbench screen.

/api/WorkCentreListApi

/api/WorkCentreListApi
Method	Performed As	Request Query	Request Body	Response
POST Retrieve a filtered list of Work Centres.	Logged in User	-	GridRequestParametersApi	GridResult<WorkCentreLine>

WorkCentreLookupApi

Provides API access to the Work Centres Lookup functionality.

/api/WorkCentreLookupApi

/api/WorkCentreLookupApi
Method	Performed As	Request Query	Request Body	Response
POST Retrieve a filtered list of Activities, for a specific Job and Financial Company.	Admin User	-	GridRequestParametersApi (finCoCode and jobCode are required)	GridResult<WorkCentreLookupLine>

Models

The definitions of models specific to endpoints in this module.

WorkbenchBreakdownKey

Property	Type	Description

Property	Type	Description
UpdateDate	DateTime	The date to filter the data last updated after (defaults to 6 months ago is not specified)

WorkBreakDownApiModel

Property	Type	Description

Property	Type	Description
Jobs	Array<WorkBreakDownJob>	The User’s Jobs that have been updated or used after WorkbenchBreakdownKey.UpdateDate.
Activities	Array<WorkBreakDownActivity>	Activities that have been updated after WorkbenchBreakdownKey.UpdateDate.
WorkCentres	Array<WorkBreakDownJobWorkCentre>	Work Centres for the retrieved Jobs.
TimeCodes	Array<WorkBreakDownTimeCode>	The User’s Time Codes.

Back to top

WorkBreakDownJob

Property	Type	Description

Property	Type	Description
Code	String	The unique Code of the Job.
Description	String	The Description of the Job
JobTypeCode	String	The Code of Job Type.
JobManager	String	The full name of the Job Manager for the Job.
JobManagerId	Integer	The ID of the Job Manager.
AccountManager	String	The full name of the Account Manager for the Job.
AccountManagerId	Integer	The ID of the Account Manager.
CompanyName	String	The Name of the Company of the Job.
CompanyId	Integer	The Company ID of the Job.
Closed	Boolean	The Closed flag on the Job.
Finalised	Boolean	The Finalised flag on the Job.
HasJobWorkCentres	Boolean	A flag to indicate if the Job has Job Work Centres.
DefaultActivity	String	Default Activity of the Activity Group of the Job.
Activities	Array<string>	The Activities that belong to the Activity Group of the Job.
LastModifyDate	String	The date the Job was last modified.

Back to top

WorkBreakDownActivity

Property	Type	Description

Property	Type	Description
Code	String	The unique Code of the Activity.
Description	String	The Description of the Activity.
ActivityType	String	What kind of Activity is and where it can be used in Workbench.
ActivitySubType	String	The sub-type of the Activity.
WorkCentreCode	String	The Code of the default Work Centre for this Activity.
UseTimeCodes	Boolean	A flag to indicate if the Activity uses Time Codes.
DefaultTimeCode	String	The default Time Code.
TimeCodes	Array<string>	The User’s Time Codes for this Activity.

Back to top

WorkBreakDownJobWorkCentre

Property	Type	Description

Property	Type	Description
Code	String	The unique Code of the Work Centre.
Description	String	The Description of the Work Centre.
WorkUpdatedDate	DateTime	The date the Work Centre was last updated.
JobUpdatedDate	DateTime	The date the Job on the Job Work Centre was last updated.
JobCode	String	The Code of the Job on the Job Work Centre.
Closed	Boolean	The Closed flag on the Job Work Centre.

Back to top

WorkBreakDownTimeCode

Property	Type	Description

Property	Type	Description
Code	String	The unique Code of the Time Code.
Description	String	The Description of the Time Code.
LineType	Integer	The Line Type of the Time Code.
IncCost	Boolean	The Include Cost flag on the Time Code.

Back to top

WorkCentreKey

Property	Type	Description

Property	Type	Description
WorkCentreCode	String	The unique code of the Work Centre.

Back to top

WorkCentreLine

Property	Type	Description

Property	Type	Description
Key	WorkCentreKey	The unique key for the line.
WorkCentreCode	String	The unique code of the Work Centre.
WorkCentreCodeValue	CellData	The unique code of the Work Centre.
Description	String	The description of the Work Centre.
DescriptionValue	CellData	The description of the Work Centre.
WorkCentreGroupCode	String	The Work Centre Group of the Work Centre.
WorkCentreGroupCodeValue	CellData	The Work Centre Group of the Work Centre.
CodeDescription	String	The Work Centre Code and Description.
UpdatedDate	String	The Date this record was last updated.

Back to top

WorkCentreLookupLine

Property	Type	Description

Property	Type	Description
Key	LookupKey	The unique key for the line.
Code	CellData	The unique code of the Work Centre.
Description	String	The description of the Work Centre.

Back to top

Examples

Get list of all Work Centres in Workbench

Request

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

Response

GridResult_AdminWorkCentreLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[AdminWorkCentreLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
AdminWorkCentreLine {
WorkCentreCode (string, optional),
Description (string, optional),
WorkCentreGroupCode (string, optional),
CodeDescription (string, optional),
UpdatedDate (string, optional),
WorkCentreCodeValue (CellData, optional),
DescriptionValue (CellData, optional),
WorkCentreGroupCodeValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (AdminWorkCentreKey, optional),
CurrentKey (AdminWorkCentreKey, optional),
Key (AdminWorkCentreKey, 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)
}
AdminWorkCentreKey {
WorkCentreCode (string, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response sample

{
  "total": 0,
  "page": 0,
  "records": 0,
  "rows": [
    {
      "WorkCentreCode": "string",
      "Description": "string",
      "WorkCentreGroupCode": "string",
      "CodeDescription": "string",
      "UpdatedDate": "2024-04-08T20:30:00.876Z",
      "WorkCentreCodeValue": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:30:00.876Z",
        "CellValueInt": 0
      },
      "DescriptionValue": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:30:00.876Z",
        "CellValueInt": 0
      },
      "WorkCentreGroupCodeValue": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:30:00.876Z",
        "CellValueInt": 0
      },
      "Delete": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:30:00.876Z",
        "CellValueInt": 0
      },
      "Status": "string",
      "ReadonlyFlag": 0,
      "ReadonlyMessage": "string",
      "OriginalKey": {
        "WorkCentreCode": "string"
      },
      "CurrentKey": {
        "WorkCentreCode": "string"
      },
      "Key": {
        "WorkCentreCode": "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
        }
      ]
    }
  ]
}

Sample of WorkBreakDownApi GET

Request

Response

Response sample

Sample of getting list of filtered Work Centres

Request

Response

Response sample

Back to top

On this page

1 Overview
2 Endpoints
- 2.1 WorkBreakDownApi
- 2.2 WorkCentreListApi
- 2.3 WorkCentreLookupApi
3 Models
- 3.1 WorkbenchBreakdownKey
- 3.2 WorkBreakDownApiModel
- 3.3 WorkBreakDownJob
- 3.4 WorkBreakDownActivity
- 3.5 WorkBreakDownJobWorkCentre
- 3.6 WorkBreakDownTimeCode
- 3.7 WorkCentreKey
- 3.8 WorkCentreLine
- 3.9 WorkCentreLookupLine
4 Examples