Common

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

Request Schema

PrinterConnectionTestModel

Response

Status Code: 204

No Content

Status Code: 400

Bad Request

ServerPluginError

[GET] /api/v2/common/printers

Response

Status Code: 200

Success

PrinterInfo

[POST] /api/v2/common/printers

Request Schema

PrinterAddModel

Response

Status Code: 200

Success

PrinterDetailInfo

Status Code: 400

Bad Request

ServerPluginError

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

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

PrinterDetailInfo

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

Status Code: 404

Not Found

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

Parameters

Name	Type	Located In
idRequired	string	path

Request Schema

PrinterAddModel

Response

Status Code: 200

Success

PrinterDetailInfo

Status Code: 400

Bad Request

ServerPluginError

Status Code: 404

Not Found

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

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

PrinterInfo

Status Code: 400

Bad Request

ServerPluginError

Status Code: 404

Not Found

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

Get the information about the current logged-in user.

Response

Status Code: 200

Success

UserResponseModel

Status Code: 400

Bad Request

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

Models

Ƭ ServerPluginError

Server plugin error

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

Ƭ PrinterConnectionTestModel

Name	Type	Description	Example
nameNullable	string

Ƭ PrinterInfo

Name	Type	Description	Example
idNullable	string
nameNullable	string
descriptionNullable	string

Ƭ PrinterDetailInfo

Name	Type	Description	Example
options	PrinterOptions
idNullable	string
nameNullable	string
descriptionNullable	string

Ƭ PrinterOptions

Name	Type	Description	Example
canDuplex	Boolean	If support duplex printing.
landscapeAngle	int32	The landscape angle.
maximumCopies	int32	The max copies.
paperSizesNullable	Array<string>	The supported paper sizes.
paperSourcesNullable	Array<string>	The supported paper sources.
supportsColor	Boolean	Whether color printing is supported.
isDefault	Boolean	Whether the printer is the default OS printer.

Ƭ PrinterAddModel

Name	Type	Description	Example
nameNullable	string
descriptionNullable	string

Ƭ UserResponseModel

User response model

Name	Type	Description	Example
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

Ƭ UserHomePageSource

Enum:

• None
• Personal
• Organizational