DataSetProcessor

Using these endpoints, you may process data sets - for example, extract its metadata or import it to the storage

Check

Checks if data set taken from storage has any problems

Request

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

Parameters

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

Responses

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

ExportDataSet

Exports data set

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier
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 data set

Request

POST /api/processor/v1/dataSets/{id}/schema/embed[?tenantId]

Parameters

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

Responses

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

ExtractDataSchema

Extracts data schema from data set and saves it to the specified folder

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier
tenantId	query			Tenant identifier
body	body	DataSetExtractDataSchemaModel		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 data set

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier
tenantId	query			Tenant identifier
body	body	DataSetLinkDataSchemaModel		Link schema operation parameters

Responses

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

Update

Updates data set file and metadata in storage

If file is not provided metadata will be updated using file taken from storage

Request

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

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier
tenantId	query			Tenant identifier
name	formData			Data set name
path	formData			Data set location (folder path)
customFields	formData			Data set custom attributes
file	formData			Data set source file

Responses

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

ImportDataSet

Imports data set and saves it to storage.

Request

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

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Data set name
path	formData			Data set location (folder path)
customFields	formData			Data set custom attributes
*sourceFile	formData			Data set source file

Responses

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

Definitions

DataSetProblemInfo

Information about data set problems

Name	Type	Notes
dataValidationProblems	DataSetValidationProblemDescription[]	List of data validation problem descriptions
dataSetSchemaMissingProblem	DataSetSchemaMissingProblemDescription[]	List of font missing problem descriptions

DataSetValidationProblemDescription

List of data validation problem descriptions

Name	Type	Notes
rowIndex	integer (int32)	Index of data set row holding the item which violates validation rule
columnName	string	Name of data set column holding the item which violates validation rule
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

DataSetSchemaMissingProblemDescription

List of font missing problem descriptions

Name	Type	Notes
dataSchemaName	string	Name of missed data schema

ProblemDetails

Using these endpoints, you may process data sets - for example, extract its metadata or import it to the storage

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

DataSetDto

Using these endpoints, you may process data sets - for example, extract its metadata or import it to the storage

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

DataSetMetadata

Name	Type	Notes
dataSchemaId	string
dataSchemaName	string
rowCount	integer (int32)

DataSetExtractDataSchemaModel

Extract data schema operation parameters

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

DataSetLinkDataSchemaModel

Link schema operation parameters

Name	Type	Notes
schemaId	string	Data schema id

NameConflictDto

Using these endpoints, you may process data sets - for example, 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