Business Core | Characteristic

Service to manage entities of type 'Characteristic'.

Overview

api/{tenantKey}/{orgKey}/businessCore/characteristics

URL	api/{tenantKey}/{orgKey}/businessCore/characteristics
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Characteristics
- POST CharacteristicEnumerationValue
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiCharacteristicCharacteristicEnumerationValuesResource
ApiCharacteristicResource
CharacteristicResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

CharacteristicValueType

GET Operations

GET Characteristics (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 CharacteristicResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/characteristics/odata

GET /businessCore/characteristics/odata

GET Characteristic 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 CharacteristicResource.

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

GET /businessCore/characteristics/{id}

GET Characteristic by key

Returns the entity record that matches the specified key.

The following elements are required:

characteristicKey

(string) Characteristic.

Response:

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

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}/businessCore/characteristics/{characteristicKey}

GET /businessCore/characteristics/{characteristicKey}

POST Operations

POST Characteristics

Creates a new entity record.

The following elements are required:

characteristicResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/characteristics

POST /businessCore/characteristics

POST CharacteristicEnumerationValue

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

The following elements are required:

characteristicKey	(string) Characteristic.
value	(ApiCharacteristicCharacteristicEnumerationValuesResource) The ApiCharacteristicCharacteristicEnumerationValuesResource instance. See ApiCharacteristicCharacteristicEnumerationValuesResource.

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}/businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues

POST /businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues

PUT Operations

PUT Set CharacteristicKey Characteristic

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

The following elements are required:

characteristicKey	(string) Characteristic.
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}/businessCore/characteristics/{characteristicKey}/characteristicKey

PUT /businessCore/characteristics/{characteristicKey}/characteristicKey

PUT Set Description Characteristic

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

The following elements are required:

characteristicKey	(string) Characteristic.
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}/businessCore/characteristics/{characteristicKey}/description

PUT /businessCore/characteristics/{characteristicKey}/description

PUT Set IsActive Characteristic

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

The following elements are required:

characteristicKey	(string) Characteristic.
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}/businessCore/characteristics/{characteristicKey}/isActive

PUT /businessCore/characteristics/{characteristicKey}/isActive

PUT Set Name CharacteristicEnumerationValue

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

The following elements are required:

characteristicKey	(string) Characteristic.
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:

api/{tenantKey}/{orgKey}/businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues/{lineId}/name

PUT /businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues/{lineId}/name

PUT Set Remarks Characteristic

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

The following elements are required:

characteristicKey	(string) Characteristic.
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}/businessCore/characteristics/{characteristicKey}/remarks

PUT /businessCore/characteristics/{characteristicKey}/remarks

PUT Set Value CharacteristicEnumerationValue

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

The following elements are required:

characteristicKey	(string) Characteristic.
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:

api/{tenantKey}/{orgKey}/businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues/{lineId}/value

PUT /businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues/{lineId}/value

PUT Set Custom Attribute Characteristic

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

The following elements are required:

characteristicKey	(string) Characteristic
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}/businessCore/characteristics/{characteristicKey}/{customAttributeName}

PUT /businessCore/characteristics/{characteristicKey}/{customAttributeName}

DELETE Operations

DELETE CharacteristicEnumerationValue by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

characteristicKey	(string) Characteristic.
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}/businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues/{lineId}

DELETE /businessCore/characteristics/{characteristicKey}/characteristicEnumerationValues/{lineId}

DELETE Characteristic 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}/businessCore/characteristics/{id}

DELETE /businessCore/characteristics/{id}

DELETE Characteristic by key

Deletes the entity record that matches the specified key.

The following elements are required:

characteristicKey

(string) Characteristic.

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}/businessCore/characteristics/{characteristicKey}

DELETE /businessCore/characteristics/{characteristicKey}

Resources

ApiCharacteristicCharacteristicEnumerationValuesResource

The following elements are optional:

value	(int) ValueId.
name	(string) Value.

ApiCharacteristicResource

The following elements are required:

characteristicKey	(string) Characteristic.
description	(string) Description.
characteristicType	(string) Characteristic Type.
characteristicValueType	(enum CharacteristicValueType) Value Type. See CharacteristicValueType.

The following elements are optional:

unit	(string) Unit.
characteristicEnumerationValues	(List of ApiCharacteristicCharacteristicEnumerationValuesResource) Characteristic Enumeration Values. See ApiCharacteristicCharacteristicEnumerationValuesResource.
remarks	(string) Remarks.

CharacteristicResource

The following elements are required:

characteristicKey	(string) Characteristic.
description	(string) Description.
characteristicType	(string) Characteristic Type. (fk) Allowed value: the natural key of a record of type CharacteristicType. These records are accessibly through the CharacteristicTypes service.
characteristicValueType	(enum CharacteristicValueType) Value Type. See CharacteristicValueType.

The following elements are optional:

unit	(string) Unit. (fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service.
characteristicEnumerationValues	(List of CharacteristicEnumerationValueResource) Characteristic Enumeration Values. See CharacteristicEnumerationValueResource.
remarks	(string) Remarks.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

CharacteristicValueType

1	Number
2	Text
3	DateTime
4	Boolean
5	Enumerated