Work | Prev. Maint. Management
Overview
| URL | api/{tenantKey}/{orgKey}/maintenance/preventiveMaintenanceManagements |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Prev. Maint. Management
Returns the list of entity records that can be processed by the 'PreventiveMaintenances' 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). |
| schemaEntityState | (string) State. |
| operation | (PreventiveMaintenanceManagementOperation) Operation. |
The following elements are optional:
| fWorkshop | (string) Workshop 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. |
| 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. |
| newSchemaEntityState | (string) New State This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See PrevMaintManagementLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/maintenance/preventiveMaintenanceManagements/{pageIndex}/{pageSize}?fWorkshop={fWorkshop}&startDate={startDate}&endDate={endDate}&location={location}&equipment={equipment}&tool={tool}&maintenanceRoute={maintenanceRoute}&company={company}&newSchemaEntityState={newSchemaEntityState}
GET /maintenance/preventiveMaintenanceManagements/{pageIndex}/{pageSize}?fWorkshop={fWorkshop}&startDate={startDate}&endDate={endDate}&location={location}&equipment={equipment}&tool={tool}&maintenanceRoute={maintenanceRoute}&company={company}&newSchemaEntityState={newSchemaEntityState}
POST Prev. Maint. Management
Instructs the 'PreventiveMaintenances' service to process the specified entity records.
The following elements are required:
| list | (PrevMaintManagementLine) List of the entity records that should be processed. See PrevMaintManagementLine. |
| 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/preventiveMaintenanceManagements/{companyKey}
POST /maintenance/preventiveMaintenanceManagements/{companyKey}
Resources
PrevMaintManagement
The following elements are required:
| selectedCount | (int) Selected Count. |
| schemaEntityState | (string) State. |
| operation | (enum PreventiveMaintenanceManagementOperation) Operation.
See PreventiveMaintenanceManagementOperation. |
The following elements are optional:
| fWorkshop | (string) Workshop. |
| startDate | (DateTime) Start Date. |
| endDate | (DateTime) End Date. |
| location | (string) Location. |
| equipment | (string) Equipment. |
| tool | (string) Tool. |
| maintenanceRoute | (string) Route. |
| company | (string) Company. |
| newSchemaEntityState | (string) New State. |
PrevMaintManagementLine
The following elements are required:
| selected | (bool) Selected. |
| preventiveMaintenance | (string) Preventive Maintenance. |
| priorityLevel | (string) Priority Level. |
| workshop | (string) Workshop. |
The following elements are optional:
| projectionEndDate | (DateTime) Projection End. |
| responsible | (string) Person In Charge. |
| workOrderState | (string) WO State. |
| company | (string) Company. |