Valuekeep Developers - Web API Reference

Assets | Parent Equipment Change

Service to manage entities of type 'ParentEquipmentChange'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET ParentEquipmentChanges (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 ParentEquipmentChangeResource.

Response status codes:

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

Resource URL:

GET /assetManagement/parentEquipmentChanges/odata

GET ParentEquipmentChange 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 ParentEquipmentChangeResource.

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 /assetManagement/parentEquipmentChanges/{id}

GET ParentEquipmentChange by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
parentEquipmentChangeKey (string) Parent Equipment Change.

Response:

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

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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}

POST Operations

POST ParentEquipmentChanges

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /assetManagement/parentEquipmentChanges

POST Equipment Meter

Inserts a new 'Equipment Meter' in the 'Parent Equipment Change'.

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
companyKey (string) The company key.
value (ApiParentEquipmentChangeEquipmentMetersResource) The ApiParentEquipmentChangeEquipmentMetersResource instance.
See ApiParentEquipmentChangeEquipmentMetersResource.

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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/equipmentMeters

PUT Operations

PUT Set Company ParentEquipmentChange

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

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/company

PUT Set EndDate ParentEquipmentChange

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

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/endDate

PUT Set IsActive ParentEquipmentChange

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

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/isActive

PUT Set ParentEquipmentChangeKey ParentEquipmentChange

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

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/parentEquipmentChangeKey

PUT Set Remarks ParentEquipmentChange

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

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/remarks

PUT Set Custom Attribute ParentEquipmentChange

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

The following elements are required:

companyKey (string) The company key.
parentEquipmentChangeKey (string) Parent Equipment Change
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/{customAttributeName}

DELETE Operations

DELETE Equipment Meter by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}/equipmentMeters/{lineId}

DELETE ParentEquipmentChange 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 /assetManagement/parentEquipmentChanges/{id}

DELETE ParentEquipmentChange by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
parentEquipmentChangeKey (string) Parent Equipment Change.

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 /assetManagement/parentEquipmentChanges/{companyKey}/{parentEquipmentChangeKey}

Resources


ApiParentEquipmentChangeEquipmentMetersResource

The following elements are required:

meter (string) Meter.

The following elements are optional:

targetMeter (string) Target Meter.


ApiParentEquipmentChangeResource

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
equipment (string) Equipment.
startDate (DateTimeOffset) Start Date.
company (string) Company.

The following elements are optional:

parentEquipment (string) Parent Equipment.
endDate (DateTimeOffset) End Date.
remarks (string) Remarks.
equipmentMeters (List of ApiParentEquipmentChangeEquipmentMetersResource) Equipment Meters.
See ApiParentEquipmentChangeEquipmentMetersResource.


ParentEquipmentChangeResource

The following elements are required:

parentEquipmentChangeKey (string) Parent Equipment Change.
equipment (string) Equipment.
(fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
startDate (DateTimeOffset) Start Date.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

parentEquipment (string) Parent Equipment.
(fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
endDate (DateTimeOffset) End Date.
remarks (string) Remarks.
equipmentMeters (List of EquipmentMeterResource) Equipment Meters.
See EquipmentMeterResource.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.