Work | Context Dashboard

Overview

URL	api/{tenantKey}/{orgKey}/maintenance/contextDashboards
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Get Work Order Requests Info
  • GET Get Work Order Total Requests
  • GET Get Work Order Assignment Asset Info
  • GET Get Work Order Equipment Info
  • GET Get Work Order Location Info
  • GET Get Work Order Type Info
  • GET Get Work Order Workshop Info
  • GET Get Work Order Transition Info
  • GET Get Work Order Asset Info
  • GET Get Request Asset Info
  • GET Get Equipment Location Details
  • GET Get Parent Equipment Tool Details
  • GET Get Equipment Tool Details
  • GET Get Location Details
  • GET Get Parent Location Details
  • GET Get Work Order Traceability

All Resources

This service uses the following resources:

• AssetInfo
• EquipmentToolDetails
• LocationDetails
• NumberOfRequests
• Traceability
• WorkOrderAssignmentAssetInfo
• WorkOrderEquipmentInfo
• WorkOrderLocationInfo
• WorkOrderRequestInfo
• WorkOrderTransitionInfo
• WorkOrderTypeInfo
• WorkOrderWorkshopInfo

GET Operations

GET Get Work Order Requests Info

Custom operation 'GetWorkOrderRequestsInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a list of resources of type 'WorkOrderRequestInfo'. See WorkOrderRequestInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Total Requests

Custom operation 'GetWorkOrderTotalRequests'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'NumberOfRequests'. See NumberOfRequests.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Assignment Asset Info

Custom operation 'GetWorkOrderAssignmentAssetInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'WorkOrderAssignmentAssetInfo'. See WorkOrderAssignmentAssetInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Equipment Info

Custom operation 'GetWorkOrderEquipmentInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'WorkOrderEquipmentInfo'. See WorkOrderEquipmentInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Location Info

Custom operation 'GetWorkOrderLocationInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'WorkOrderLocationInfo'. See WorkOrderLocationInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Type Info

Custom operation 'GetWorkOrderTypeInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'WorkOrderTypeInfo'. See WorkOrderTypeInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Workshop Info

Custom operation 'GetWorkOrderWorkshopInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'WorkOrderWorkshopInfo'. See WorkOrderWorkshopInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Transition Info

Custom operation 'GetWorkOrderTransitionInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a list of resources of type 'WorkOrderTransitionInfo'. See WorkOrderTransitionInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Asset Info

Custom operation 'GetWorkOrderAssetInfo'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

When successful, the response body contains a resource of type 'AssetInfo'. See AssetInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Request Asset Info

Custom operation 'GetRequestAssetInfo'.

The following elements are required:

requestKey

(string) RequestKey.

Response:

When successful, the response body contains a resource of type 'AssetInfo'. See AssetInfo.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Equipment Location Details

Custom operation 'GetEquipmentLocationDetails'.

The following elements are required:

assetKey

(string) AssetKey.

Response:

When successful, the response body contains a resource of type 'LocationDetails'. See LocationDetails.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Parent Equipment Tool Details

Custom operation 'GetParentEquipmentToolDetails'.

The following elements are required:

assetKey

(string) AssetKey.

Response:

When successful, the response body contains a resource of type 'EquipmentToolDetails'. See EquipmentToolDetails.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Equipment Tool Details

Custom operation 'GetEquipmentToolDetails'.

The following elements are required:

assetKey

(string) AssetKey.

Response:

When successful, the response body contains a resource of type 'EquipmentToolDetails'. See EquipmentToolDetails.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Location Details

Custom operation 'GetLocationDetails'.

The following elements are required:

locationKey

(string) LocationKey.

Response:

When successful, the response body contains a resource of type 'LocationDetails'. See LocationDetails.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Parent Location Details

Custom operation 'GetParentLocationDetails'.

The following elements are required:

locationKey

(string) LocationKey.

Response:

When successful, the response body contains a resource of type 'LocationDetails'. See LocationDetails.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Work Order Traceability

Custom operation 'GetWorkOrderTraceability'.

The following elements are required:

workOrderId	(Guid) WorkOrderId.
companyKey	(string) CompanyKey.

Response:

