DataSets

These endpoints are used to manage tenant data sets. They cover obvious set of CRUD operations with file, including folder and collection manipulations

Create

Creates new entity

Request

POST /api/storage/v1/dataSets[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
metadata.dataSchemaId	formData			DataSet data schema id. Empty string for embedded schema
metadata.dataSchemaName	formData			DataSet data schema name
metadata.rowCount	formData			Row count
hasProblems	formData			Indicates whether data set has any schema validation problems.
file	formData			Entity file content
*path	formData			Parent folder full path
*name	formData			Entity name
customFields	formData			Entity custom attributes

Responses

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

GetAll

Gets all entities relevant to specified query parameters

Request

GET /api/storage/v1/dataSets[?dataSchemaId&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]

Parameters

Name	In	Type	Default	Notes
dataSchemaId	query			Associated data schema identifier filter
path	query			Folder path filter parameter
includeSubfolders	query			If set to 'true', query result will contain list of all entities in desired folder and subfolders
skip	query			Defines page start offset from beginning of sorted result list
take	query			Defines page length (how much consequent items of sorted result list should be taken)
sorting	query			Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
search	query			Search string for partial match
customFields	query			Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	PagedOfDataSetDto	Success
401		Unauthorized
403		Forbidden

Copy

Copies specified entity

Request

POST /api/storage/v1/dataSets/{id}[?path&name&strategy&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source entity identifier
path	query			Desired path
name	query			Desired name
strategy	query			Conflict resolving strategy
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
201	DataSetDto	Success
409	NameConflictDto	Conflict
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates specified entity

Request

PUT /api/storage/v1/dataSets/{id}[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Entity unique identifier
tenantId	query			Tenant identifier
metadata.dataSchemaId	formData			DataSet data schema id. Empty string for embedded schema
metadata.dataSchemaName	formData			DataSet data schema name
metadata.rowCount	formData			Row count
hasProblems	formData			Indicates whether data set has any schema validation problems
file	formData			Entity file content
path	formData			Parent folder full path
name	formData			Entity name
customFields	formData			Entity custom attributes

Responses

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

Get

Gets entity by id

Request

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

Parameters

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

Responses

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

Delete

Deletes specified entity

Request

DELETE /api/storage/v1/dataSets/{id}[?tenantId]

Parameters

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

Responses

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

GetFile

Gets entity file from file storage

Request

GET /api/storage/v1/dataSets/{id}/file[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Entity unique identifier
attachment	query			Indicates that file should be provided as an attachment with proper filename supplied (default value is 'false')
tenantId	query			Tenant identifier

Responses

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

BatchCopy

Copies selected entities and folders to another folder specified by path

Request

POST /api/storage/v1/dataSets/batchCopy[?tenantId]

Parameters

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

Responses

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

BatchDelete

Deletes selected entities and folders

Request

POST /api/storage/v1/dataSets/batchDelete[?tenantId]

Parameters

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

Responses

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

BatchUpdateParentFolder

Updates parent folder for selected entities and folders

Request

POST /api/storage/v1/dataSets/batchUpdateParentFolder[?tenantId]

Parameters

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

Responses

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

GetAllCollections

Gets all collections

Request

GET /api/storage/v1/dataSets/collections[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	CollectionDto []	Success
401		Unauthorized
403		Forbidden

CreateCollection

Creates new collection

Request

POST /api/storage/v1/dataSets/collections[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	CreateCollectionDto		Create operation parameters

Responses

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

GetCollection

Gets collection content by collection id

Request

GET /api/storage/v1/dataSets/collections/{id}[?tenantId]

Parameters

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

Responses

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

UpdateCollection

Updates specified collection

Request

PUT /api/storage/v1/dataSets/collections/{id}[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Collection unique identifier
tenantId	query			Tenant identifier
body	body	UpdateCollectionDto		Update operation parameters

Responses

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

DeleteCollection

Deletes specified collection

Request

DELETE /api/storage/v1/dataSets/collections/{id}[?tenantId]

Parameters

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

Responses

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

GetFolder

Gets folder content by folder path

Request

GET /api/storage/v1/dataSets/folders[?fullPath&tenantId]

Parameters

Name	In	Type	Default	Notes
fullPath	query			Full folder path, if not set then root folder path is used
tenantId	query			Tenant identifier

Responses

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

CreateFolder

Creates new folder

Request

POST /api/storage/v1/dataSets/folders[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	CreateFolderDto		Create operation parameters

Responses

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

DeleteFolder

Deletes specified folder

Request

DELETE /api/storage/v1/dataSets/folders[?fullPath&tenantId]

Parameters

Name	In	Type	Default	Notes
fullPath	query			Folder full path
tenantId	query			Tenant identifier

Responses

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

GetFolderInfo

Gets folder by id

Request

GET /api/storage/v1/dataSets/folders/{id}[?tenantId]

Parameters

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

Responses

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

UpdateFolder

Updates specified folder

Request

PUT /api/storage/v1/dataSets/folders/{id}[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Folder unique identifier
tenantId	query			Tenant identifier
body	body	UpdateFolderDto		Update operation parameters

Responses

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

GetAllFolders

Gets all folders

Request

GET /api/storage/v1/dataSets/folders/all[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	FolderDto []	Success
401		Unauthorized
403		Forbidden

Definitions

DataSetDto

Data set dto class

Name	Type	Notes
metadata	DataSetMetadata[]	Data set metadata
hasProblems	boolean	Indicates whether data set has any schema validation problems.
size	integer (int64)	Entity file size
folderId	string	Parent folder id
tenantId	integer (int32)	Entity tenant identifier
id	string	Entity unique identifier
ownerId	string	Entity owner identifier
name	string	Entity name
customFields	object	Entity custom attributes
lastModified	string (date-time)	Last entity modification date and time

DataSetMetadata

Data set metadata

Name	Type	Notes
dataSchemaId	string	DataSet data schema id. Empty string for embedded schema
dataSchemaName	string	DataSet data schema name
rowCount	integer (int32)	Row count

NameConflictDto

Information about operation subject which has name conflict

Name	Type	Notes
type	ConflictType	Coflict type
id	string	Operation subject identifier
name	string	Operation subject name
path	string	Operation subject folder path

ConflictType

Coflict type

Enum Values

Name FolderOverwrite

PagedOfDataSetDto

Paged list of items

Name	Type	Notes
total	integer (int64)	Items count
items	DataSetDto[]	Items list

ProblemDetails

These endpoints are used to manage tenant data sets. They cover obvious set of CRUD operations with file, including folder and collection manipulations

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

BatchCopyInput

Operation parameters

Name	Type	Notes
path	string	Folder path, describing folder to hold copies
entityIds	array	List of entities, which are operation subjects
folderIds	array	List of folders, which are operation subjects
conflictStrategy		Conflict resolving strategy, which should be applied if operation faces any conflict

BatchConflictDto

Information about batch operation subjects(folder and entities) which have name conflicts

Name	Type	Notes
entityConflicts	ConflictDto[]	List of operation subject entity descriptions
folderConflicts	ConflictDto[]	List of operation subject folder descriptions
type	ConflictType	Coflict type

ConflictDto

List of operation subject entity descriptions

Name	Type	Notes
id	string	Operation subject identifier
name	string	Operation subject name
path	string	Operation subject folder path

BatchDeleteInput

Operation parameters

Name	Type	Notes
entityIds	array	List of entities, which are operation subjects
folderIds	array	List of folders, which are operation subjects

BatchUpdateParentFolderInput

Operation parameters

Name	Type	Notes
path	string	New parent folder path
entityIds	array	List of entities, which are operation subjects
folderIds	array	List of folders, which are operation subjects
conflictStrategy		Conflict resolving strategy

CollectionDto

These endpoints are used to manage tenant data sets. They cover obvious set of CRUD operations with file, including folder and collection manipulations

Name	Type	Notes
id	string	Collection unique identifier
ownerId	string	Entity owner identifier
name	string	Entity name
customFields	object	Entity custom attributes
lastModified	string (date-time)	Last entity modification date and time

CreateCollectionDto

Create operation parameters

Name	Type	Notes
name	string	Collection name

CollectionContentOfDataSetDto

Collection content information

Name	Type	Notes
id	string	Collection unique identifier
name	string	Collection name
collections	CollectionDto[]	List of contained collections
folders	FolderDto[]	List of contained folders
entities	DataSetDto[]	List of contained entities

FolderDto

List of contained folders

Name	Type	Notes
id	string	Folder unique identifier
path	string	Parent folder full path
private	boolean	Folder 'private' tag indicates whether folder is private
ownerId	string	Entity owner identifier
name	string	Entity name
customFields	object	Entity custom attributes
lastModified	string (date-time)	Last entity modification date and time

UpdateCollectionDto

Update operation parameters

Name	Type	Notes
name	string	Collection name
entities	array	Entity identifier list specifing entities, which are part of specified collection
folders	array	Folder identifier list specifying folders, which are part of specified collection
collections	array	Collection identifier list specifying collections, which are part of specified collection

FolderContentOfDataSetDto

Folder content information

Name	Type	Notes
id	string	Folder unique identifier
folders	FolderInfoDto[]	List of contained subfolders
entities	DataSetDto[]	List of contained entities
entitiesCount	integer (int64)	Count of all contained entities (including all subfolder entities)

FolderInfoDto

List of contained subfolders

Name	Type	Notes
hasChildren	boolean	Folder 'has children' tag
id	string	Folder unique identifier
path	string	Parent folder full path
private	boolean	Folder 'private' tag indicates whether folder is private
ownerId	string	Entity owner identifier
name	string	Entity name
customFields	object	Entity custom attributes
lastModified	string (date-time)	Last entity modification date and time

CreateFolderDto

Create operation parameters

Name	Type	Notes
name	string	Folder name
path	string	Parent folder path

UpdateFolderDto

Update operation parameters

Name	Type	Notes
name	string	Folder name
path	string	Parent folder path