Valuekeep Developers - Web API Reference

Business Core | Characteristic Type

Service to manage entities of type 'CharacteristicType'.

Overview


URL api/{tenantKey}/{orgKey}/businessCore/characteristicTypes
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 CharacteristicTypes (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 CharacteristicTypeResource.

Response status codes:

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

Resource URL:

GET /businessCore/characteristicTypes/odata

GET CharacteristicType 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 CharacteristicTypeResource.

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 /businessCore/characteristicTypes/{id}

GET CharacteristicType by key

Returns the entity record that matches the specified key.

The following elements are required:

characteristicTypeKey (string) Characteristic Type.

Response:

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

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 /businessCore/characteristicTypes/{characteristicTypeKey}

POST Operations

POST CharacteristicTypes

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /businessCore/characteristicTypes

PUT Operations

PUT Set CharacteristicTypeKey CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/characteristicTypeKey

PUT Set Description CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/description

PUT Set Equipment CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/equipment

PUT Set IsActive CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/isActive

PUT Set IsLocked CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/isLocked

PUT Set Location CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/location

PUT Set Meter CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/meter

PUT Set Monitoring CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/monitoring

PUT Set Remarks CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/remarks

PUT Set Tool CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
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 /businessCore/characteristicTypes/{characteristicTypeKey}/tool

PUT Set Custom Attribute CharacteristicType

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

The following elements are required:

characteristicTypeKey (string) Characteristic Type
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 /businessCore/characteristicTypes/{characteristicTypeKey}/{customAttributeName}

DELETE Operations

DELETE CharacteristicType 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 /businessCore/characteristicTypes/{id}

DELETE CharacteristicType by key

Deletes the entity record that matches the specified key.

The following elements are required:

characteristicTypeKey (string) Characteristic Type.

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 /businessCore/characteristicTypes/{characteristicTypeKey}

Resources


ApiCharacteristicTypeResource

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
description (string) Description.

The following elements are optional:

location (bool) Location.
equipment (bool) Equipment.
tool (bool) Tool.
meter (bool) Meter.
monitoring (bool) Monitoring.
remarks (string) Remarks.
isLocked (bool) Is Locked.


CharacteristicTypeResource

The following elements are required:

characteristicTypeKey (string) Characteristic Type.
description (string) Description.

The following elements are optional:

location (bool) Location.
equipment (bool) Equipment.
tool (bool) Tool.
meter (bool) Meter.
monitoring (bool) Monitoring.
remarks (string) Remarks.
isLocked (bool) Is Locked.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.