Assets | Location

Service to manage entities of type 'Location'.

Overview

api/{tenantKey}/{orgKey}/assetManagementCore/locations

URL	api/{tenantKey}/{orgKey}/assetManagementCore/locations
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiLocationLocationCharacteristicsResource
ApiLocationLocationPartResource
ApiLocationResource
LocationMaintenanceNotificationTemplateParameter
LocationResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET Locations (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 LocationResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/odata

GET /assetManagementCore/locations/odata

GET Location 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 LocationResource.

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}/assetManagementCore/locations/{id}

GET /assetManagementCore/locations/{id}

GET Location by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
locationKey	(string) Location.

Response:

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

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}/assetManagementCore/locations/{companyKey}/{locationKey}

GET /assetManagementCore/locations/{companyKey}/{locationKey}

GET Location Picture.

Returns the value of attribute 'Picture' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image file.

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}/assetManagementCore/locations/{id}/picture

GET /assetManagementCore/locations/{id}/picture

GET Get Maintenance Notification Template Parameters

Custom operation 'GetMaintenanceNotificationTemplateParameters'.

The following elements are required:

companyKey	(string) CompanyKey.
locationKey	(string) LocationKey.
cultureKey	(string) CultureKey.

Response:

When successful, the response body contains a list of resources of type 'LocationMaintenanceNotificationTemplateParameter'. See LocationMaintenanceNotificationTemplateParameter.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/getMaintenanceNotificationTemplateParameters/{companyKey}/{locationKey}

GET /assetManagementCore/locations/getMaintenanceNotificationTemplateParameters/{companyKey}/{locationKey}

POST Operations

POST Locations

Creates a new entity record.

The following elements are required:

locationResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations

POST /assetManagementCore/locations

POST Add Routes by keys

Adds the specified 'Routes' to the 'Location' (by specifying its keys).

The following elements are required:

locationKey	(string) Location.
value	(Array of string) A list of record keys to be added.

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:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{locationKey}/routes/add

POST /assetManagementCore/locations/{locationKey}/routes/add

POST Add Routes by identifiers

Adds the specified 'Routes' to the 'Location' (by specifying its identifiers).

The following elements are required:

locationKey	(string) Location.
value	(Array of string) A list of record identifiers to be added.

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:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{locationKey}/routes/addById

POST /assetManagementCore/locations/{locationKey}/routes/addById

POST Remove Routes by keys

Removes the specified 'Routes' to the 'Location' (by specifying its keys).

The following elements are required:

locationKey	(string) Location.
value	(Array of string) A list of record keys to be removed.

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:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{locationKey}/routes/remove

POST /assetManagementCore/locations/{locationKey}/routes/remove

POST Remove Routes by identifiers

Removes the specified 'Routes' to the 'Location' (by specifying its identifiers).

The following elements are required:

locationKey	(string) Location.
value	(Array of string) A list of record identifiers to be removed.

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:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{locationKey}/routes/removeById

POST /assetManagementCore/locations/{locationKey}/routes/removeById

POST Location Characteristic

Inserts a new 'Location Characteristic' in the 'Location'.

The following elements are required:

locationKey	(string) Location.
companyKey	(string) The company key.
value	(ApiLocationLocationCharacteristicsResource) The ApiLocationLocationCharacteristicsResource instance. See ApiLocationLocationCharacteristicsResource.

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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics

POST /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics

POST Location Part

Inserts a new 'Location Part' in the 'Location'.

The following elements are required:

locationKey	(string) Location.
companyKey	(string) The company key.
value	(ApiLocationLocationPartResource) The ApiLocationLocationPartResource instance. See ApiLocationLocationPartResource.

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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationPart

POST /assetManagementCore/locations/{companyKey}/{locationKey}/locationPart

PUT Operations

PUT Set Barcode Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/barcode

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/barcode

PUT Set BuildingNumber Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/buildingNumber

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/buildingNumber

PUT Set Characteristic LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristic

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristic

PUT Set CharacteristicEnumValue LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicEnumValue

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicEnumValue

PUT Set CharacteristicEnumValueId LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicEnumValueId

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicEnumValueId

PUT Set CharacteristicValueType LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicValueType

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicValueType

PUT Set CharacteristicValueTypeValue LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicValueTypeValue

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/characteristicValueTypeValue

PUT Set CityName Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/cityName

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/cityName

PUT Set Company Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/company

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/company

PUT Set Country Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/country

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/country

PUT Set Criticality Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/criticality

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/criticality

PUT Set Customer Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/customer

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/customer

PUT Set Description Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/description

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/description

PUT Set ExternalReferenceID Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/externalReferenceID

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/externalReferenceID

PUT Set FromApi Location

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/fromApi

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/fromApi

PUT Set IsActive Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/isActive

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/isActive

PUT Set IsDisposed Location

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/isDisposed

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/isDisposed

PUT Set IsUpTime Location

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/isUpTime

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/isUpTime

PUT Set Keyword Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/keyword

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/keyword

PUT Set Latitud Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/latitud

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/latitud

PUT Set LocationFunction Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationFunction

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationFunction

PUT Set LocationKey Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationKey

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationKey

PUT Set Longitud Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/longitud

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/longitud

PUT Set Mobile Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/mobile

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/mobile

PUT Set OnServiceDate Location

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/onServiceDate

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/onServiceDate

PUT Set ParentLocation Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/parentLocation

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/parentLocation

PUT Set Part LocationPart

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/part

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/part

