[]
        
(Showing Draft Content)

Common

Common

[POST] /api/v2/common/printers/test

Request Body

Type: application/json

PrinterConnectionTestModel

Responses

[204] No Content

[400] Bad Request

ServerPluginError

Type: [application/json]

[GET] /api/v2/common/printers

Responses

[200] Success

PrinterInfo

Type: [application/json]

[POST] /api/v2/common/printers

Request Body

Type: application/json

PrinterAddModel

Responses

[200] Success

PrinterDetailInfo

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[GET] /api/v2/common/printers/{id}

Parameters

Name In Type
idRequired path string

Responses

[200] Success

PrinterDetailInfo

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[403] Forbidden

[404] Not Found

[PUT] /api/v2/common/printers/{id}

Parameters

Name In Type
idRequired path string

Request Body

Type: application/json

PrinterAddModel

Responses

[200] Success

PrinterDetailInfo

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[404] Not Found

[DELETE] /api/v2/common/printers/{id}

Parameters

Name In Type
idRequired path string

Responses

[200] Success

PrinterInfo

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[404] Not Found

[GET] /api/v2/common/user-info/me

Get the information about the current logged-in user.

Responses

[200] Success

UserResponseModel

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

Models

Ƭ ServerPluginError

Server plugin error

Name Type Description
codeNullable string error code
messageNullable string error message
contextNullable string error context
innerError ServerPluginError
extensionsNullable any Extended result

Ƭ PrinterConnectionTestModel

Name Type
nameNullable string

Ƭ PrinterInfo

Name Type
idNullable string
nameNullable string
descriptionNullable string

Ƭ PrinterDetailInfo

Name Type
options PrinterOptions
idNullable string
nameNullable string
descriptionNullable string

Ƭ PrinterOptions

Name Type
canDuplex Boolean
landscapeAngle int32
maximumCopies int32
paperSizesNullable Array<string>
paperSourcesNullable Array<string>
supportsColor Boolean
isDefault Boolean

Ƭ PrinterAddModel

Name Type
nameNullable string
descriptionNullable string

Ƭ UserResponseModel

User response model

Name Type Description
idNullable string Id
nameNullable string Name
emailNullable string Email
rolesNullable Array<string> Roles
homeNullable string Home page id
homeTitleNullable string Home page title
homeSource UserHomePageSource
showWelcomeOnStartup Boolean Show welcome on start up
isFirstLogin Boolean Is first login
themeNullable string Theme
languageNullable string Language
tenantIdNullable string Tenant id
tenantNameNullable string Tenant name
securityProviderNullable string Security provider
themeNameNullable string Theme name
fullNameNullable string Full name
categoryDocTypesNullable string Category document types
timeZoneIdNullable string Time zone id
delegatedByNullable Array<DelegatedByItemModel> List of users who have delegated to the current user.

Ƭ UserHomePageSource

Enum:

  • None
  • Personal
  • Organizational

Ƭ DelegatedByItemModel

Name Type
idNullable string
nameNullable string
orgIdNullable string
actionsNullable Array<string>
rolesNullable Array<string>