Assets | Down Time History Time

Service to manage entities of type 'DownTimeHistoryTime'.

Overview

URL	api/{tenantKey}/{orgKey}/assetManagement/downTimeHistoryTimes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET DownTimeHistoryTimes (odata)
  • GET DownTimeHistoryTime by identifier
  • GET DownTimeHistoryTime by key
• POST:
  • POST DownTimeHistoryTimes
  • POST Down Time History Time Item
  • POST Build Down Time History Times From Work Order
• PUT:
  • PUT Set Custom Attribute DownTimeHistoryTime
  • PUT Set Custom Attribute DownTimeHistoryTimeItem
  • PUT Set IsActive DownTimeHistoryTime
  • PUT Set DownTimeHistoryTimeKey DownTimeHistoryTime
  • PUT Set Description DownTimeHistoryTime
  • PUT Set WorlOrderId DownTimeHistoryTime
  • PUT Set Company DownTimeHistoryTime
  • PUT Set DownAndUpTimeHistory DownTimeHistoryTimeItem
  • PUT Set StartDate DownTimeHistoryTimeItem
  • PUT Set EndDate DownTimeHistoryTimeItem
  • PUT Set TotalHours DownTimeHistoryTimeItem
  • PUT Set DownTimeCost DownTimeHistoryTimeItem
  • PUT Set Currency DownTimeHistoryTimeItem
  • PUT Set TotalHoursSeconds DownTimeHistoryTimeItem
  • PUT Set Asset DownTimeHistoryTimeItem
  • PUT Set AssetType DownTimeHistoryTimeItem
• DELETE:
  • DELETE Down Time History Time Item by identifier
  • DELETE DownTimeHistoryTime by identifier
  • DELETE DownTimeHistoryTime by key

All Resources

This service uses the following resources:

• ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource
• ApiDownTimeHistoryTimeResource
• DownTimeHistoryTimeItemResource
• DownTimeHistoryTimeResource
• MoneyResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET DownTimeHistoryTimes (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 DownTimeHistoryTimeResource.

Response status codes:

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

Resource URL:

GET DownTimeHistoryTime 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 DownTimeHistoryTimeResource.

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 DownTimeHistoryTime by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
downTimeHistoryTimeKey	(string) Down Time History Time.

Response:

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

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:

POST Operations

POST DownTimeHistoryTimes

Creates a new entity record.

The following elements are required:

downTimeHistoryTimeResource

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

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 ApiDownTimeHistoryTimeResource.

Response status codes:

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

Resource URL:

POST Down Time History Time Item

Inserts a new 'Down Time History Time Item' in the 'Down Time History Time'.

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
companyKey	(string) The company key.
value	(ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource) The ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource instance. See ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource.

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 Build Down Time History Times From Work Order

Custom operation 'BuildDownTimeHistoryTimesFromWorkOrder'.

The following elements are required:

workOrderKey	(string) WorkOrderKey.
workOrderId	(Guid) WorkOrderId.

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 'DownTimeHistoryTimeResource'. See DownTimeHistoryTimeResource.

Resource URL:

PUT Operations

PUT Set Asset DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set AssetType DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set Company DownTimeHistoryTime

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set Currency DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set Description DownTimeHistoryTime

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set DownAndUpTimeHistory DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set DownTimeCost DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set DownTimeHistoryTimeKey DownTimeHistoryTime

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set EndDate DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set IsActive DownTimeHistoryTime

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set StartDate DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set TotalHours DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(TimeSpan) 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 Set TotalHoursSeconds DownTimeHistoryTimeItem

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) 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 Set WorlOrderId DownTimeHistoryTime

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

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 Set Custom Attribute DownTimeHistoryTime

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

The following elements are required:

companyKey	(string) The company key.
downTimeHistoryTimeKey	(string) Down Time History Time
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 Set Custom Attribute DownTimeHistoryTimeItem

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

The following elements are required:

companyKey	(string) The company key.
downTimeHistoryTimeKey	(string) Down Time History Time
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:

DELETE Operations

DELETE Down Time History Time Item by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
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 DownTimeHistoryTime 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 DownTimeHistoryTime by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
downTimeHistoryTimeKey	(string) Down Time History Time.

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:

Resources

ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource

The following elements are required:

downAndUpTimeHistory	(string) Down And Up Time History.
startDate	(DateTimeOffset) Start Date.
totalHours	(TimeSpan) Total Time.
downTimeCost	(MoneyResource) Total Cost. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

endDate	(DateTimeOffset) End Date.
totalHoursSeconds	(int) Total Hours Seconds.
asset	(string) Asset.
assetType	(string) Asset Type.

ApiDownTimeHistoryTimeResource

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
worlOrderId	(Guid) Worl Order Id.
company	(string) Company.

The following elements are optional:

description	(string) Description.
downTimeHistoryTimeItems	(List of ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource) Down Time History Time Items. See ApiDownTimeHistoryTimeDownTimeHistoryTimeItemsResource.

DownTimeHistoryTimeItemResource

The following elements are required:

downAndUpTimeHistory	(string) Down And Up Time History.
startDate	(DateTimeOffset) Start Date.
totalHours	(TimeSpan) Total Time.
downTimeCost	(MoneyResource) Total Cost. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

request	(string) Request.
endDate	(DateTimeOffset) End Date.
location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
totalHoursSeconds	(int) Total Hours Seconds.
asset	(string) Asset.
assetType	(string) Asset Type.

DownTimeHistoryTimeResource

The following elements are required:

downTimeHistoryTimeKey	(string) Down Time History Time.
worlOrderId	(Guid) Worl Order Id.
company	(string) Company.

The following elements are optional:

description	(string) Description.
downTimeHistoryTimeItems	(List of DownTimeHistoryTimeItemResource) Down Time History Time Items. See DownTimeHistoryTimeItemResource.

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.