Valuekeep Developers - Web API Reference

Work | Report Consumption

Service to manage entities of type 'WorkOrderTaskReportConsumption'.

Overview


URL api/{tenantKey}/{orgKey}/maintenance/workOrderReportConsumptions
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET WorkOrderReportConsumptions (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See WorkOrderReportConsumptionResource.

Response status codes:

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

Resource URL:

GET /maintenance/workOrderReportConsumptions/odata

GET WorkOrderReportConsumption by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See WorkOrderReportConsumptionResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /maintenance/workOrderReportConsumptions/{id}

GET WorkOrderReportConsumption by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workOrderReportConsumptionKey (string) Report Consumption.

Response:

When successful, the response body contains the entity record. See WorkOrderReportConsumptionResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}

POST Operations

POST WorkOrderReportConsumptions

Creates a new entity record.

The following elements are required:

workOrderReportConsumptionResource (ApiWorkOrderReportConsumptionResource) The request body should contain the entity record that should be created.
See ApiWorkOrderReportConsumptionResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiWorkOrderReportConsumptionResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /maintenance/workOrderReportConsumptions

POST Work Order Consumption Line

Inserts a new 'Work Order Consumption Line' in the 'Work Order Report Consumption'.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (ApiWorkOrderReportConsumptionWOConsumptionLinesResource) The ApiWorkOrderReportConsumptionWOConsumptionLinesResource instance.
See ApiWorkOrderReportConsumptionWOConsumptionLinesResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines

POST Update Work Order Report Consumption Info

Custom operation 'UpdateWorkOrderReportConsumptionInfo'.

The following elements are required:

companyKey (string) CompanyKey.
workOrderReportConsumptionKey (string) WorkOrderReportConsumptionKey.
workOrderReportConsumptionInfo (WorkOrderReportConsumptionInfoResource) WorkOrderReportConsumptionInfo.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

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

Resource URL:

POST /maintenance/workOrderReportConsumptions/updateWorkOrderReportConsumptionInfo/{companyKey}/{workOrderReportConsumptionKey}

PUT Operations

PUT Set AssetType WorkOrderReportConsumption

Updates the value of attribute 'AssetType' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (enum ReportAssetType) The request body should contain the new value for the attribute.
See ReportAssetType.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/assetType

PUT Set AutomaticSparePartConsumption WorkOrderReportConsumption

Updates the value of attribute 'AutomaticSparePartConsumption' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/automaticSparePartConsumption

PUT Set Company WorkOrderReportConsumption

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/company

PUT Set Currency WOConsumptionLine

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/currency

PUT Set Currency WorkOrderReportConsumption

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/currency

PUT Set Date WOConsumptionLine

Updates the value of attribute 'Date' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/date

PUT Set Description WOConsumptionLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/description

PUT Set Employee WorkOrderReportConsumption

Updates the value of attribute 'Employee' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/employee

PUT Set Equipment WorkOrderReportConsumption

Updates the value of attribute 'Equipment' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/equipment

PUT Set ExchangeRate WorkOrderReportConsumption

Updates the value of attribute 'ExchangeRate' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/exchangeRate

PUT Set ExchangeRateDate WorkOrderReportConsumption

Updates the value of attribute 'ExchangeRateDate' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/exchangeRateDate

PUT Set IsActive WorkOrderReportConsumption

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/isActive

PUT Set IsLocked WorkOrderReportConsumption

Updates the value of attribute 'IsLocked' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/isLocked

PUT Set Location WorkOrderReportConsumption

Updates the value of attribute 'Location' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/location

PUT Set MaintenanceRoute WorkOrderReportConsumption

Updates the value of attribute 'MaintenanceRoute' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/maintenanceRoute

PUT Set Price WOConsumptionLine

Updates the value of attribute 'Price' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/price

PUT Set Quantity WOConsumptionLine

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/quantity

PUT Set Remarks WOConsumptionLine

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/remarks

PUT Set Remarks WorkOrderReportConsumption

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/remarks

PUT Set ReportDate WorkOrderReportConsumption

Updates the value of attribute 'ReportDate' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/reportDate

PUT Set RequisitionLineId WOConsumptionLine

Updates the value of attribute 'RequisitionLineId' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/requisitionLineId

PUT Set Task WOConsumptionLine

Updates the value of attribute 'Task' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/task

PUT Set Tool WorkOrderReportConsumption

Updates the value of attribute 'Tool' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/tool

PUT Set TotalCost WOConsumptionLine

Updates the value of attribute 'TotalCost' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/totalCost

PUT Set Unit WOConsumptionLine

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/unit

PUT Set WOMaintenancePlanId WOConsumptionLine

Updates the value of attribute 'WOMaintenancePlanId' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/wOMaintenancePlanId

