Work | Spare Parts Management
Overview
| URL | api/{tenantKey}/{orgKey}/maintenance/sparePartsManagements |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Spare Parts Management
Returns the list of entity records that can be processed by the 'WorkOrderReportConsumptions' 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). |
| assetType | (ReportAssetType) Asset Type. |
The following elements are optional:
| workOrder | (string) Work Order This is a query string parameter. |
| equipment | (string) Asset This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
| isRoute | (bool?) Is Route This is a query string parameter. |
| location | (string) Asset This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See SparePartsManagementLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Spare Parts Management
Instructs the 'WorkOrderReportConsumptions' service to process the specified entity records.
The following elements are required:
| list | (SparePartsManagementLine) List of the entity records that should be processed. See SparePartsManagementLine. |
| 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:
Resources
SparePartsManagement
The following elements are required:
| selectedCount | (int) Selected Count. |
| assetType | (enum ReportAssetType) Asset Type.
See ReportAssetType. |
The following elements are optional:
| workOrder | (string) Work Order. |
| equipment | (string) Asset. |
| company | (string) Company. |
| isRoute | (bool) Is Route. |
| location | (string) Asset. |
SparePartsManagementLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| partId | (Guid) Part Id. |
| part | (string) Part. |
| partKey | (string) Part Key. |
| partDescription | (string) Part Description. |
| quantity | (decimal) Quantity. |
| remarks | (string) Remarks. |
| date | (DateTimeOffset) Date. |
| warehouse | (string) Warehouse. |
| company | (string) Company. |