DesignProcessor

Using these endpoints, you may process public designs(used as templates) - for example, generate a preview, extract its metadata or import it to the storage.

Check

Checks if design taken from storage has any problems

Request

POST /api/processor/v1/designs/{id}/check[?tenantId]

Parameters

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

Responses

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

PreparePreview

Creates preview image for design taken from storage.

In case when preview is already existed returns existed preview

Request

GET /api/processor/v1/designs/{id}/preview/{namespace}/{name}/{width}x{height}[?stub&format&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source design entity identifier
*namespace	path			Preview namespace
*name	path			Preview name
*width	path			Preview image width
*height	path			Preview image height
stub	query			Show stub content in preview
format	query			Design preview image format
force	query		False	If set to 'true', new preview prepared, even if preview already existed
tenantId	query			Tenant identifier

Responses

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

UpdateMetadata

Updates metadata for design taken from storage.

Request

POST /api/processor/v1/designs/{id}/update[?tenantId]

Parameters

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

Responses

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

CreateBlankDesign

Creates design by product model and saves it to storage

Request

POST /api/processor/v1/designs/blank[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	CreateBlankDesignModel		Operation parameters

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

ImportDesign

Imports design from source file and saves it to storage.

Additionally makes design preview if requested.

Request

POST /api/processor/v1/designs/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
designParams.name	formData			Design name
designParams.path	formData			Design location (folder path)
designParams.customFields	formData			Design custom attributes
previewSettings.makePreview	formData			Force make preview
previewSettings.namespace	formData			Preview namespace
previewSettings.name	formData			Preview name
previewSettings.width	formData			Preview image width
previewSettings.height	formData			Preview image heigth
previewSettings.stub	formData			Show stub content in preview
previewSettings.format	formData			Preview image format
*sourceFile	formData			Design source file

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

Definitions

DesignProblemInfo

Using these endpoints, you may process public designs(used as templates) - for example, generate a preview, extract its metadata or import it to the storage.

Name	Type	Notes
problems	DesignProblem[]

DesignProblem

Name	Type	Notes
type	DesignProblemType
params	DesignProblemParams[]

DesignProblemType

Enum Values

FontMissing

DesignProblemParams

Name	Type	Notes
postscriptName	string

ProblemDetails

Using these endpoints, you may process public designs(used as templates) - for example, generate a preview, extract its metadata or import it to the storage.

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

DesignDto

Using these endpoints, you may process public designs(used as templates) - for example, generate a preview, extract its metadata or import it to the storage.

Name	Type	Notes
customFields	object
metadata	DesignMetadata[]
hasProblems	boolean
private	boolean
previews	object
size	integer (int64)
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
lastModified	string (date-time)

DesignMetadata

Name	Type	Notes
surfaces	DesignSurfaceMetadata[]

DesignSurfaceMetadata

Name	Type	Notes
width	number (float)
height	number (float)

CreateBlankDesignModel

Operation parameters

Name	Type	Notes
designParams		Design prameters
previewSettings		Design preview settings
blankDesignSettings		Blank design settings

NameConflictDto

Using these endpoints, you may process public designs(used as templates) - for example, generate a preview, extract its metadata or import it to the storage.

Name	Type	Notes
type	ConflictType
id	string
name	string
path	string

ConflictType

Enum Values

Name
FolderOverwrite