Work | Summary Value
Overview
| URL | api/{tenantKey}/{orgKey}/maintenance/summaryValues |
| Methods Supported | GET |
All Operations
This service includes the following operations:
- GET:
All Resources
This service uses the following resources:
GET Get Named Summarized Values By Code
Custom operation 'GetNamedSummarizedValuesByCode'.
The following elements are required:
| codes | (string) Codes. |
Response:
| When successful, the response body contains a list of resources of type 'NamedSummarizedValue'. See NamedSummarizedValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get WO Costs Chart Results
Custom operation 'GetWOCostsChartResults'.
The following elements are required:
| months | (int) Months. |
Response:
| When successful, the response body contains a list of resources of type 'WOCostsChartResult'. See WOCostsChartResult. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Dasboard Entity List Count
Custom operation 'GetDasboardEntityListCount'.
The following elements are required:
| company | (string) Company. |
| entityName | (string) EntityName. |
| startDate | (DateTime?) StartDate. |
| endDate | (DateTime?) EndDate. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
GET Get Dashboard Entity List Data
Custom operation 'GetDashboardEntityListData'.
The following elements are required:
| company | (string) Company. |
| entityName | (string) EntityName. |
| startDate | (DateTime?) StartDate. |
| endDate | (DateTime?) EndDate. |
Response:
| When successful, the response body contains a list of resources of type 'DashboardEntityListData'. See DashboardEntityListData. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Technician WO List Count
Custom operation 'GetTechnicianWOListCount'.
The following elements are required:
| company | (string) Company. |
| audience | (string) Audience. |
| startDate | (DateTime?) StartDate. |
| endDate | (DateTime?) EndDate. |
Response:
| When successful, the response body contains an item of type 'number'. |
Resource URL:
GET Get Technician WO List Data
Custom operation 'GetTechnicianWOListData'.
The following elements are required:
| company | (string) Company. |
| audience | (string) Audience. |
| startDate | (DateTime?) StartDate. |
| endDate | (DateTime?) EndDate. |
Response:
| When successful, the response body contains a list of resources of type 'DashboardEntityListData'. See DashboardEntityListData. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
DashboardEntityListData
The following elements are required:
| id | (Guid) Id. |
The following elements are optional:
| date | (DateTime) Date. |
| expectedDate | (DateTime) Expected Date. |
| entity | (string) Entity. |
| entityDesc | (string) Entity Desc. |
| entityLink | (string) Entity Link. |
| stateDesc | (string) State Desc. |
| associatedEntityId | (Guid) Associated Entity Id. |
| associatedEntityLink | (string) Associated Entity Link. |
| associatedEntity | (string) Associated Entity. |
| associatedEntityDesc | (string) Associated Entity Desc. |
| type | (string) Type. |
| maintenancePlanId | (Guid) Maintenance Plan Id. |
| maintenancePlan | (string) Maintenance Plan. |
| maintenancePlanLink | (string) Maintenance Plan Link. |
| maintenancePlanDesc | (string) Maintenance Plan Desc. |
| assetIcon | (string) Asset Icon. |
| assetDesc | (string) Asset Desc. |
| priorityDesc | (string) Priority Desc. |
| operation | (string) Operation. |
| operationLink | (string) Operation Link. |
NamedSummarizedValue
The following elements are optional:
| caption | (string) Caption. |
| result | (string) Result. |
| info | (string) Info. |
| captionLink | (string) Caption Link. |
| resultLink | (string) Result Link. |
| infoLink | (string) Info Link. |
WOCostsChartResult
The following elements are required:
| timestamp | (string) Timestamp. |
| labor | (decimal) Labor. |
| consumptions | (decimal) Consumptions. |
| miscCosts | (decimal) Misc Costs. |