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

GetDepositPhotos

Return information about inserted images from DepositPhotos

Request

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

Parameters

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

Responses

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

ExportDesign

Exports design file

Request

GET /api/processor/v1/designs/{id}/export[?tenantId]

Parameters

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

Responses

Status Code	Type	Description	Samples
200	string	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}[?surfaceIndex&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
surfaceIndex	query			Design surface index Indicates which design surface should be used as a source for preview
stub	query			Design Preview stub contnent switcher Indicates whether to 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

PreparePreviewUrl

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}/url[?surfaceIndex&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
surfaceIndex	query			Design surface index Indicates which design surface should be used as a source for preview
stub	query			Design Preview stub contnent switcher Indicates whether to 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

EmbedDataSchema

Embeds linked data schema to the design file

Request

POST /api/processor/v1/designs/{id}/schema/embed[?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

ExtractDataSchema

Extracts data schema from design file and saves it to the specified folder

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier
tenantId	query			Tenant identifier
body	body	DesignExtractDataSchemaModel		Extract data schema operation parameters

Responses

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

LinkDataSchema

Links data schema to the design file

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier
tenantId	query			Tenant identifier
body	body	DesignLinkDataSchemaModel		Link schema operation parameters

Responses

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

RemoveDataSchema

Removes data schema from the design file

Request

POST /api/processor/v1/designs/{id}/schema/remove[?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

Update

Updates design file and metadata in storage

If file is not provided metadata will be updated using file 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
designParams.name	formData			Design name
designParams.path	formData			Design location (folder path)
designParams.customFields	formData			Design custom attributes
file	formData			Design source file

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			Preview stub contnent switcher Indicates whether to 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	DesignImportConflictDto	Conflict
401		Unauthorized
403		Forbidden

Definitions

DesignProblemInfo

Information about design problems

Name	Type	Notes
fontMissingProblems	DesignFontMissingProblemDescription[]	List of font missing problem descriptions
dataValidationProblems	DesignDataValidationProblemDescription[]	List of data validation problem descriptions
dataSchemaMissingProblem	DesignDataSchemaMissingProblemDescription[]	List of data schema missing problem descriptions

DesignFontMissingProblemDescription

List of font missing problem descriptions

Name	Type	Notes
postscriptName	string	Postscript name of missing font
name	string	Name of missing font. If postcript name is known - name equals postscript name otherwise it represents available font description

DesignDataValidationProblemDescription

List of data validation problem descriptions

Name	Type	Notes
itemName	string	Name of design item which violate validation rules
validationRule	DataSchemaValidationRule	Validation rule which is voilated
reason	string	Violation description

DataSchemaValidationRule

Validation rule which is voilated

Enum Values

Ok
Missing
Required
NoSuchField
StringPattern
StringMinLength
StringMaxLength
StringMinLengthPerLine
StringMaxLengthPerLine
StringMinLines
StringMaxLines
NumberIsNumber
NumberMin
NumberMax
NumberIsInteger
VariantNotInList
ImageRoot
ImageNotFound

DesignDataSchemaMissingProblemDescription

List of data schema missing problem descriptions

Name	Type	Notes
dataSchemaName	string	Name of missed data schema

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

ImageDepositPhoto

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
itemId	string	Design image item identifier
depositPhoto	DepositPhotoInfo	DepositPhotos image information

DepositPhotoInfo

DepositPhotos image information

Name	Type	Notes
id	string	DepositPhotos image identifier

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
metadata	DesignMetadata[]
hasProblems	boolean
private	boolean
previews	object
size	integer (int64)
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

DesignMetadata

Name	Type	Notes
fonts	DesignFontMetadata[]
surfaces	DesignSurfaceMetadata[]
hasDataSchema	boolean
dataSchemaId	string
dataSchemaName	string

DesignFontMetadata

Name	Type	Notes
postscriptName	string
family	string
style	string

DesignSurfaceMetadata

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

DesignExtractDataSchemaModel

Extract data schema operation parameters

Name	Type	Notes
name	string	Data schema name
path	string	Data schema location (folder path)

DesignLinkDataSchemaModel

Link schema operation parameters

Name	Type	Notes
schemaId	string	Data schema id

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

DesignImportConflictDto

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
missingFontsConflict	MissingFontsConflictDto[]
nameConflict	NameConflictDto[]

MissingFontsConflictDto

Name	Type	Notes
fontInfos	MissingFontInfo[]

MissingFontInfo

Name	Type	Notes
postscriptName	string