Assets | Parent Location Change
Service to manage entities of type 'LocationParentLocationHistory'.
Overview
| URL | api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute LocationParentLocationHistory
- PUT Set Custom Attribute LocationMeterHistory
- PUT Set IsActive LocationParentLocationHistory
- PUT Set LocationParentLocationHistoryKey LocationParentLocationHistory
- PUT Set EndDate LocationParentLocationHistory
- PUT Set Remarks LocationParentLocationHistory
- PUT Set Company LocationParentLocationHistory
- DELETE:
All Resources
This service uses the following resources:
GET LocationParentLocationHistories (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 LocationParentLocationHistoryResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/odata
GET /assetManagement/locationParentLocationHistories/odata
GET LocationParentLocationHistory 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 LocationParentLocationHistoryResource. |
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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{id}
GET /assetManagement/locationParentLocationHistories/{id}
GET LocationParentLocationHistory by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| locationParentLocationHistoryKey | (string) Parent Location Change. |
Response:
| When successful, the response body contains the entity record. See LocationParentLocationHistoryResource. |
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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}
GET /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}
POST LocationParentLocationHistories
Creates a new entity record.
The following elements are required:
| locationParentLocationHistoryResource | (ApiLocationParentLocationHistoryResource) The request body should contain the entity record that should be created. See ApiLocationParentLocationHistoryResource. |
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 ApiLocationParentLocationHistoryResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories
POST /assetManagement/locationParentLocationHistories
POST Location Meter History
Inserts a new 'Location Meter History' in the 'Location Parent Location History'.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location Change. |
| companyKey | (string) The company key. |
| value | (ApiLocationParentLocationHistoryMeterHistoriesResource) The ApiLocationParentLocationHistoryMeterHistoriesResource instance. See ApiLocationParentLocationHistoryMeterHistoriesResource. |
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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/meterHistories
POST /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/meterHistories
PUT Set Company LocationParentLocationHistory
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/company
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/company
PUT Set EndDate LocationParentLocationHistory
Updates the value of attribute 'EndDate' in the specified entity record.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/endDate
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/endDate
PUT Set IsActive LocationParentLocationHistory
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/isActive
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/isActive
PUT Set LocationParentLocationHistoryKey LocationParentLocationHistory
Updates the value of attribute 'LocationParentLocationHistoryKey' in the specified entity record.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/locationParentLocationHistoryKey
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/locationParentLocationHistoryKey
PUT Set Remarks LocationParentLocationHistory
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/remarks
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/remarks
PUT Set Custom Attribute LocationParentLocationHistory
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/{customAttributeName}
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/{customAttributeName}
PUT Set Custom Attribute LocationMeterHistory
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| locationParentLocationHistoryKey | (string) Parent Location Change |
| 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/meterHistories/{lineId}/{customAttributeName}
PUT /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/meterHistories/{lineId}/{customAttributeName}
DELETE Location Meter History by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/meterHistories/{lineId}
DELETE /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}/meterHistories/{lineId}
DELETE LocationParentLocationHistory 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{id}
DELETE /assetManagement/locationParentLocationHistories/{id}
DELETE LocationParentLocationHistory by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| locationParentLocationHistoryKey | (string) Parent Location 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:
api/{tenantKey}/{orgKey}/assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}
DELETE /assetManagement/locationParentLocationHistories/{companyKey}/{locationParentLocationHistoryKey}
Resources
ApiLocationParentLocationHistoryMeterHistoriesResource
The following elements are required:
| meter | (string) Meter. |
The following elements are optional:
| parentMeter | (string) Parent Meter. |
| targetMeter | (string) Target Meter. |
ApiLocationParentLocationHistoryResource
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location Change. |
| location | (string) Location. |
| parentLocation | (string) New Parent Location. |
| startDate | (DateTimeOffset) Start Date. |
| company | (string) Company. |
The following elements are optional:
| endDate | (DateTimeOffset) End Date. |
| remarks | (string) Remarks. |
| meterHistories | (List of ApiLocationParentLocationHistoryMeterHistoriesResource) Meter Histories.
See ApiLocationParentLocationHistoryMeterHistoriesResource. |
LocationParentLocationHistoryResource
The following elements are required:
| locationParentLocationHistoryKey | (string) Parent Location Change. |
| location | (string) Location.
(fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service. |
| parentLocation | (string) New Parent Location.
(fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations 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:
| endDate | (DateTimeOffset) End Date. |
| remarks | (string) Remarks. |
| meterHistories | (List of LocationMeterHistoryResource) Meter Histories.
See LocationMeterHistoryResource. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |