DataSchemaProcessor

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

GetLinks

Gets all links associated with this data schema.

Request

GET /api/processor/v1/dataSchemas/{id}/links[?tenantId]

Parameters

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

Responses

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

Update

Updates data schema file and metadata in storage

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

Request

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

Parameters

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

Responses

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

ImportDataSchema

Imports data schema and saves it to storage.

Request

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

Parameters

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

Responses

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

Definitions

DataSchemaLinksInfo

Information about data schema links

Name	Type	Notes
designs	DataSchemaLink[]	List of data schema link descriptions for designs linked to data schema
dataSets	DataSchemaLink[]	List of data schema link descriptions for data sets linked to data schema

DataSchemaLink

List of data schema link descriptions for designs linked to data schema

Name	Type	Notes
id	string	Identifier of entity which is linked to data schema
name	string	Name of entity which is linked to data schema

ProblemDetails

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

DataSchemaDto

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

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

DataSchemaMetadata

Name	Type	Notes
fields	string

NameConflictDto

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