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
Provides 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 WorkbenchProvides API access to the Work Centres Lookup functionality.
/api/WorkCentreListApiWorkCentreLookupApi | ||||
---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
POST | Admin User | - | GridRequestParametersApi (finCoCode and jobCode are required) |
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) |
WorkBreakDownApiModel
Property | Type | Description |
---|---|---|
Jobs | Array [WorkBreakDownJob]Array<WorkBreakDownJob> | The User’s Jobs that have been updated or used after WorkbenchBreakdownKey.UpdateDate. |
Activities | Array [WorkBreakDownActivity]Array<WorkBreakDownActivity> | Activities that have been updated after WorkbenchBreakdownKey.UpdateDate. |
WorkCentres | Array [WorkBreakDownJobWorkCentre]Array<WorkBreakDownJobWorkCentre> | Work Centres for the retrieved Jobs. |
TimeCodes | Array [WorkBreakDownTimeCode]Array<WorkBreakDownTimeCode> | The User’s Time Codes. |
⬆️ Back to top
WorkBreakDownJob
Property | Type | Description |
---|---|---|
Code | String | The unique Code of the jobJob. |
Description | String | The Description of the Job |
JobTypeCode | String | The Code of job typeJob Type. |
JobManager | String | The full name of the Job manager Manager for the jobJob. |
JobManagerId | Integer | Code The ID of the Job manager personManager. |
AccountManager | StringAccount | manager person,The full name of the Account Manager for the Job. |
AccountManagerId | Integer | Code of account manager personThe ID of the Account Manager. |
CompanyName | String | |
CompanyId | Integer | Code The Company ID of the companyJob. |
Closed | Boolean | The job is closed or notClosed flag on the Job. |
Finalised | Boolean | The job is finalised or notFinalised flag on the Job. |
HasJobWorkCentres | Boolean | Does the job has Work CentreA flag to indicate if the Job has Job Work Centres. |
DefaultActivity | String | Default Activity of the jobActivity Group of the Job. |
Activities | Array [string]Array<string> | The Activities that belong to the Activity Group of the Job. |
LastModifyDate | String | Last modified dateThe date the Job was last modified. |
⬆️ Back to top
WorkBreakDownActivity
Property | Type | Description | |
---|---|---|---|
Code | String | The unique Code of the Activity code. | |
Description | String | The Description of the Activity description. | |
ActivityType | String | What kind of activity Activity is and where it can be used in Workbench. | |
ActivitySubType | String | Activity The sub-type of the Activity. | |
WorkCentreCode | String | The code Code of the default Work Centre for this activityActivity. | |
UseTimeCodes | Boolean | A flag to indicate if the Activity uses Time Codes. | |
DefaultTimeCode | String | The default Time Code. | |
TimeCodes | Array [string] | Costing fields from Employee ClassesArray<string> | The User’s Time Codes for this Activity. |
⬆️ Back to top
WorkBreakDownJobWorkCentre
Property | Type | Description | |
---|---|---|---|
JobCodeCode | String | The unique Code of the jobWork Centre.Code | |
Description | String | The Description of the Work Centre. | |
WorkUpdatedDate | String | DescriptionDateTime | 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 |
---|---|---|
Code | String | The unique Code of the Time Code. |
Description | String | The Description of the Time Code. |
LineType | Integer | The Line Type of linethe Time Code. |
IncCost | BooleanIncluding | cost statusThe Include Cost flag on the Time Code. |
⬆️ 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 | ||||
---|---|---|---|---|
|