Fonts
These endpoints are used to manage tenant public fonts. They cover obvious set of CRUD operations with file, including folder and collection manipulations
Create
Creates new entity
Request
POST /api/storage/v1/fonts[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
metadata.postscriptName | formData | Font Postscript name |
||
metadata.family | formData | Font family name |
||
metadata.style | formData | Font style |
||
file | formData | Entity file content |
||
*path | formData | Parent folder full path |
||
*name | formData | Entity name |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAll
Gets all entities relevant to specified query parameters
Request
GET /api/storage/v1/fonts[?postscriptNames&path&includeSubfolders&skip&take&sorting&search&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
postscriptNames | query | Font postscript names 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 |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Copy
Copies specified entity
Request
POST /api/storage/v1/fonts/{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 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates specified entity
Request
PUT /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
||
metadata.postscriptName | formData | Font Postscript name |
||
metadata.family | formData | Font family name |
||
metadata.style | formData | Font style |
||
file | formData | Entity file content |
||
path | formData | Parent folder full path |
||
name | formData | Entity name |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Gets entity by id
Request
GET /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes specified entity
Request
DELETE /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Gets entity file from file storage
Request
GET /api/storage/v1/fonts/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
attachment | query | If set to 'true', file will 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 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates preview entity for specified source entity
If preview entity with specified namespace and name already exists it will be overwritten
Request
PUT /api/storage/v1/fonts/{id}/preview[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity unique identifier |
||
tenantId | query | Tenant identifier |
||
*name | formData | Preview name |
||
*namespace | formData | Preview namespace |
||
*width | formData | Preview image width |
||
*height | formData | Preview image height |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp ... |
||
file | formData | Preview file content |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
BatchCopy
Copies selected entities and folders to another folder specified by path
Request
POST /api/storage/v1/fonts/batchCopy[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
BatchDelete
Deletes selected entities and folders
Request
POST /api/storage/v1/fonts/batchDelete[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
BatchUpdateParentFolder
Updates parent folder for selected entities and folders
Request
POST /api/storage/v1/fonts/batchUpdateParentFolder[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllCollections
Gets all collections
Request
GET /api/storage/v1/fonts/collections[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateCollection
Creates new collection
Request
POST /api/storage/v1/fonts/collections[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Create operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetCollection
Gets collection content by collection id
Request
GET /api/storage/v1/fonts/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 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateCollection
Updates specified collection
Request
PUT /api/storage/v1/fonts/collections/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Collection unique identifier |
||
tenantId | query | Tenant identifier |
||
body | body |
|
Update operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
DeleteCollection
Deletes specified collection
Request
DELETE /api/storage/v1/fonts/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 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolder
Gets folder content by folder path
Request
GET /api/storage/v1/fonts/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 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates new folder
Request
POST /api/storage/v1/fonts/folders[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Create operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
DeleteFolder
Deletes specified folder
Request
DELETE /api/storage/v1/fonts/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 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates specified folder
Request
PUT /api/storage/v1/fonts/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder unique identifier |
||
tenantId | query | Tenant identifier |
||
body | body |
|
Update operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Gets all folders
Request
GET /api/storage/v1/fonts/folders/all[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Definitions
FontDto
Font dto class
Name | Type | Notes |
---|---|---|
metadata |
|
Font metadata |
previews | object | Preview dictionary Key: "previewMetadata.namespace-previewMetadata.name" Value: "previewMetadata" |
size | integer (int64) | |
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 |
lastModified | string (date-time) | Last entity modification date and time |
FontMetadata
Font metadata
Name | Type | Notes |
---|---|---|
postscriptName | string | Font Postscript name |
family | string | Font family name |
style | string | Font style |
NameConflictDto
Information about operation subject which has name conflict
Name | Type | Notes |
---|---|---|
type |
|
Coflict type |
id | string | Operation subject identifier |
name | string | Operation subject name |
path | string | Operation subject folder path |
ConflictType
Coflict type
Enum Values
NameFolderOverwrite
PagedOfFontDto
Paged view of
Name | Type | Notes |
---|---|---|
total | integer (int64) | |
items |
|
ProblemDetails
These endpoints are used to manage tenant public fonts. 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 |
|
List of operation subject entity descriptions |
folderConflicts |
|
List of operation subject folder descriptions |
type |
|
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 public fonts. They cover obvious set of CRUD operations with file, including folder and collection manipulations
Name | Type | Notes |
---|---|---|
id | string | |
ownerId | string | Entity owner identifier |
name | string | Entity name |
lastModified | string (date-time) | Last entity modification date and time |
CreateCollectionDto
Create operation parameters
Name | Type | Notes |
---|---|---|
name | string | Collection name |
CollectionContentOfFontDto
Collection content information
Name | Type | Notes |
---|---|---|
id | string | Collection unique identifier |
name | string | Collection name |
collections |
|
List of contained collections |
folders |
|
List of contained folders |
entities |
|
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 |
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 |
FolderContentOfFontDto
Folder content information
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier |
folders |
|
List of contained subfolders |
entities |
|
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 |
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 |