Business Core | Model

Service to manage entities of type 'BrandModel'.

Overview

api/{tenantKey}/{orgKey}/businessCore/brandModels

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

All Operations

This service includes the following operations:

GET:
POST:
- POST BrandModels
PUT:
DELETE:
- DELETE BrandModel by identifier
- DELETE BrandModel by key

All Resources

This service uses the following resources:

ApiBrandModelResource
BrandModelResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET BrandModels (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 BrandModelResource.

Response status codes:

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

Resource URL:

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

GET /businessCore/brandModels/odata

GET BrandModel 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 BrandModelResource.

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

GET /businessCore/brandModels/{id}

GET BrandModel by key

Returns the entity record that matches the specified key.

The following elements are required:

modelKey

(string) The key for the part brand model.

Response:

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

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/brandModels/{modelKey}

GET /businessCore/brandModels/{modelKey}

GET Model 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}/businessCore/brandModels/{id}/picture

GET /businessCore/brandModels/{id}/picture

POST Operations

POST BrandModels

Creates a new entity record.

The following elements are required:

brandModelResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/brandModels

POST /businessCore/brandModels

PUT Operations

PUT Set Brand BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/brand

PUT /businessCore/brandModels/{modelKey}/brand

PUT Set Description BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/description

PUT /businessCore/brandModels/{modelKey}/description

PUT Set ExternalId BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/externalId

PUT /businessCore/brandModels/{modelKey}/externalId

PUT Set ExternalVersion BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/externalVersion

PUT /businessCore/brandModels/{modelKey}/externalVersion

PUT Set IsActive BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/isActive

PUT /businessCore/brandModels/{modelKey}/isActive

PUT Set IsExternallyManaged BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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}/businessCore/brandModels/{modelKey}/isExternallyManaged

PUT /businessCore/brandModels/{modelKey}/isExternallyManaged

PUT Set ModelKey BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/modelKey

PUT /businessCore/brandModels/{modelKey}/modelKey

PUT Set Picture BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/picture

PUT /businessCore/brandModels/{modelKey}/picture

PUT Set Remarks BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/remarks

PUT /businessCore/brandModels/{modelKey}/remarks

PUT Set Custom Attribute BrandModel

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

The following elements are required:

modelKey	(string) The key for the part brand model.
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/brandModels/{modelKey}/{customAttributeName}

PUT /businessCore/brandModels/{modelKey}/{customAttributeName}

DELETE Operations

DELETE BrandModel 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/brandModels/{id}

DELETE /businessCore/brandModels/{id}

DELETE BrandModel by key

Deletes the entity record that matches the specified key.

The following elements are required:

modelKey

(string) The key for the part brand model.

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/brandModels/{modelKey}

DELETE /businessCore/brandModels/{modelKey}

Resources

ApiBrandModelResource

The following elements are required:

modelKey	(string) The key for the part brand model.
description	(string) The description for the part brand model.
isExternallyManaged	(bool) A flag indicating if the part brand model is externally managed.
brand	(string) The brand of the part brand model.

The following elements are optional:

externalId	(string) The external identifier for the part brand model.
externalVersion	(string) The external version for the part brand model.
picture	(string) The picture for the part model.
remarks	(string) The remarks for the part brand model.

BrandModelResource

The following elements are required:

modelKey	(string) The key for the part brand model.
description	(string) The description for the part brand model.
isExternallyManaged	(bool) A flag indicating if the part brand model is externally managed.
brand	(string) The brand of the part brand model. (fk) Allowed value: the natural key of a record of type Brand. These records are accessibly through the Brands service.

The following elements are optional:

externalId	(string) The external identifier for the part brand model.
externalVersion	(string) The external version for the part brand model.
picture	(string) The picture for the part model.
remarks	(string) The remarks for the part brand model.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.