Assets | Location Function

Service to manage entities of type 'LocationFunction'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET LocationFunctions (odata)
  • GET LocationFunction by identifier
  • GET LocationFunction by key
• POST:
  • POST LocationFunctions
  • POST Location Function Family
  • POST LocationFunctionCharacteristic
• PUT:
  • PUT Set Custom Attribute LocationFunction
  • PUT Set Custom Attribute LocationFunctionFamily
  • PUT Set IsActive LocationFunction
  • PUT Set LocationFunctionKey LocationFunction
  • PUT Set Description LocationFunction
  • PUT Set Remarks LocationFunction
  • PUT Set ParentLocationFunction LocationFunction
  • PUT Set FromApi LocationFunction
  • PUT Set Family LocationFunctionFamily
  • PUT Set Characteristic LocationFunctionCharacteristic
  • PUT Set Value LocationFunctionCharacteristic
  • PUT Set CharacteristicEnumValueId LocationFunctionCharacteristic
  • PUT Set Unit LocationFunctionCharacteristic
  • PUT Set CharacteristicValueType LocationFunctionCharacteristic
  • PUT Set CharacteristicValueTypeValue LocationFunctionCharacteristic
  • PUT Set CharacteristicEnumValue LocationFunctionCharacteristic
• DELETE:
  • DELETE Location Function Family by identifier
  • DELETE LocationFunctionCharacteristic by identifier
  • DELETE LocationFunction by identifier
  • DELETE LocationFunction by key

All Resources

This service uses the following resources:

• ApiLocationFunctionLocationFunctionCharacteristicsResource
• ApiLocationFunctionLocationFunctionFamiliesResource
• ApiLocationFunctionResource
• LocationFunctionResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET LocationFunctions (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 LocationFunctionResource.

Response status codes:

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

Resource URL:

GET LocationFunction 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 LocationFunctionResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

locationFunctionKey

(string) Location Function.

Response:

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

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 LocationFunctions

Creates a new entity record.

The following elements are required:

locationFunctionResource

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

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

Response status codes:

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

Resource URL:

POST Location Function Family

Inserts a new 'Location Function Family' in the 'Location Function'.

The following elements are required:

locationFunctionKey	(string) Location Function.
value	(ApiLocationFunctionLocationFunctionFamiliesResource) The ApiLocationFunctionLocationFunctionFamiliesResource instance. See ApiLocationFunctionLocationFunctionFamiliesResource.

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 LocationFunctionCharacteristic

Inserts a new 'LocationFunctionCharacteristic' in the 'Location Function'.

The following elements are required:

locationFunctionKey	(string) Location Function.
value	(ApiLocationFunctionLocationFunctionCharacteristicsResource) The ApiLocationFunctionLocationFunctionCharacteristicsResource instance. See ApiLocationFunctionLocationFunctionCharacteristicsResource.

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:

PUT Operations

PUT Set Characteristic LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 CharacteristicEnumValue LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 CharacteristicEnumValueId LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 CharacteristicValueType LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 CharacteristicValueTypeValue LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 Description LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function.
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 Family LocationFunctionFamily

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 FromApi LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set IsActive LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function.
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 LocationFunctionKey LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function.
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 ParentLocationFunction LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function.
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 Remarks LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function.
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 Unit LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 Value LocationFunctionCharacteristic

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

The following elements are required:

locationFunctionKey	(string) Location Function.
lineId	(string) The detail identifier.
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 Custom Attribute LocationFunction

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

The following elements are required:

locationFunctionKey	(string) Location Function
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 LocationFunctionFamily

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

The following elements are required:

locationFunctionKey	(string) Location Function
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 Location Function Family by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

locationFunctionKey	(string) Location Function.
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 LocationFunctionCharacteristic by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

locationFunctionKey	(string) Location Function.
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 LocationFunction 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 LocationFunction by key

Deletes the entity record that matches the specified key.

The following elements are required:

locationFunctionKey

(string) Location Function.

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

ApiLocationFunctionLocationFunctionCharacteristicsResource

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.

ApiLocationFunctionLocationFunctionFamiliesResource

The following elements are optional:

family

(string) Family.

ApiLocationFunctionResource

The following elements are required:

locationFunctionKey	(string) Location Function.
description	(string) Description.
fromApi	(bool) From Api.

The following elements are optional:

remarks	(string) Remarks.
parentLocationFunction	(string) Parent Location Function.
locationFunctionFamilies	(List of ApiLocationFunctionLocationFunctionFamiliesResource) AssetFamilies. See ApiLocationFunctionLocationFunctionFamiliesResource.
locationFunctionCharacteristics	(List of ApiLocationFunctionLocationFunctionCharacteristicsResource) Location Function Characteristics. See ApiLocationFunctionLocationFunctionCharacteristicsResource.

LocationFunctionResource

The following elements are required:

locationFunctionKey	(string) Location Function.
description	(string) Description.
fromApi	(bool) From Api.

The following elements are optional:

remarks	(string) Remarks.
parentLocationFunction	(string) Parent Location Function. (fk) Allowed value: the natural key of a record of type LocationFunction. These records are accessibly through the LocationFunctions service.
locationFunctionFamilies	(List of LocationFunctionFamilyResource) AssetFamilies. See LocationFunctionFamilyResource.
locationFunctionCharacteristics	(List of LocationFunctionCharacteristicResource) Location Function Characteristics. See LocationFunctionCharacteristicResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.