Work | Prev. Events Management
Overview
| URL | api/{tenantKey}/{orgKey}/maintenance/preventiveMaintenanceEventsManagements |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Prev. Events Management
Returns the list of entity records that can be processed by the 'PreventiveMaintenanceEvents' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| operation | (WOManagementOperation) Print. |
The following elements are optional:
| preventiveMaintenance | (string) Preventive Maintenance This is a query string parameter. |
| fWorkshop | (string) Workshop This is a query string parameter. |
| location | (string) Location This is a query string parameter. |
| equipment | (string) Equipment This is a query string parameter. |
| tool | (string) Tool This is a query string parameter. |
| maintenanceRoute | (string) Route This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
| startDate | (DateTime?) Start Date This is a query string parameter. |
| endDate | (DateTime?) End Date This is a query string parameter. |
| duplexPrinting | (bool?) Duplex Printing This is a query string parameter. |
| schemaEntityState | (string) State This is a query string parameter. |
| showInlineAlertMessage | (bool?) Show Inline Alert Message This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See PrevMaintEventsManagementLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/maintenance/preventiveMaintenanceEventsManagements/{pageIndex}/{pageSize}?preventiveMaintenance={preventiveMaintenance}&fWorkshop={fWorkshop}&location={location}&equipment={equipment}&tool={tool}&maintenanceRoute={maintenanceRoute}&company={company}&startDate={startDate}&endDate={endDate}&duplexPrinting={duplexPrinting}&schemaEntityState={schemaEntityState}&showInlineAlertMessage={showInlineAlertMessage}
GET /maintenance/preventiveMaintenanceEventsManagements/{pageIndex}/{pageSize}?preventiveMaintenance={preventiveMaintenance}&fWorkshop={fWorkshop}&location={location}&equipment={equipment}&tool={tool}&maintenanceRoute={maintenanceRoute}&company={company}&startDate={startDate}&endDate={endDate}&duplexPrinting={duplexPrinting}&schemaEntityState={schemaEntityState}&showInlineAlertMessage={showInlineAlertMessage}
POST Add Create WO
Custom operation 'AddCreateWO'.
The following elements are required:
| companyKey | (string) CompanyKey. |
| preventiveEventManagementTasks | (List |
| notifyOnStart | (bool) NotifyOnStart. |
| notifyOnEnd | (bool) NotifyOnEnd. |
| duplexPrinting | (bool) DuplexPrinting. |
Response:
| When successful, the response body contains a list of resources of type 'PreventiveEventManagementTask'. See PreventiveEventManagementTask. |
Resource URL:
api/{tenantKey}/{orgKey}/maintenance/preventiveMaintenanceEventsManagements/addCreateWO/{companyKey}
POST /maintenance/preventiveMaintenanceEventsManagements/addCreateWO/{companyKey}
POST Prev. Events Management
Instructs the 'PreventiveMaintenanceEvents' service to process the specified entity records.
The following elements are required:
| list | (PrevMaintEventsManagementLine) List of the entity records that should be processed. See PrevMaintEventsManagementLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/maintenance/preventiveMaintenanceEventsManagements/{companyKey}
POST /maintenance/preventiveMaintenanceEventsManagements/{companyKey}
Resources
PreventiveEventManagementTask
The following elements are required:
| preventiveEventKey | (string) Preventive Event Key. |
| occurrence | (int) Occurrence. |
| newStateKey | (string) New State Key. |
The following elements are optional:
| (bool) Print. | |
| taskId | (string) Task Id. |
| errorMessage | (string) Error Message. |
| maintenanceTaskId | (string) Maintenance Task Id. |
| reportTemplate | (string) Report Template. |
| duplexPrinting | (bool) Duplex Printing. |
PrevMaintEventsManagement
The following elements are required:
| selectedCount | (int) Selected Count. |
| operation | (enum WOManagementOperation) Print.
See WOManagementOperation. |
The following elements are optional:
| preventiveMaintenance | (string) Preventive Maintenance. |
| fWorkshop | (string) Workshop. |
| location | (string) Location. |
| equipment | (string) Equipment. |
| tool | (string) Tool. |
| maintenanceRoute | (string) Route. |
| company | (string) Company. |
| startDate | (DateTime) Start Date. |
| endDate | (DateTime) End Date. |
| duplexPrinting | (bool) Duplex Printing. |
| schemaEntityState | (string) State. |
| showInlineAlertMessage | (bool) Show Inline Alert Message. |
PrevMaintEventsManagementLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| expectedDate | (DateTimeOffset) Expected Date. |
| preventiveMaintenance | (string) Preventive Maintenance. |
| preventiveMaintenancePlan | (string) Prev. Maint. Plan. |
| event | (string) Event. |
| assetType | (string) Asset Type. |
| asset | (string) Asset. |
| workshop | (string) Workshop. |
| company | (string) Company. |