Master Data Business Entities | Model
Service to manage entities of type 'BrandModel'. The classification of a type of product of a brand into a subcategory with specific shared characteristics.
Overview
URL | api/{tenantKey}/{orgKey}/businessCore/brandModels |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
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:
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:
GET BrandModel by key
Returns the entity record that matches the specified key.
The following elements are required:
modelKey | (string) The key for the item 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:
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. |
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:
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 item 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:
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 item 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:
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 item 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:
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 item 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:
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 item 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:
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 item 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:
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 item 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:
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 item 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:
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:
DELETE BrandModel by key
Deletes the entity record that matches the specified key.
The following elements are required:
modelKey | (string) The key for the item 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:
Resources
ApiBrandModelResource
The following elements are required:
modelKey | (string) The key for the item brand model. |
isExternallyManaged | (bool) A flag indicating if the item brand model is externally managed. |
brand | (string) The brand of the item brand model. |
The following elements are optional:
description | (string) The description for the item brand model. |
externalId | (string) The external identifier for the item brand model. |
externalVersion | (string) The external version for the item brand model. |
remarks | (string) The remarks for the item brand model. |
BrandModelResource
The following elements are required:
modelKey | (string) The key for the item brand model. |
isExternallyManaged | (bool) A flag indicating if the item brand model is externally managed. |
brand | (string) The brand of the item 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:
description | (string) The description for the item brand model. |
externalId | (string) The external identifier for the item brand model. |
externalVersion | (string) The external version for the item brand model. |
remarks | (string) The remarks for the item brand model. |