Business Core | Brand
Service to manage entities of type 'Brand'.
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/brands |
| 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 Brands (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 BrandResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Brand 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 BrandResource. |
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 Brand by key
Returns the entity record that matches the specified key.
The following elements are required:
| brandKey | (string) The key for the part brand. |
Response:
| When successful, the response body contains the entity record. See BrandResource. |
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 Brand 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:
POST Brands
Creates a new entity record.
The following elements are required:
| brandResource | (ApiBrandResource) The request body should contain the entity record that should be created. See ApiBrandResource. |
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 ApiBrandResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BrandKey Brand
Updates the value of attribute 'BrandKey' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Picture Brand
Updates the value of attribute 'Picture' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| brandKey | (string) The key for the part brand. |
| 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 Brand 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 Brand by key
Deletes the entity record that matches the specified key.
The following elements are required:
| brandKey | (string) The key for the part brand. |
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
ApiBrandResource
The following elements are required:
| brandKey | (string) The key for the part brand. |
| description | (string) The description for the part brand. |
| isExternallyManaged | (bool) A flag indicating if the part brand is externally managed. |
The following elements are optional:
| externalId | (string) The external identifier for the part brand. |
| externalVersion | (string) The external version for the part brand. |
| picture | (string) The picture for the part brand. |
| remarks | (string) The remarks for the part brand. |
BrandResource
The following elements are required:
| brandKey | (string) The key for the part brand. |
| description | (string) The description for the part brand. |
| isExternallyManaged | (bool) A flag indicating if the part brand is externally managed. |
The following elements are optional:
| externalId | (string) The external identifier for the part brand. |
| externalVersion | (string) The external version for the part brand. |
| picture | (string) The picture for the part brand. |
| remarks | (string) The remarks for the part brand. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |