Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
[Description]. Provides access to Workbench Work Breakdown documentationdata.
Endpoints
The resources available in this module.
WorkBreakDownApi
Provides API access to Job, Activity, and Work Centre data.
/api/WorkBreakDownApi | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | - |
GET parameters.
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
updateDate | Required | Updated date. | query | date-time. |
WorkCentreListApi
Return all Work Centres in WorkbenchRetrieve 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 | Description | 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.
Jobs
Array [WorkBreakDownJob]
Activities
Array [WorkBreakDownActivity]
WorkCentres
Array [WorkBreakDownJobWorkCentre]
TimeCodes
Array [WorkBreakDownTimeCode]
WorkBreakDownJob
/api/ | WorkCentreListApiWorkCentreLookupApi | ||||||||
---|---|---|---|---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response | ||||
POST | Return list of filtered Work Centres. |
JobListApi
/url
Method
Description
Performed As
Request Query
Request Body
Response
GET
-
POST
JobDetailApi
/url
Method
Description
Performed As
Request Query
Request Body
Response
GET
-
POST
JobBudgetListApi
/url
Method
Description
Performed As
Request Query
Request Body
Response
GET
-
POST
JobBudgetDetailApi
[Description]
/url
Method
Description
Performed As
Request Query
Request Body
Response
GET
-
POST
Models
The definitions of models specific to endpoints in this module.
AdminWorkCentreKey
Field
Type
Description
WorkCentreCode
String
Code of the Work Centre.
AdminWorkCentreLine
Field
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
AdminWorkCentreKey
CurrentKey
AdminWorkCentreKey
Key
AdminWorkCentreKey
Index
Integer
LookupsWorkCentreLine
Field
Type
Description
Code
CellData
Work Centre code.
Description
String
Description text.
Status
String
Work Centre status.
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
LookupsLookupKey
CurrentKey
LookupsLookupKey
Key
LookupsLookupKey
Index
WorkBreakDownApiModel
Field
Type
Description
Retrieve a filtered list of Activities, for a specific Job and Financial Company. | 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> | 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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
Code | String | The unique Code of the |
Work Centre. | |
Description | String |
JobTypeCode
String
The Description of the Work Centre. |
WorkUpdatedDate |
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.
WorkBreakDownActivity
Field
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
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 |
---|---|---|
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 |
---|---|---|
WorkCentreCode | String | The unique code of the Work Centre. |
⬆️ Back to top
WorkCentreLine
Property | Type | Description |
---|---|---|
Key | The unique key for the line. | |
WorkCentreCode | String | The unique code of |
the Work Centre |
UseTimeCodes
Boolean
DefaultTimeCode
String
TimeCodes
Array [string]
Costing fields from Employee Classes.
WorkBreakDownJobWorkCentre
Field
Type
Description
JobCode
String
Code of the job.
Code
String
Description
String
Description.
WorkBreakDownTimeCode
Field
Type
Description
Code
String
Description
String
LineType
Integer
IncCost
Boolean
Field
Type
. | ||
WorkCentreCodeValue | The unique code of the Work Centre. | |
Description | String | The description of the Work Centre. |
DescriptionValue | The description of the Work Centre. | |
WorkCentreGroupCode | String | The Work Centre Group of the Work Centre. |
WorkCentreGroupCodeValue | 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 |
---|---|---|
Key | The unique key for the line. | |
Code | 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
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 | ||||
---|---|---|---|---|
|