DesignAtoms API

Use this API when you are working with Design Atoms SDK to build your own editor interface.

To learn more about Design Atoms, refer to the Design Atoms documentation.

Interactive API Docs

Api Clients

.Net Client

You can install it from Nuget as follows:

Install-Package Aurigma.DesignAtomsApi.ApiClient

See on Nuget

Angular Client

This client is compatible with Angular applications only. It won't work with NodeJS or other frontend JS frameworks. You can install the package to your Angular application as follows:

npm install @aurigma/ng-design-atoms-api-client

See on npm

NodeJS Client (Axious)

This client can be used in a wide range of JavaScript applications. To make API calls, it uses Axios - a popular HTTP library. Although it is possible to use it in both frontend and backend projects, the primary target platform for this library is NodeJS.

Install the package as follows:

npm install @aurigma/axios-design-atoms-api-client

See on npm

PHP Client

PHP client can be installed through composer as follows:

composer require aurigma/php-design-atoms-client

See on Packagist

BuildInfo

These endpoints can be used to get the technical information about the service such as version, build date and similar. They are also useful for a quick test whether the service is available. All of them are working in the same way and return the same information - use the HEAD or GET flavor of this endpoint based on your preference.

HeadInfo

Get assembly build info.

Request

HEAD /api/atoms/v1/info

Responses

Status Code	Type	Description	Samples
200		Success
Headers
X-Aurigma-Version	string	A version number
X-Aurigma-Build-Date	string	A build date (UTC)
X-Aurigma-Configuration	string	A build configuration (Debug | Release)
X-Aurigma-App-Name	string	A service name
X-Aurigma-Design-Atoms-Version	string	An Aurigma.DesignAtoms version number
X-Aurigma-Design-Atoms-Model-Version	string	An Aurigma.DesignAtoms.Model version number

GetInfo

Get assembly build info.

Request

GET /api/atoms/v1/info

Responses

Status Code	Type	Description	Samples
200	BuildInfoModel	Success

DesignAtomsCompatibility

These endpoints are used in compatibility purposes

CssFonts

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/cssfonts

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	FontsMethodData

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden

Fonts

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/fonts/{psName}

Parameters

Name	In	Type	Default	Notes
*tenantId	path
*psName	path

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetColorPreview

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetColorPreview

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetColorPreviewRequest

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
401		Unauthorized
403		Forbidden

GetColorPreviews

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetColorPreviews

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetColorPreviewsRequest

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
401		Unauthorized
403		Forbidden

GetCssFont

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetCssFont[?fontKey]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
fontKey	query

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetFallbackFonts

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetFallbackFonts

Parameters

Name	In	Type	Default	Notes
*tenantId	path

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

GetImageSize

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetImageSize

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetImageSizeRequest

Responses

Status Code	Type	Description	Samples
200	NullAbleSize	Success
401		Unauthorized
403		Forbidden

GetShapeBounds

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetShapeBounds

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetShapeBoundsRequest

Responses

Status Code	Type	Description	Samples
200	RectangleF	Success
401		Unauthorized
403		Forbidden

GetWatermarkItems

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetWatermarkItems

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

