Tenants

These endpoints are used to manage tenants. They cover obvious set of CRUD operations.

GetAll

Gets all tenants

Request
GET /api/storage/v1/tenants[?customFields&skip&take&sorting&search]
Parameters
Name In Type Default Notes
customFields query

Custom attributes dictionary filter
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
Responses
Status Code Type Description Samples
200 PagedOfTenantDto

Success
401

Unauthorized
403

Forbidden

Create

Creates new tenant

Request
POST /api/storage/v1/tenants
Parameters
Name In Type Default Notes
body body CreateTenantDto

create operation parameters
Responses
Status Code Type Description Samples
201 TenantDto

Success
409 NameConflictDto

Conflict
401

Unauthorized
403

Forbidden

Get

Gets tenant by id

Request
GET /api/storage/v1/tenants/{id}
Parameters
Name In Type Default Notes
*id path

Tenant unique identifier
Responses
Status Code Type Description Samples
200 TenantDto

Success
404 ProblemDetails

Not Found
401

Unauthorized
403

Forbidden

Update

Updates specified tenant

Request
PUT /api/storage/v1/tenants/{id}
Parameters
Name In Type Default Notes
*id path

tenant unique identifier
body body UpdateTenantDto

update operation parameters
Responses
Status Code Type Description Samples
200 TenantDto

Success
404 ProblemDetails

Not Found
409 NameConflictDto

Conflict
401

Unauthorized
403

Forbidden

Delete

Deletes specified tenant

Request
DELETE /api/storage/v1/tenants/{id}
Parameters
Name In Type Default Notes
*id path

tenant unique identifier
Responses
Status Code Type Description Samples
200 TenantDto

Success
404 ProblemDetails

Not Found
401

Unauthorized
403

Forbidden

Definitions

PagedOfTenantDto

Paged view of list

Name Type Notes
total integer (int64)
items TenantDto[]

TenantDto

Name Type Notes
id integer (int32)

Tenant entity unique identifier
customFields object

Tenant custom attributes
name string

Entity name
lastModified string (date-time)

Last entity modification date and time

CreateTenantDto

create operation parameters

Name Type Notes
id integer (int32)

Tenant entity unique identifier
name string

Tenant entity name
customFields object

Tenant custom attributes

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

ProblemDetails

These endpoints are used to manage tenants. They cover obvious set of CRUD operations.

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

UpdateTenantDto

update operation parameters

Name Type Notes
customFields object

Tenant custom attributes
name string

Entity name