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	ConvertColorsModel		Convert colors operation parameters

Responses

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

CreateDesign

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

Request

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

Parameters

Name	In	Type	Default	Notes
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	CreateDesignModel		Design creation parameters

Responses

Status Code	Type	Description	Samples
201	DesignInfo	Success
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	ProblemDetails	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
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LoadDataSchema

Loads data schema from design file taken from storage

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
tenantId	query			Tenant identifier

Responses

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

SaveDataSchema

Saves data schema to design file and updates design in storage.

Design with specified identifier must exist at desired storage.

Request

PUT /api/atoms/v1/designs/{id}/schema[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
tenantId	query			Tenant identifier
schema	formData			Data schema binary file

Responses

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

DeleteDataSchema

Deletes data schema from design file and updates design in storage.

Design with specified identifier must exist at desired storage.

Request

DELETE /api/atoms/v1/designs/{id}/schema[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
tenantId	query			Tenant identifier

Responses

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

LoadVdpData

Loads variable data printing information from design file taken from storage

Request

GET /api/atoms/v1/designs/{id}/vdpData[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	VdpDataModel	Success
404	ProblemDetails	Not Found
409	ProblemDetails	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}/vdpData[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design 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 inforamtion from design file and updates design in storage.

Design with specified identifier must exist at desired storage.

Request

DELETE /api/atoms/v1/designs/{id}/vdpData[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
409	ProblemDetails	Conflict
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	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RenderProduct

Render product proof image with specified parameters.

Request

POST /api/atoms/v1/renderer[?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

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

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

These endpoints are used to manipulate Design Atoms models

Name	Type	Notes
id	string
ownerId	string
name	string
private	boolean

VdpDataModel

These endpoints are used to manipulate Design Atoms models

Name	Type	Notes
vdpDataSet
vdpItemsData

RenderProductModel

Preview parameters

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