Img

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/img[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetLicense

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/license

Parameters

Name	In	Type	Default	Notes
*tenantId	path

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

Pth

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/pth[?f]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Resource

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/resource[?image]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
image	query

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Svg

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/svg[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Txt

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/txt[?f]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

UpdateArchedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateArchedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateAutoScaledTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateAutoScaledTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateBarcodeItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBarcodeItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateBoundedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBoundedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateByColorData

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByColorData

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateColorsRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateByMultiCallRequest

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByMultiCallRequest

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	MultiCallRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateCurvedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateCurvedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateImageItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateImageItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateImageHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdatePathBoundedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePathBoundedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdatePlainTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePlainTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateShapeItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateShapeItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

DesignAtomsImages

These endpoints are used to manipulate images via Design Atoms.

RenderImagePreview

Renders a preview of an image with the specified parameters.

Request

POST /api/atoms/v1/images/render-preview[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderImagePreviewModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RenderImagePreviewFromFile

Renders a preview of an uploaded image with the specified parameters.

Request

POST /api/atoms/v1/images/render-preview/from-file[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
sourceFile	formData			Source file.
mockupOwnerId	formData			Mockup owner identifier.
mockupId	formData			Mockup identifier.
width	formData			Image preview width.
height	formData			Image preview height.
fileFormat	formData			Image preview file format.
fitMode	formData			Image preview fit mode.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RenderImagePreviewFromFileToResource

Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/images/render-preview/from-file/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
resourceOwnerId	formData			Preview resource owner identifier.
resourceNamespace	formData			Preview resource namespace.
resourceName	formData			Preview resource name.
resourceSourceId	formData			Preview resource unique source identifier.
resourceType	formData			Preview resource type.
anonymousAccess	formData			Flag that indicates if a preview resource should be available for downloading for anonymous users.
overwriteExistingResource	formData			Flag that indicates if an existing resource should be overwritten.
sourceFile	formData			Source file.
mockupOwnerId	formData			Mockup owner identifier.
mockupId	formData			Mockup identifier.
width	formData			Image preview width.
height	formData			Image preview height.
fileFormat	formData			Image preview file format.
fitMode	formData			Image preview fit mode.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

RenderImagePreviewFromUrl

Renders a preview of a web image with the specified parameters.

Request

POST /api/atoms/v1/images/render-preview/from-url[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderImagePreviewFromUrlModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RenderImagePreviewFromUrlToResource

Renders a preview of a web image with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/images/render-preview/from-url/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderImagePreviewFromUrlToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

RenderImagePreviewToResource

Renders a preview of an image with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/images/render-preview/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderImagePreviewToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

DesignAtomsMockups3d

These endpoints are used to manipulate 3D-Mockups via Design Atoms.

GetAttributes

Returns a 3D-Mockup attributes.

Request

GET /api/atoms/v1/mockups-3d/{id}/attributes[?ownerId&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			3D-Mockup identifier.
ownerId	query			Private mockup owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	Mockup3dAttributesDto	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetContentAsProtobuf

Returns a 3D-Mockup content as protobuf binary stream.

Request

GET /api/atoms/v1/mockups-3d/{id}/content/as-protobuf[?ownerId&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			3D-Mockup identifier.
ownerId	query			Private mockup owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetGeometryFile

Returns a 3D-Mockup geometry as binary stream.

Request

GET /api/atoms/v1/mockups-3d/{id}/geometry/file[?ownerId&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			3D-Mockup identifier.
ownerId	query			Private mockup owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

DesignAtomsPalettes

These endpoints are used to manipulate Palettes via Design Atoms.

FindPaletteColor

Returns a closest color to provided color in a specified palette.

Request

POST /api/atoms/v1/palettes/find-color[?paletteUID&tenantId]

Parameters

Name	In	Type	Default	Notes
paletteUID	query			Palette UID.
tenantId	query			Tenant identifier
body	body			Source color.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetPaletteModel

Returns a serialized palette model by its identifier or UID.

Request

GET /api/atoms/v1/palettes/model[?id&uid&tenantId]

Parameters

Name	In	Type	Default	Notes
id	query			Palette identifier.
uid	query			Palette UID.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

DesignAtomsPrintProduct

These endpoints are used to manipulate print-product models of a design.

PatchDesignProduct

Patches a print-product of the specified design file.

Design with specified identifier must exist at desired storage.

Request

PATCH /api/atoms/v1/designs/{id}/print-product[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
patchType	formData			Patch operation type.
replaceImageItemFileInfo.itemName	formData			Item Name.
replaceImageItemFileInfo.sourceFile	formData			Patch source file.
replacePlaceholderItemContentInfo.placeholderItemName	formData			Item Name.
replacePlaceholderItemContentInfo.newContentType	formData			New content type.
replacePlaceholderItemContentInfo.sourceFile	formData			Patch source file.

Responses

Status Code	Type	Description	Samples
204		No Content
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDesignSurfaceContainers

Returns a list of print-product container descriptions of the specified design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/containers[?surfaceId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceId	query			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignSurfaceContainerDto []	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

DeleteDesignSurfaceContainer

Deletes a specified print-product container in an existing design file.

Request

DELETE /api/atoms/v1/designs/{id}/print-product/containers/{containerId}[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*containerId	path			Print-product container identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
204		No Content
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceContainerModel

Returns a print-product container of the specified design file as a json-serialized model.

Request

GET /api/atoms/v1/designs/{id}/print-product/containers/{containerId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*containerId	path			Print-product container identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

UpdateDesignSurfaceContainerModel

Updates a specified print-product container in an existing design file with the data provided as a json-serialized model.

Request

PUT /api/atoms/v1/designs/{id}/print-product/containers/{containerId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*containerId	path			Print-product container identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a print-product container.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

AddDesignSurfaceContainerModel

Inserts a new print-product container provided as a json-serialized model to the certain surface in an existing design file. Print-product container identifier will be reset by auto-generated value to prevent identifiers collisions.

Request

POST /api/atoms/v1/designs/{id}/print-product/containers/model[?surfaceId&index&top&left&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceId	query			Print-product surface identifier.
index	query			Container index within the conatiners list of a surface.
top	query			Y axis position.
left	query			X axis position.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a new print-product container.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDesignSurfaceItems

Returns a list of print-product items descriptions of the specified design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/items[?surfaceId&containerId&parentItemId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceId	query			Print-product surface identifier.
containerId	query			Print-product container identifier.
parentItemId	query			Print-product item identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignSurfaceItemDto []	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

DeleteDesignSurfaceItem

Deletes a specified print-product item in an existing design file.

Request

DELETE /api/atoms/v1/designs/{id}/print-product/items/{itemId}[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*itemId	path			Print-product item identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
204		No Content
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceItemModel

Returns a print-product item of the specified design file as a json-serialized model.

Request

GET /api/atoms/v1/designs/{id}/print-product/items/{itemId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*itemId	path			Print-product item identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

UpdateDesignSurfaceItemModel

Updates a specified print-product surface item in an existing design file with the data provided as a json-serialized item model.

Request

PUT /api/atoms/v1/designs/{id}/print-product/items/{itemId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*itemId	path			Print-product item identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a print-product item.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

AddDesignSurfaceItemModel

Inserts a new print-product item provided as a json-serialized model to the specified surface in an existing design file. Item identifier will be reset by auto-generated value to prevent identifiers collisions.

Request

POST /api/atoms/v1/designs/{id}/print-product/items/model[?containerId&index&top&left&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
containerId	query			Parent surface identifier.
index	query			Item index within the items list of a container.
top	query			Y axis position.
left	query			X axis position.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a new print-product item.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDesignProductModel

Returns a print-product of the specified design file as a json-serialized model.

Request

GET /api/atoms/v1/designs/{id}/print-product/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

UpdateDesignProductModel

Updates a print-product provided as a json-serialized model is the specified design file.

Request

PUT /api/atoms/v1/designs/{id}/print-product/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a print-product .

Responses

Status Code	Type	Description	Samples
204		No Content
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDesignPrintAreas

Returns a list of print-area descriptions of the specified design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/print-areas[?surfaceId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceId	query
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignPrintAreaDto []	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

AddDesignPrintArea

Inserts a new print-area created by the description at the specified position in an existing design file. Print-area identifier will be reset by auto-generated value to prevent identifiers collisions.

Request

POST /api/atoms/v1/designs/{id}/print-product/print-areas[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body	DesignPrintAreaParams		Print-area description model.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

UpdateDesignPrintArea

Updates a specified print-area using a description in an existing design file.

Request

PUT /api/atoms/v1/designs/{id}/print-product/print-areas/{printAreaId}[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*printAreaId	path			Design print-area identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body	DesignPrintAreaParams		Print-area description model.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

DeleteDesignPrintArea

Deletes a specified print-area in an existing design file.

Request

DELETE /api/atoms/v1/designs/{id}/print-product/print-areas/{printAreaId}[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*printAreaId	path			Design print-area identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
204		No Content
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignPrintAreaModel

Returns a print-area of the specified design file as a json-serialized model.

Request

GET /api/atoms/v1/designs/{id}/print-product/print-areas/{printAreaId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*printAreaId	path			Design print-area identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

UpdateDesignPrintAreaModel

Updates a specified print-area in an existing design file with the data provided as a json-serialized print-area model.

Request

PUT /api/atoms/v1/designs/{id}/print-product/print-areas/{printAreaId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*printAreaId	path			Design print-area identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a print-area.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

AddDesignPrintAreaModel

Inserts a new print-area provided as a json-serialized model at the specified position in an existing design file. Print-area identifier will be reset by auto-generated value to prevent identifiers collisions.

Request

POST /api/atoms/v1/designs/{id}/print-product/print-areas/model[?surfaceId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceId	query			Parent surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json serialized model of a print-area.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDesignSurfaces

Returns a list of print-product surfaces descriptions of the specified design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/surfaces[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignSurfaceDto []	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

DeleteDesignSurface

Deletes a specified print-product surface in an existing design file.

Request

DELETE /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
204		No Content
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceDownMockup

Returns a down-mockup description of the specified print-product surface in an existing design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/mockup-down[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignSurfaceMockupDto	Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

UpdateDesignSurfaceDownMockup

Updates a content file of down-mockup for the specified print-product surface in an existing design file.

Request

PATCH /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/mockup-down[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
position.top	formData			Y axis position.
position.left	formData			X axis position.
sourceFile	formData			New mockup file.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceDownMockupContent

Returns a content file for down-mockup of the specified print-product surface in an existing design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/mockup-down/file[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceUpMockup

Returns an up-mockup description of the specified print-product surface in an existing design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/mockup-up[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignSurfaceMockupDto	Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

UpdateDesignSurfaceUpMockup

Updates a content file of up-mockup for the specified print-product surface in an existing design.

Request

PATCH /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/mockup-up[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
position.top	formData			Y axis position.
position.left	formData			X axis position.
sourceFile	formData			New mockup file.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceUpMockupContent

Returns a content file for up-mockup of the specified print-product surface in an existing design file.

Request

GET /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/mockup-up/file[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetDesignSurfaceModel

Returns a print-product surface of the specified design file as a json-serialized model.

Request

GET /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

ReplaceDesignSurfaceModel

Replaces a specified print-product surface in an existing design file with the data provided as a json-serialized surface model. All design elements identifiers within the surface (including surface identifier) will be reset by auto-generated values to prevent identifiers collisions.

Request

PUT /api/atoms/v1/designs/{id}/print-product/surfaces/{surfaceId}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
*surfaceId	path			Print-product surface identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a print-product surface.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

AddDesignSurfaceModel

Inserts a new surface provided as a json-serialized model at the specified position in an existing design file. All design elements identifiers within the surface (including surface identifier) will be reset by auto-generated values to prevent identifiers collisions.

Request

POST /api/atoms/v1/designs/{id}/print-product/surfaces/model[?index&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
index	query			Surface index within the surfaces list of a design.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Json-serialized model of a print-prouduct surface.

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

DesignAtomsPrintProductItems

These endpoints are used to manipulate print-product items.

ApplyItemEffects

Apply effects to print-product item image.

Request

POST /api/atoms/v1/designs/print-product/items/apply-effects[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

ExtractItemImage

Extracts print-product item image.

Request

POST /api/atoms/v1/designs/print-product/items/extract-image[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	ExtractItemImageModel		Extraction parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden

FlattenItems

Flattens print-product items.

Request

POST /api/atoms/v1/designs/print-product/items/flatten[?paletteUID&tenantId]

Parameters

Name	In	Type	Default	Notes
paletteUID	query
tenantId	query			Tenant identifier
body	body	array		List of print-product items to flatten.

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

CreateItemFromFile

Creates print-product item from input image file.

Request

POST /api/atoms/v1/designs/print-product/items/from-file[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired item type.
tenantId	query			Tenant identifier
sourceFile	formData			Input files.
paletteUID	formData			Target palette UID.
preserveOriginalFile	formData			Indicates if resulting item should store original source file.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

BatchCreateItemsFromFile

Creates multiple print-product items from input image files.

Request

POST /api/atoms/v1/designs/print-product/items/from-file/batch-create[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired print-product items type.
tenantId	query			Tenant identifier
sourceFiles	formData			List of input files.
paletteUID	formData			Target palette UID.
preserveOriginalFile	formData			Indicates if resulting item should store original source file.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

CreateItemFromStorage

Creates print-product item from image file taken from storage.

Request

POST /api/atoms/v1/designs/print-product/items/from-storage[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired item type.
tenantId	query			Tenant identifier
body	body	CreateItemFromStorageModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

BatchCreateItemsFromStorage

Creates multiple print-product items from the specified image files in storage.

Request

POST /api/atoms/v1/designs/print-product/items/from-storage/batch-create[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired items type.
tenantId	query			Tenant identifier
body	body	BatchCreateItemsFromStorageModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

CreateItemFromUrl

Creates print-product item from remote web image provided by URL.

Request

POST /api/atoms/v1/designs/print-product/items/from-url[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired item type.
tenantId	query			Tenant identifier
body	body	CreateItemFromUrlModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

BatchCreateItemsFromUrl

Creates multiple print-product items from remote web images provided by URLs list.

Request

POST /api/atoms/v1/designs/print-product/items/from-url/batch-create[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired items type.
tenantId	query			Tenant identifier
body	body	BatchCreateItemsFromUrlModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

DesignAtomsService

These endpoints are used to manipulate Design Atoms models.

CreateDesign

Creates new design file with specified parameters and saves it in storage.

Request

POST /api/atoms/v1/designs[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body	CreateDesignModel		Design creation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignInfo	Created
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

ExtractBackground

Returns image content of the background.

Request

GET /api/atoms/v1/designs/{id}/background[?surfaceIndex&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceIndex	query			Surface index.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

SetEditorMockups

Sets specified editor-mockups for selected design surfaces.

Request

PUT /api/atoms/v1/designs/{id}/editor-mockups[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body	SetEditorMockupsModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDesignParameters

Returns design parameters stored in product model.

Request

GET /api/atoms/v1/designs/{id}/parameters[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignParameters	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LoadDataSchema

Loads a data schema from design file taken from storage.

Request

GET /api/atoms/v1/designs/{id}/schema[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

LoadToggleSet

Loads a toggle set from design file taken from storage.

Request

GET /api/atoms/v1/designs/{id}/toggle-set[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

GetVariables

Returns variable items information for design file taken from storage.

Request

GET /api/atoms/v1/designs/{id}/variables[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	VariablesModel	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

SetVariables

Saves variable items values for design file taken from storage.

Request

PUT /api/atoms/v1/designs/{id}/variables[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body	VariablesModel		Design variable values.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

LoadVdpData

Loads variable data printing information from design file taken from storage.

Request

GET /api/atoms/v1/designs/{id}/vdp-data[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	VdpDataModel	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

SaveVdpData

Saves variable data printing information to design file and updates design in storage.

Design with specified identifier must exist at desired storage.

Request

PUT /api/atoms/v1/designs/{id}/vdp-data[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body	VdpDataModel		Serialized vdp data.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

DeleteVdpData

Deletes variable data printing information from design file and updates design file in storage.

Design with specified identifier must exist at desired storage.

Request

DELETE /api/atoms/v1/designs/{id}/vdp-data[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

ConvertColors

Converts colors for print-product item manipulations.

Request

POST /api/atoms/v1/designs/print-product/convert-colors[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	ConvertColorsModel		Convert colors operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LoadProductFromResource

Loads print-product from resource file taken from storage.

Request

GET /api/atoms/v1/designs/print-product/from-resource/model[?id&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
id	query			Resource identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	UnprocessableDesignElementDto	Conflict
401		Unauthorized
403		Forbidden

RenderProduct

Renders a product proof image with specified parameters.

Request

POST /api/atoms/v1/designs/print-product/render-proof[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderProductModel		Preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden

RenderDesignPreview

Renders a design preview with the specified parameters.

Request

POST /api/atoms/v1/designs/render-preview[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderDesignPreviewModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden

RenderDesignPreviewToResource

Renders a design preview with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/designs/render-preview/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderDesignPreviewToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
404	ProblemDetails	Not Found
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

RenderDesignProof

Renders a design proof with the specified parameters.

Request

POST /api/atoms/v1/designs/render-proof[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderDesignProofModel		Render model with proof parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RenderDesignProofToResource

Renders a design proof with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/designs/render-proof/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderDesignProofToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
409	GeneralConflictDto	Conflict
401		Unauthorized
403		Forbidden

LoadProduct Deprecated

Loads print-product from design file taken from storage.

Request

GET /api/atoms/v1/designs/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

SaveProduct Deprecated

Saves print-product to design file and updates design file in storage.

Request

PUT /api/atoms/v1/designs/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
body	body			Serialized product description.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PatchProduct Deprecated

Patches print-product in design file.

Design with specified identifier must exist at desired storage.

Request

PATCH /api/atoms/v1/designs/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
patchType	formData			Patch operation type.
replaceImageItemFileInfo.itemName	formData			Item Name.
replaceImageItemFileInfo.sourceFile	formData			Patch source file.
replacePlaceholderItemContentInfo.placeholderItemName	formData			Item Name.
replacePlaceholderItemContentInfo.newContentType	formData			New content type.
replacePlaceholderItemContentInfo.sourceFile	formData			Patch source file.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

CreateItem Deprecated

Creates print-product item.

Request

POST /api/atoms/v1/designs/model/items[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired item type.
tenantId	query			Tenant identifier
sourceType	formData			Source type.
sourceId	formData			Source id, used if source type is 'ImageStorage' or 'PrivateImageStorage'.
sourceOwnerId	formData			Source owner id, used if source type is 'PrivateImageStorage'.
url	formData			Source URL, used if source type is 'Url'.
sourceFile	formData			Source file, used if source type is 'File'.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExtractItemImage Deprecated

Extracts print-product item image.

Request

POST /api/atoms/v1/designs/model/items/extract-image[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	ExtractItemImageModel		Extraction parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden

FlattenItems Deprecated

Flattens print-product items.

Request

POST /api/atoms/v1/designs/model/items/flatten[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	array		Items to flatten.

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

CreatePrivateDesignFromDesign Deprecated

Creates a private design from a public design.

Request

POST /api/atoms/v1/private-designs/from-design[?designId&privateDesignId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
designId	query			Public design identifier.
privateDesignId	query			Private design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
201		Created
401		Unauthorized
403		Forbidden

CreatePrivateDesignFromResource Deprecated

Creates a private design from a public resource.

Request

POST /api/atoms/v1/private-designs/from-resource[?resourceId&privateDesignId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
resourceId	query			Resource identifier.
privateDesignId	query			Private design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query		0	Tenant identifier.

Responses

Status Code	Type	Description	Samples
201		Created
401		Unauthorized
403		Forbidden

DesignAtomsViewer

These endpoints are used to manipulate Design Atoms models

CssFonts

Request

POST /api/atoms/v1/ccviewer/cssfonts[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	FontsMethodData

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden

Fonts

Request

GET /api/atoms/v1/ccviewer/fonts/{psName}[?tenantId]

Parameters

Name	In	Type	Default	Notes
*psName	path
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetColorPreview

Request

POST /api/atoms/v1/ccviewer/GetColorPreview[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetColorPreviewRequest

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
401		Unauthorized
403		Forbidden

GetColorPreviews

Request

POST /api/atoms/v1/ccviewer/GetColorPreviews[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetColorPreviewsRequest

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
401		Unauthorized
403		Forbidden

GetCssFont

Request

GET /api/atoms/v1/ccviewer/GetCssFont[?fontKey&tenantId]

Parameters

Name	In	Type	Default	Notes
fontKey	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetFallbackFonts

Request

GET /api/atoms/v1/ccviewer/GetFallbackFonts[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

GetImageSize

Request

POST /api/atoms/v1/ccviewer/GetImageSize[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetImageSizeRequest

Responses

Status Code	Type	Description	Samples
200	NullAbleSize	Success
401		Unauthorized
403		Forbidden

GetShapeBounds

Request

POST /api/atoms/v1/ccviewer/GetShapeBounds[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetShapeBoundsRequest

Responses

Status Code	Type	Description	Samples
200	RectangleF	Success
401		Unauthorized
403		Forbidden

GetWatermarkItems

Request

POST /api/atoms/v1/ccviewer/GetWatermarkItems[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

Img

Request

GET /api/atoms/v1/ccviewer/img[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetLicense

Request

GET /api/atoms/v1/ccviewer/license[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

Pth

Request

GET /api/atoms/v1/ccviewer/pth[?f&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Resource

Request

GET /api/atoms/v1/ccviewer/resource[?image&tenantId]

Parameters

Name	In	Type	Default	Notes
image	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Svg

Request

GET /api/atoms/v1/ccviewer/svg[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Txt

Request

GET /api/atoms/v1/ccviewer/txt[?f&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

UpdateArchedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateArchedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateAutoScaledTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateAutoScaledTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateBarcodeItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateBarcodeItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateBoundedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateBoundedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateByColorData

Request

POST /api/atoms/v1/ccviewer/UpdateByColorData[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateColorsRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateByMultiCallRequest

Request

POST /api/atoms/v1/ccviewer/UpdateByMultiCallRequest[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	MultiCallRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateCurvedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateCurvedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateImageItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateImageItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateImageHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdatePathBoundedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdatePathBoundedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdatePlainTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdatePlainTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

UpdateShapeItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateShapeItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden

Definitions

BuildInfoModel

Information about a service.

Name	Type	Notes
version	string	Version number.
buildDate	string	Build date (UTC).
configuration	string	Build configuration (Debug | Release).
appName	string	Service name.
designAtomsVersion	string	Aurigma.DesignAtoms version.
designAtomsModelVersion	string	Aurigma.DesignAtoms.Model version.

FontsMethodData

Name	Type	Notes
requestedFontsByPsName	array
advancedMode	boolean
baseUrl	string

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

GetColorPreviewRequest

Name	Type	Notes
colorData
colorSettings

GetColorPreviewsRequest

Name	Type	Notes
colorData
colorSettings

GetImageSizeRequest

Name	Type	Notes
imageId	string
pageIndex	integer (int32)

NullAbleSize

Name	Type	Notes
width	integer (int32)
height	integer (int32)

GetShapeBoundsRequest

Name	Type	Notes
path	string

RectangleF

Name	Type	Notes
location	PointF[]
size	string
x	number (float)
y	number (float)
width	number (float)
height	number (float)
left	number (float)
top	number (float)
right	number (float)
bottom	number (float)
isEmpty	boolean

PointF

Name	Type	Notes
isEmpty	boolean
x	number (float)
y	number (float)

UpdateHandlerRequest

Name	Type	Notes
canvasData	string
itemHandlerData	string
itemData
colorSettings

UpdateColorsRequest

Name	Type	Notes
canvasData	string
colorData	string

MultiCallRequest

Name	Type	Notes
items	MultiCallRequestItem[]

MultiCallRequestItem

Name	Type	Notes
canvasData	string
itemHandlersData	string
colorData	string
actualSize	boolean
preserveAspectRatio	boolean
url	string
imageId	string
pageIndex	integer (int32)
methodName	string
itemData
colorSettings

UpdateImageHandlerRequest

Name	Type	Notes
actualSize	boolean
preserveAspectRatio	boolean
url	string
canvasData	string
itemHandlerData	string
itemData
colorSettings

RenderImagePreviewModel

Image preview rendering parameters.

Name	Type	Notes
imageUrl	string	External image URL.
imageId	string	Storage image identifier.
ownerId	string	Storage image owner identifier.
mockupOwnerId	string	Mockup owner identifier.
mockupId	string	Mockup identifier.
renderingConfig		Image preview configuration.

ResourceInfoDto

Name	Type	Notes
id	string
ownerId	string
name	string
namespace	string
private	boolean
url	string

GeneralConflictDto

Information about operation conflict.

Name	Type	Notes
description	string	Problem description.
type	ConflictType	Coflict type.

ConflictType

Coflict type.

Enum Values

NameConflict FolderOverwriteConflict IdConflict GeneralConflict

RenderImagePreviewFromUrlModel

Web image preview rendering parameters.

Name	Type	Notes
imageUrl	string	Web image URL.
mockupOwnerId	string	Mockup owner identifier.
mockupId	string	Mockup identifier.
renderingConfig		Image preview configuration.
headers	object	Headers that will be used to download remote image by URL. For example, Authorization header can be placed here to provide access to image.

RenderImagePreviewFromUrlToResourceModel

Image preview rendering parameters. Result will be saved as resource with parameters set as Aurigma.DesignAtomsApi.WebApi.Models.Image.RenderImagePreviewFromUrlToResourceModel.PreviewResourceParams.

Name	Type	Notes
previewResourceParams		Parameters of resource that should be created for a preview rendering result.
overwriteExistingResource	boolean	Flag that indicates if an existing resource should be overwritten.
imageUrl	string	Web image URL.
mockupOwnerId	string	Mockup owner identifier.
mockupId	string	Mockup identifier.
renderingConfig		Image preview configuration.
headers	object	Headers that will be used to download remote image by URL. For example, Authorization header can be placed here to provide access to image.

RenderImagePreviewToResourceModel

Image preview rendering parameters. Result will be saved as resource with parameters set as Aurigma.DesignAtomsApi.WebApi.Models.Image.RenderImagePreviewToResourceModel.PreviewResourceParams.

Name	Type	Notes
previewResourceParams		Parameters of resource that should be created for a preview rendering result.
overwriteExistingResource	boolean	Flag that indicates if an existing resource should be overwritten.
imageUrl	string	External image URL.
imageId	string	Storage image identifier.
ownerId	string	Storage image owner identifier.
mockupOwnerId	string	Mockup owner identifier.
mockupId	string	Mockup identifier.
renderingConfig		Image preview configuration.

Mockup3dAttributesDto

Name	Type	Notes
data	object

DesignSurfaceContainerDto

Name	Type	Notes
id	string	Container identifier.
name	string	Container name.
surfaceId	string	Parent surface identifier.
index	integer (int32)	Container index within containers list of a surface (0-based).
size	SizeDto	Container size.
position	PositionDto	Container position.

SizeDto

Container size.

Name	Type	Notes
width	number (float)	Print-product element width.
height	number (float)	Print-product element height.

PositionDto

Container position.

Name	Type	Notes
top	number (float)	Print-product element Y axis position.
left	number (float)	Print-product element X axis position.

DesignSurfaceItemDto

Name	Type	Notes
id	string	Item identifier.
name	string	Item name.
type	string	Item type.
parentItemId	string	Parent item identifier.
containerId	string	Parent container identifier.
surfaceId	string	Parent surface identifier.
index	integer (int32)	Item index within items list of a surface (0-based).
visible	boolean	Indicates if item is visible.

DesignPrintAreaDto

Name	Type	Notes
id	string	Print area identifier.
name	string	Print area name.
surfaceId	string	Parent surface identifier.
size	SizeDto	Print area size.
position	PositionDto	Print area position.
bleed	MarginDto	Print area bleed.
slug	MarginDto	Print area slug.

MarginDto

Print area bleed.

Name	Type	Notes
top	number (float)	Print-product element top margin.
left	number (float)	Print-product element left margin.
right	number (float)	Print-product element right margin.
bottom	number (float)	Print-product element bottom margin.

DesignPrintAreaParams

Design print area parameters.

Name	Type	Notes
name	string	Print area name.
surfaceId	string	Parent surface identifier.
size		Print area size.
position		Print area position.
bleed		Print area bleed.
slug		Print area slug.

DesignSurfaceDto

Name	Type	Notes
id	string	Surface identifier.
name	string	Surface name.
index	integer (int32)	Surface index within surface list of a design (0-based).
size	SizeDto	Surface size.

DesignSurfaceMockupDto

Surface mockup parameters.

Name	Type	Notes
position	PositionDto[]	Mockup element position.
size	SizeDto[]	Mockup element size.
surfaceId	string	Parent surface identifier.
resolution	integer (int32)	Mockup image resolution (DPI).

ExtractItemImageModel

Item extraction operation parameters.

Name	Type	Notes
item		Serialized item description.

UnprocessableDesignElementDto

Name	Type	Notes
missingElementType	DesignElementType	Missing element type.
unprocessedElementType	DesignElementType	Missing element type.
description	string	Problem description.
type	ConflictType	Coflict type.

DesignElementType

Missing element type.

Enum Values

Product Design Surface Container PrintArea Item

CreateItemFromStorageModel

Create item from storage source operation parameters.

Name	Type	Notes
sourceOwnerId	string	Source image asset owner identifier. If value is set, all images should belong to a specified user.
sourceId	string	Source image asset identifier.
paletteUID	string	Target palette UID.
preserveOriginalFile	boolean	Indicates if resulting item should store original source file.

BatchCreateItemsFromStorageModel

Batch create items from storage source operation parameters.

Name	Type	Notes
sourceOwnerId	string	Source image assets owner identifier. If value is set, all images should belong to a specified user.
sourceIds	array	Source image asset identifiers.
paletteUID	string	Target palette UID.
preserveOriginalFile	boolean	Indicates if resulting item should store original source file.

CreateItemFromUrlModel

Create item from web source operation parameters.

Name	Type	Notes
url	string	Source URL.
paletteUID	string	Target palette UID.
headers	object	Headers that will be used to download remote image by URL. For example, Authorization header can be placed here to provide access to image.
preserveOriginalFile	boolean	Indicates if resulting item should store original source file.

BatchCreateItemsFromUrlModel

Batch create items from web source operation parameters.

Name	Type	Notes
urls	array	Source URLs.
paletteUID	string	Target palette UID.
headers	object	Headers that will be used to download remote image by URL. For example, Authorization header can be placed here to provide access to images.
preserveOriginalFile	boolean	Indicates if resulting item should store original source file.

CreateDesignModel

Design creation parameters.

Name	Type	Notes
product		Serialized product description.
dataSchema	string	Serialized product data schema (base64 file stream).
name	string	Design name.
path	string	Design location (folder path).

DesignInfo

Name	Type	Notes
id	string
ownerId	string
name	string
private	boolean

SetEditorMockupsModel

Parameters of 'setting editor mockup for design surfaces' operation.

Name	Type	Notes
editorMockupBindings	EditorMockupBindingModel[]	List of editor mockup binding instructions.

EditorMockupBindingModel

List of editor mockup binding instructions.

Name	Type	Notes
mockupId	string	Mockup identifier.
mockupOwnerId	string	Private mockup owner identifier. Set null if public mockup is supposed to be used.
surfaceIndex	integer (int32)	Target surface index.

DesignParameters

Specific design parameters stored in product model.

Name	Type	Notes
measureUnit	MeasureUnitInfo[]	Design measure unit description.
designAtomsVersion	string	Version of DesignAtoms library that used to save design file.

MeasureUnitInfo

Design measure unit description.

Name	Type	Notes
name	string
shortName	string
ratio	number (float)

VariablesModel

Variables information.

Name	Type	Notes
items	VariableInfo[]	List of variables.

VariableInfo

List of variables.

Name	Type	Notes
name	string	Variable name.
value	string	Variable value.
type	string	Variable type.

VdpDataModel

Variable data printing information.

Name	Type	Notes
vdpDataSet		Serialized vdp dataset.
vdpItemsData		Serialized vdp items data.

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	Target color profile description.

RenderProductModel

Render product parameters.

Name	Type	Notes
product		Serialized product description.
renderingConfig		Proof Image rendering config.

RenderDesignPreviewModel

Name	Type	Notes
designId	string	Design identifier. Used to get design file from public or private storage.
mockupId	string	Mockup identifier. Used to get mockup file from public storage.
ownerId	string	Identifier of the design owner.
mockupOwnerId	string	Identifier of the mockup owner.
renderingConfig		Rendering configuration for getting a preview of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the preview image.

RenderDesignPreviewToResourceModel

Name	Type	Notes
previewResourceParams		Parameters of resource that should be created for a preview rendering result.
overwriteExistingResource	boolean	Flag that indicates if an existing resource should be overwritten.
designId	string	Design identifier. Used to get design file from public or private storage.
mockupId	string	Mockup identifier. Used to get mockup file from public storage.
ownerId	string	Identifier of the design owner.
mockupOwnerId	string	Identifier of the mockup owner.
renderingConfig		Rendering configuration for getting a preview of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the preview image.

RenderDesignProofModel

Name	Type	Notes
designId	string	Design identifier. Used to get design file from public or private storage.
ownerId	string	Identifier of the design owner.
renderingConfig		Rendering configuration for getting a proof image of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the proof image.

RenderDesignProofToResourceModel

Name	Type	Notes
proofResourceParams		Parameters of resource that should be created for a preview rendering result.
overwriteExistingResource	boolean	Flag that indicates if an existing resource should be overwritten.
designId	string	Design identifier. Used to get design file from public or private storage.
ownerId	string	Identifier of the design owner.
renderingConfig		Rendering configuration for getting a proof image of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the proof image.