Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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 | ||||
---|---|---|---|---|
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 | - |
WorkCentreListApi
Return all Work Centres in WorkbenchProvides API access to the Work Centres (#/Admin/WorkCentreList.aspx) Web Workbench screen.
/api/WorkCentreListApi | ||||
---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
POST | Logged in User | - |
WorkCentreLookupApi
Return the list of filtered Work Centres in Workbench
/api/WorkCentreListApi | ||||
---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
POST |
Models
The definitions of models specific to endpoints in this module.
WorkbenchBreakdownKey
Property | Type | Description |
---|---|---|
UpdateDate | DateTime | The date to filter the data last updated after (defaults to 6 months ago is not specified) |
AdminWorkCentreKey
Property
Type
Description
WorkCentreCode
String
Code of the Work Centre.
⬆️ Back to top
AdminWorkCentreLine
Property
Type
Description
WorkCentreCode
String
Code of the Work Centre.
Description
String
Description text.
WorkCentreGroupCode
String
Code of the group that Work Centre belongs to.
CodeDescription
String
UpdatedDate
String
Updated date.
WorkCentreCodeValue
Code of the Work Centre.
DescriptionValue
Description text.
WorkCentreGroupCodeValue
Code of the group that Work Centre belongs to.
Delete
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
CurrentKey
Key
Index
Integer
⬆️ Back to top
LookupsWorkCentreLine
Property
Type
Description
Code
CellData
Work Centre code.
Description
String
Description text.
Status
String
Work Centre status.
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
CurrentKey
Key
Index
) |
WorkBreakDownApiModel
Property | Type | Description |
---|---|---|
Jobs | Array [WorkBreakDownJob] | |
Activities | Array [WorkBreakDownActivity] | |
WorkCentres | Array [WorkBreakDownJobWorkCentre] | |
TimeCodes | Array [WorkBreakDownTimeCode] |
⬆️ Back to top
WorkBreakDownJob
Property | Type | Description |
---|---|---|
Code | String | Code of the job |
Description | String | |
JobTypeCode | String | Code of job type. |
JobManager | String | Job manager for the job. |
JobManagerId | Integer | Code of Job manager person. |
AccountManager | String | Account manager person, |
AccountManagerId | Integer | Code of account manager person. |
CompanyName | String | Name of the company of the job. |
CompanyId | Integer | Code of the company. |
Closed | Boolean | The job is closed or not. |
Finalised | Boolean | The job is finalised or not. |
HasJobWorkCentres | Boolean | Does the job has Work Centre. |
DefaultActivity | String | Default Activity of the job. |
Activities | Array [string] | |
LastModifyDate | String | Last modified date. |
⬆️ Back to top
WorkBreakDownActivity
Property | Type | Description |
---|---|---|
Code | String | Activity code. |
Description | String | Activity description. |
ActivityType | String | What kind of activity is and where it can be used in Workbench. |
ActivitySubType | String | Activity sub type. |
WorkCentreCode | String | The code of default Work Centre for this activity |
UseTimeCodes | Boolean | |
DefaultTimeCode | String | |
TimeCodes | Array [string] | Costing fields from Employee Classes. |
⬆️ Back to top
WorkBreakDownJobWorkCentre
Property | Type | Description |
---|---|---|
JobCode | String | Code of the job. |
Code | String | |
Description | String | Description. |
⬆️ Back to top
WorkBreakDownTimeCode
Property | Type | Description |
---|---|---|
Code | String | |
Description | String | Description. |
LineType | Integer | Type of line. |
IncCost | Boolean | Including cost status. |
⬆️ Back to top
AdminWorkCentreKey
Property | Type | Description |
---|---|---|
WorkCentreCode | String | Code of the Work Centre. |
⬆️ Back to top
AdminWorkCentreLine
Property | Type | Description |
---|---|---|
WorkCentreCode | String | Code of the Work Centre. |
Description | String | Description text. |
WorkCentreGroupCode | String | Code of the group that Work Centre belongs to. |
CodeDescription | String | |
UpdatedDate | String | Updated date. |
WorkCentreCodeValue | Code of the Work Centre. | |
DescriptionValue | Description text. | |
WorkCentreGroupCodeValue | Code of the group that Work Centre belongs to. | |
Delete | ||
Status | String | |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
LookupsWorkCentreLine
Property | Type | Description |
---|---|---|
Code | CellData | Work Centre code. |
Description | String | Description text. |
Status | String | Work Centre status. |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index |
⬆️ Back to top
Examples
Get list of all Work Centres in Workbench
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of WorkBreakDownApi GET
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of getting list of filtered Work Centres
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
⬆️ Back to top
On this page
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|