DesignAtomsService
These endpoints are used to manipulate Design Atoms models
ConvertColors
Converts colors
Request
POST /api/atoms/v1/colorConverter[?tenantId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| tenantId | query | Tenant identifier |
||
| body | body |
|
Convert colors operation parameters |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Success |
||
| 404 |
|
Not Found |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
LoadProduct
Loads product from design file taken from storage
If privateStorage is not set then special design search procedure activated. It tries to get specified design from public storage, and if design is not found then checks private storage
Request
GET /api/atoms/v1/designs/{id}/model[?privateStorage&privateStorageOwner&tenantId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *id | path | Design identifier |
||
| privateStorage | query | If set to 'true' design will be taken from private storage |
||
| privateStorageOwner | query | Private storage owner identifier |
||
| tenantId | query | Tenant identifier |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Success |
||
| 404 |
|
Not Found |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
SaveProduct
Saves product to design file and updates design in storage.
Design with specified identifier must exist at desired storage. If 'privateStorage' parameter is not set, then special design search procedure activated. It tries to find design with specified identifier in public storage, and if it is not there, then checks private storage If design found anywhere, it will be updated
Request
PUT /api/atoms/v1/designs/{id}/model[?privateStorage&privateStorageOwner&tenantId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *id | path | Design identifier |
||
| privateStorage | query | If set to 'true' design will be saved to private storage |
||
| privateStorageOwner | query | Private storage owner identifier |
||
| tenantId | query | Tenant identifier |
||
| body | body | Serialized product description |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Success |
||
| 401 | Unauthorized |
||
| 403 | Forbidden |
CreateItem
Creates product item
Request
POST /api/atoms/v1/itemCreator[?itemType&tenantId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| itemType | query | Desired item type |
||
| tenantId | query | Tenant identifier |
||
| sourceType | formData | Item source type |
||
| sourceId | formData | Item source id, used if source type is 'ImageStorage' or 'PrivateImageStorage' |
||
| sourceOwnerId | formData | Item source id, used if source type is 'PrivateImageStorage' |
||
| sourceFile | formData | Source file, used if source type is 'File' |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Success |
||
| 404 |
|
Not Found |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
Definitions
ConvertColorsModel
Convert colors operation parameters
| Name | Type | Notes |
|---|---|---|
| colors | array | Serialized color description |
| sourceColorProfile | string | Source color profile description |
| destinationColorProfile | string | Destination color profile description |
| targetDeviceColorProfile | string | Targent color profile description |
ProblemDetails
These endpoints are used to manipulate Design Atoms models
| Name | Type | Notes |
|---|---|---|
| type | string | |
| title | string | |
| status | integer (int32) | |
| detail | string | |
| instance | string |