When successful, the response body contains a list of resources of type 'Traceability'. See Traceability.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

Resources

AssetInfo

The following elements are optional:

assetKey	(string) Asset Key.
assetDescription	(string) Asset Description.
assetPicture	(string) Asset Picture.
nrRequests	(int) Nr Requests.
nrRequestsDescription	(string) Nr Requests Description.
nrRequestsOpen	(int) Nr Requests Open.
nrRequestsOpenDescription	(string) Nr Requests Open Description.
totalReportLaborsCostsBase	(string) Total Report Labors Costs Base.
totalReportLaborsCostsBaseDescription	(string) Total Report Labors Costs Base Description.
totalReportLaborsCostsReporting	(string) Total Report Labors Costs Reporting.
totalReportLaborsCostsReportingDescription	(string) Total Report Labors Costs Reporting Description.
totalReportMiscCostsBase	(string) Total Report Misc Costs Base.
totalReportMiscCostsBaseDescription	(string) Total Report Misc Costs Base Description.
totalReportMiscCostsReporting	(string) Total Report Misc Costs Reporting.
totalReportMiscCostsReportingDescription	(string) Total Report Misc Costs Reporting Description.
totalReportConsumptionCostsBase	(string) Total Report Consumption Costs Base.
totalReportConsumptionCostsBaseDescription	(string) Total Report Consumption Costs Base Description.
totalReportConsumptionCostsReporting	(string) Total Report Consumption Costs Reporting.
totalReportConsumptionCostsReportingDescription	(string) Total Report Consumption Costs Reporting Description.
nrWorkOrders	(int) Nr Work Orders.
nrWorkOrdersDescription	(string) Nr Work Orders Description.
nrWorkOrdersOpen	(int) Nr Work Orders Open.
nrWorkOrdersOpenDescription	(string) Nr Work Orders Open Description.

EquipmentToolDetails

The following elements are optional:

requestsInitialState	(string) Requests Initial State.
requestsInitialStateDescription	(string) Requests Initial State Description.
requestsToWorkOrders	(string) Requests To Work Orders.
requestsToWorkOrdersDescription	(string) Requests To Work Orders Description.
workOrdersFinalState	(string) Work Orders Final State.
workOrdersFinalStateDescription	(string) Work Orders Final State Description.
workOrdersOpenAllowCostReport	(string) Work Orders Open Allow Cost Report.
workOrdersOpenAllowCostReportDescription	(string) Work Orders Open Allow Cost Report Description.
workOrdersOpenAllowWorkReport	(string) Work Orders Open Allow Work Report.
workOrdersOpenAllowWorkReportDescription	(string) Work Orders Open Allow Work Report Description.
workOrdersInitialState	(string) Work Orders Initial State.
workOrdersInitialStateDescription	(string) Work Orders Initial State Description.
failures	(string) Failures.
failuresDescription	(string) Failures Description.
globalMTTR	(string) Global MTTR.
globalMTTRDescription	(string) Global MTTR Description.

LocationDetails

The following elements are optional:

requestsInitialState	(string) Requests Initial State.
requestsInitialStateDescription	(string) Requests Initial State Description.
requestsToWorkOrders	(string) Requests To Work Orders.
requestsToWorkOrdersDescription	(string) Requests To Work Orders Description.
workOrdersFinalState	(string) Work Orders Final State.
workOrdersFinalStateDescription	(string) Work Orders Final State Description.
workOrdersOpenAllowCostReport	(string) Work Orders Open Allow Cost Report.
workOrdersOpenAllowCostReportDescription	(string) Work Orders Open Allow Cost Report Description.
workOrdersOpenAllowWorkReport	(string) Work Orders Open Allow Work Report.
workOrdersOpenAllowWorkReportDescription	(string) Work Orders Open Allow Work Report Description.
workOrdersInitialState	(string) Work Orders Initial State.
workOrdersInitialStateDescription	(string) Work Orders Initial State Description.
parentLocation	(string) Parent Location.
parentLocationDescription	(string) Parent Location Description.
parentLocationSubtitle	(string) Parent Location Subtitle.

NumberOfRequests

The following elements are optional:

total	(int) Total.
title	(string) Title.
subTitle	(string) Sub Title.

Traceability

The following elements are optional:

parent

(string) Parent.

WorkOrderAssignmentAssetInfo

The following elements are optional:

assetKey	(string) Asset Key.
assetDescription	(string) Asset Description.
assetPicture	(string) Asset Picture.
assetSubTitle	(string) Asset Sub Title.
parentAssetKey	(string) Parent Asset Key.
parentAssetDescription	(string) Parent Asset Description.
parentAssetPicture	(string) Parent Asset Picture.
parentAssetSubTitle	(string) Parent Asset Sub Title.
locationKey	(string) Location Key.
locationDescription	(string) Location Description.
locationPicture	(string) Location Picture.
locationSubTitle	(string) Location Sub Title.
parentLocationKey	(string) Parent Location Key.
parentLocationDescription	(string) Parent Location Description.
parentLocationPicture	(string) Parent Location Picture.
parentLocationSubTitle	(string) Parent Location Sub Title.

WorkOrderEquipmentInfo

The following elements are optional:

equipmentKey	(string) Equipment Key.
equipmentDescription	(string) Equipment Description.
equipmentPicture	(string) Equipment Picture.
parentEquipmentKey	(string) Parent Equipment Key.
parentEquipmentDescription	(string) Parent Equipment Description.
parentEquipmentPicture	(string) Parent Equipment Picture.
locationKey	(string) Location Key.
locationDescription	(string) Location Description.
locationPicture	(string) Location Picture.
brandKey	(string) Brand Key.
brandDescription	(string) Brand Description.
brandModelKey	(string) Brand Model Key.
brandModelDescription	(string) Brand Model Description.
nrWorkOrders	(int) Nr Work Orders.
nrWorkOrdersOpened	(int) Nr Work Orders Opened.
totalReportLaborsTime	(TimeSpan) Total Report Labors Time.
totalReportLaborsCost	(int) Total Report Labors Cost.
totalReportConsumptions	(int) Total Report Consumptions.
totalReportMiscCosts	(int) Total Report Misc Costs.

WorkOrderLocationInfo

The following elements are optional:

locationKey	(string) Location Key.
locationDescription	(string) Location Description.
locationPicture	(string) Location Picture.
nrWorkOrders	(int) Nr Work Orders.
nrWorkOrdersOpened	(int) Nr Work Orders Opened.
totalReportLaborsTime	(TimeSpan) Total Report Labors Time.
totalReportLaborsCost	(int) Total Report Labors Cost.
totalReportConsumptions	(int) Total Report Consumptions.
totalReportMiscCosts	(int) Total Report Misc Costs.

WorkOrderRequestInfo

The following elements are optional:

requestKey	(string) Request Key.
requestDescription	(string) Request Description.

WorkOrderTransitionInfo

The following elements are required:

previousStateDescription	(string) Previous State Description.
newStateDescription	(string) New State Description.
dateTransition	(string) Date Transition.

The following elements are optional:

html	(string) Html.
justification	(string) Justification.
employeeName	(string) Employee Name.
employeeEmail	(string) Employee Email.

WorkOrderTypeInfo

The following elements are optional:

workOrderTypeKey	(string) Work Order Type Key.
workOrderTypeDescription	(string) Work Order Type Description.
nrWorkOrders	(int) Nr Work Orders.
nrWorkOrdersOpened	(int) Nr Work Orders Opened.
totalReportLaborsTime	(TimeSpan) Total Report Labors Time.
totalReportLaborsCost	(int) Total Report Labors Cost.
totalReportConsumptions	(int) Total Report Consumptions.
totalReportMiscCosts	(int) Total Report Misc Costs.

WorkOrderWorkshopInfo

The following elements are optional:

workshopKey	(string) Workshop Key.
workshopDescription	(string) Workshop Description.
nrWorkOrders	(int) Nr Work Orders.
nrWorkOrdersOpened	(int) Nr Work Orders Opened.
totalReportLaborsTime	(TimeSpan) Total Report Labors Time.
totalReportLaborsCost	(int) Total Report Labors Cost.
totalReportConsumptions	(int) Total Report Consumptions.
totalReportMiscCosts	(int) Total Report Misc Costs.