PUT Set Picture Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/picture

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/picture

PUT Set PostalZone Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/postalZone

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/postalZone

PUT Set Quantity LocationPart

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/quantity

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/quantity

PUT Set Remarks Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/remarks

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/remarks

PUT Set Remarks LocationPart

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/remarks

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/remarks

PUT Set Responsible Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/responsible

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/responsible

PUT Set Routes Location

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

The following elements are required:

locationKey	(string) Location.
companyKey	(string) The company key.
value	(Route) 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}/assetManagementCore/locations/{companyKey}/{locationKey}/routes

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/routes

PUT Set StreetName Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/streetName

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/streetName

PUT Set Supplier Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/supplier

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/supplier

PUT Set Telephone Location

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

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/telephone

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/telephone

PUT Set Unit LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/unit

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/unit

PUT Set Value LocationCharacteristic

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

The following elements are required:

locationKey	(string) Location.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/value

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}/value

PUT Set Custom Attribute Location

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

The following elements are required:

companyKey	(string) The company key.
locationKey	(string) Location
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}/assetManagementCore/locations/{companyKey}/{locationKey}/{customAttributeName}

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/{customAttributeName}

PUT Set Custom Attribute LocationPart

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

The following elements are required:

companyKey	(string) The company key.
locationKey	(string) Location
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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/{customAttributeName}

PUT /assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}/{customAttributeName}

DELETE Operations

DELETE Location Characteristic by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}

DELETE /assetManagementCore/locations/{companyKey}/{locationKey}/locationCharacteristics/{lineId}

DELETE Location Part by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

locationKey	(string) Location.
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}/assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}

DELETE /assetManagementCore/locations/{companyKey}/{locationKey}/locationPart/{lineId}

DELETE Location 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}/assetManagementCore/locations/{id}

DELETE /assetManagementCore/locations/{id}

DELETE Location by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
locationKey	(string) Location.

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}/assetManagementCore/locations/{companyKey}/{locationKey}

DELETE /assetManagementCore/locations/{companyKey}/{locationKey}

Resources

ApiLocationLocationCharacteristicsResource

The following elements are required:

characteristic

(string) Characteristic.

The following elements are optional:

value	(string) Value.
characteristicEnumValueId	(Guid) Characteristic Enum Value Id.
unit	(string) Unit.
characteristicValueType	(string) Value Type.
characteristicValueTypeValue	(int) Characteristic Value Type Value.
characteristicEnumValue	(int) Enum Value.

ApiLocationLocationPartResource

The following elements are required:

part	(string) Part.
quantity	(decimal) Quantity.

The following elements are optional:

remarks

(string) Remarks.

ApiLocationResource

The following elements are required:

locationKey	(string) Location.
description	(string) Description.
company	(string) Company.
isDisposed	(bool) Is Disposed.
fromApi	(bool) From Api.

The following elements are optional:

onServiceDate	(DateTime) On Service.
picture	(string) Picture.
remarks	(string) Remarks.
keyword	(string) Keyword.
barcode	(string) Tag.
externalReferenceID	(string) External Reference.
streetName	(string) Street Name.
buildingNumber	(string) Building Number.
postalZone	(string) Postal Zone.
cityName	(string) City Name.
telephone	(string) Telephone.
mobile	(string) Mobile.
latitud	(string) Latitude.
longitud	(string) Longitude.
criticality	(string) Criticality.
locationFunction	(string) Location Function.
parentLocation	(string) Parent Location.
country	(string) Country.
routes	(Route) Routes.
isUpTime	(bool) Is Available.
responsible	(string) Responsible.
customer	(string) Customer.
supplier	(string) Supplier.
locationCharacteristics	(List of ApiLocationLocationCharacteristicsResource) Location Characteristics. See ApiLocationLocationCharacteristicsResource.
locationPart	(List of ApiLocationLocationPartResource) Location Part. See ApiLocationLocationPartResource.

LocationMaintenanceNotificationTemplateParameter

The following elements are required:

name	(string) Name.

The following elements are optional:

value

(string) Value.

LocationResource

The following elements are required:

locationKey	(string) Location.
description	(string) Description.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
isDisposed	(bool) Is Disposed.
fromApi	(bool) From Api.

The following elements are optional:

onServiceDate	(DateTime) On Service.
picture	(string) Picture.
remarks	(string) Remarks.
keyword	(string) Keyword.
barcode	(string) Tag.
externalReferenceID	(string) External Reference.
streetName	(string) Street Name.
buildingNumber	(string) Building Number.
postalZone	(string) Postal Zone.
cityName	(string) City Name.
telephone	(string) Telephone.
mobile	(string) Mobile.
latitud	(string) Latitude.
longitud	(string) Longitude.
criticality	(string) Criticality. (fk) Allowed value: the natural key of a record of type Criticality. These records are accessibly through the Criticalities service.
locationFunction	(string) Location Function. (fk) Allowed value: the natural key of a record of type LocationFunction. These records are accessibly through the LocationFunctions service.
parentLocation	(string) Parent Location. (fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
country	(string) Country. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
routes	(Route) Routes.
isUpTime	(bool) Is Available.
responsible	(string) Responsible. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
customer	(string) Customer. (fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties service.
supplier	(string) Supplier. (fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties service.
locationCharacteristics	(List of LocationCharacteristicResource) Location Characteristics. See LocationCharacteristicResource.
locationPart	(List of LocationPartResource) Location Part. See LocationPartResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.