Business Core | Family

Service to manage entities of type 'Family'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Families (odata)
  • GET Family by identifier
  • GET Family by key
• POST:
  • POST Families
  • POST Family Characteristic
• PUT:
  • PUT Set Custom Attribute Family
  • PUT Set IsActive Family
  • PUT Set FamilyKey Family
  • PUT Set Description Family
  • PUT Set ExternalId Family
  • PUT Set ExternalVersion Family
  • PUT Set IsExternallyManaged Family
  • PUT Set Remarks Family
  • PUT Set ParentFamily Family
  • PUT Set FromApi Family
  • PUT Set Characteristic FamilyCharacteristic
  • PUT Set Value FamilyCharacteristic
  • PUT Set CharacteristicEnumValueId FamilyCharacteristic
  • PUT Set Unit FamilyCharacteristic
  • PUT Set CharacteristicValueType FamilyCharacteristic
  • PUT Set CharacteristicValueTypeValue FamilyCharacteristic
  • PUT Set CharacteristicEnumValue FamilyCharacteristic
• DELETE:
  • DELETE Family Characteristic by identifier
  • DELETE Family by identifier
  • DELETE Family by key

All Resources

This service uses the following resources:

• ApiFamilyFamilyCharacteristicsResource
• ApiFamilyResource
• FamilyResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET Families (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 FamilyResource.

Response status codes:

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

Resource URL:

GET Family 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 FamilyResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

familyKey

(string) The key for the part assortment.

Response:

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

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 Families

Creates a new entity record.

The following elements are required:

familyResource

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

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

Response status codes:

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

Resource URL:

POST Family Characteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
value	(ApiFamilyFamilyCharacteristicsResource) The ApiFamilyFamilyCharacteristicsResource instance. See ApiFamilyFamilyCharacteristicsResource.

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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 ExternalId Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 ExternalVersion Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyKey Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 IsExternallyManaged Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 ParentFamily Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 FamilyCharacteristic

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family

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

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family Characteristic by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

familyKey	(string) The key for the part assortment.
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 Family 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 Family by key

Deletes the entity record that matches the specified key.

The following elements are required:

familyKey

(string) The key for the part assortment.

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

ApiFamilyFamilyCharacteristicsResource

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.

ApiFamilyResource

The following elements are required:

familyKey	(string) The key for the part assortment.
description	(string) The description for the part assortment.
isExternallyManaged	(bool) A flag indicating if the part assortment is externally managed.
fromApi	(bool) From Api.

The following elements are optional:

externalId	(string) The part assortment's external identifier.
externalVersion	(string) The part assortment's external version.
remarks	(string) The remarks for the part assortment.
parentFamily	(string) Parent Family.
familyCharacteristics	(List of ApiFamilyFamilyCharacteristicsResource) Family Characteristics. See ApiFamilyFamilyCharacteristicsResource.

FamilyResource

The following elements are required:

familyKey	(string) The key for the part assortment.
description	(string) The description for the part assortment.
isExternallyManaged	(bool) A flag indicating if the part assortment is externally managed.
fromApi	(bool) From Api.

The following elements are optional:

externalId	(string) The part assortment's external identifier.
externalVersion	(string) The part assortment's external version.
remarks	(string) The remarks for the part assortment.
parentFamily	(string) Parent Family. (fk) Allowed value: the natural key of a record of type Family. These records are accessibly through the Families service.
familyCharacteristics	(List of FamilyCharacteristicResource) Family Characteristics. See FamilyCharacteristicResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.