PUT Set WOMaintenancePlanTaskId WOConsumptionLine

Updates the value of attribute 'WOMaintenancePlanTaskId' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/wOMaintenancePlanTaskId

PUT Set WorkOrderMaintenancePlan WOConsumptionLine

Updates the value of attribute 'WorkOrderMaintenancePlan' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/workOrderMaintenancePlan

PUT Set WorkOrderReportConsumptionKey WorkOrderReportConsumption

Updates the value of attribute 'WorkOrderReportConsumptionKey' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/workOrderReportConsumptionKey

PUT Set WOTaskId WOConsumptionLine

Updates the value of attribute 'WOTaskId' in the specified entity record.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/wOTaskId

PUT Set Custom Attribute WorkOrderReportConsumption

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
workOrderReportConsumptionKey (string) Report Consumption
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/{customAttributeName}

PUT Set Custom Attribute WOConsumptionLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
workOrderReportConsumptionKey (string) Report Consumption
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Work Order Consumption Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}/wOConsumptionLines/{lineId}

DELETE WorkOrderReportConsumption by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /maintenance/workOrderReportConsumptions/{id}

DELETE WorkOrderReportConsumption by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workOrderReportConsumptionKey (string) Report Consumption.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /maintenance/workOrderReportConsumptions/{companyKey}/{workOrderReportConsumptionKey}

Resources


ApiWorkOrderReportConsumptionResource

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
workOrder (string) Work Order.
employee (string) Employee.
assetType (enum ReportAssetType) Type.
See ReportAssetType.
company (string) Company.
currency (string) Currency.
isLocked (bool) Is Locked.
exchangeRate (decimal) Exchange Rate.

The following elements are optional:

reportDate (DateTimeOffset) Report Date.
location (string) Location.
equipment (string) Equipment.
tool (string) Tool.
remarks (string) Remarks.
wOConsumptionLines (List of ApiWorkOrderReportConsumptionWOConsumptionLinesResource) Report Consumptions Line.
See ApiWorkOrderReportConsumptionWOConsumptionLinesResource.
exchangeRateDate (DateTime) Exchange Rate Date.
maintenanceRoute (string) Route.
automaticSparePartConsumption (bool) Automatic Spare Part Consumption.


ApiWorkOrderReportConsumptionWOConsumptionLinesResource

The following elements are required:

date (DateTimeOffset) Date.
quantity (decimal) Quantity.
part (string) Part.
unit (string) Unit.
price (MoneyResource) Price.
See MoneyResource .
totalCost (MoneyResource) Total Cost.
See MoneyResource .
currency (string) Currency.

The following elements are optional:

description (string) Description.
warehouse (string) Warehouse.
remarks (string) Remarks.
workOrderMaintenancePlan (string) Maintenance Plan.
wOMaintenancePlanId (Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId (Guid) WO Maintenance Plan Task Id.
wOTaskId (Guid) WO Task Id.
task (string) Task.
requisitionLineId (Guid) Requisition Line Id.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



WorkOrderReportConsumptionInfoResource

The following elements are required:

employee (string) Employee.
date (DateTimeOffset) Date.
part (string) Part.
quantity (decimal) Quantity.
unit (string) Unit.

The following elements are optional:

reportDate (DateTimeOffset) Report Date.
remarks (string) Remarks.
description (string) Description.
remarks (string) Remarks.
wOConsumptionLines (string) Report Consumptions Line.
workOrderMaintenancePlan (string) Maintenance Plan.
wOMaintenancePlanId (Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId (Guid) WO Maintenance Plan Task Id.
wOTaskId (Guid) WO Task Id.
warehouse (string) Warehouse.
requisitionLineId (Guid) Requisition Line Id.


WorkOrderReportConsumptionResource

The following elements are required:

workOrderReportConsumptionKey (string) Report Consumption.
workOrder (string) Work Order.
(fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
employee (string) Employee.
(fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
assetType (enum ReportAssetType) Type.
See ReportAssetType.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
isLocked (bool) Is Locked.
exchangeRate (decimal) Exchange Rate.

The following elements are optional:

reportDate (DateTimeOffset) Report Date.
location (string) Location.
(fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
equipment (string) Equipment.
(fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
tool (string) Tool.
(fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
remarks (string) Remarks.
wOConsumptionLines (List of WOConsumptionLineResource) Report Consumptions Line.
See WOConsumptionLineResource.
exchangeRateDate (DateTime) Exchange Rate Date.
maintenanceRoute (string) Route.
(fk) Allowed value: the natural key of a record of type Route. These records are accessibly through the Routes service.
automaticSparePartConsumption (bool) Automatic Spare Part Consumption.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


ReportAssetType

1 Location
2 Equipment
3 Tool