{ "openapi": "3.0.4", "info": { "title": "PrinterGateway.v1", "description": "API collection that allows for (inter)connecting from/to DIGI printers.

This endpoint collection is transcoded from the gRPC service contract. The Protobuf file can be retrieved via gRPC Server Reflection on the base URI. Use of gRPC is more preferable because of better performance and native streaming capabilities", "termsOfService": "https://www.bergstein.com/privacy-policy-2/", "contact": { "name": "support@bergstein.com", "url": "https://bergstein.com", "email": "support@bergstein.com" }, "version": "v1.4.0.0" }, "paths": { "/printergateway_module/v1/printer_connection": { "post": { "tags": [ "PrinterConnectionService" ], "operationId": "POSTprintergateway_module_v1_printer_connection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.CreatePrinterConnectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.CreatePrinterConnectionReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "get": { "tags": [ "PrinterConnectionService" ], "operationId": "GETprintergateway_module_v1_printer_connection", "parameters": [ { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.id", "in": "query", "schema": { "type": "string" } }, { "name": "order.connectorId", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.id", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.printerName", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.address", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.scheme", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.port", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "order.connector.printerType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType" } }, { "name": "order.connector.physicalLocation", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.isEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.connector.isOnline", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.connector.status", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.comment", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.connector.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.name", "in": "query", "schema": { "type": "string" } }, { "name": "order.comment", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.id", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connectorId", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.id", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.printerName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.address", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.scheme", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.port", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.connector.printerType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType" } }, { "name": "filter.connector.physicalLocation", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.isEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter.connector.isOnline", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter.connector.status", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.comment", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.connector.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.name", "in": "query", "schema": { "type": "string" } }, { "name": "filter.comment", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrinterConnectionReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "patch": { "tags": [ "PrinterConnectionService" ], "operationId": "PATCHprintergateway_module_v1_printer_connection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectionReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_connection/{id}": { "get": { "tags": [ "PrinterConnectionService" ], "operationId": "GETprintergateway_module_v1_printer_connection_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrinterConnectionReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "PrinterConnectionService" ], "operationId": "DELETEprintergateway_module_v1_printer_connection_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_connector": { "post": { "tags": [ "PrinterConnectorService" ], "operationId": "POSTprintergateway_module_v1_printer_connector", "parameters": [ { "name": "printerConnector.id", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.printerName", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.address", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.scheme", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.port", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "printerConnector.printerType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType" } }, { "name": "printerConnector.physicalLocation", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.isEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "printerConnector.isOnline", "in": "query", "schema": { "type": "boolean" } }, { "name": "printerConnector.status", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.comment", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "printerConnector.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.CreatePrinterConnectorReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "get": { "tags": [ "PrinterConnectorService" ], "operationId": "GETprintergateway_module_v1_printer_connector", "parameters": [ { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.id", "in": "query", "schema": { "type": "string" } }, { "name": "order.printerName", "in": "query", "schema": { "type": "string" } }, { "name": "order.address", "in": "query", "schema": { "type": "string" } }, { "name": "order.scheme", "in": "query", "schema": { "type": "string" } }, { "name": "order.port", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "order.printerType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType" } }, { "name": "order.physicalLocation", "in": "query", "schema": { "type": "string" } }, { "name": "order.isEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.isOnline", "in": "query", "schema": { "type": "boolean" } }, { "name": "order.status", "in": "query", "schema": { "type": "string" } }, { "name": "order.comment", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "order.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.id", "in": "query", "schema": { "type": "string" } }, { "name": "filter.printerName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.address", "in": "query", "schema": { "type": "string" } }, { "name": "filter.scheme", "in": "query", "schema": { "type": "string" } }, { "name": "filter.port", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.printerType", "in": "query", "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType" } }, { "name": "filter.physicalLocation", "in": "query", "schema": { "type": "string" } }, { "name": "filter.isEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter.isOnline", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter.status", "in": "query", "schema": { "type": "string" } }, { "name": "filter.comment", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.CreatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.CreatedDateTimeUtc", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedByUserName", "in": "query", "schema": { "type": "string" } }, { "name": "filter.audit.UpdatedDateTimeUtc", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrinterConnectorReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "patch": { "tags": [ "PrinterConnectorService" ], "operationId": "PATCHprintergateway_module_v1_printer_connector", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectorRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectorReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_connector/{id}": { "get": { "tags": [ "PrinterConnectorService" ], "operationId": "GETprintergateway_module_v1_printer_connector_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrinterConnectorReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "PrinterConnectorService" ], "operationId": "DELETEprintergateway_module_v1_printer_connector_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printer_controller/v1/printer_controller/start": { "put": { "tags": [ "PrinterControllerService" ], "operationId": "PUTprinter_controller_v1_printer_controller_start", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printer_controller/v1/printer_controller/stop": { "put": { "tags": [ "PrinterControllerService" ], "operationId": "PUTprinter_controller_v1_printer_controller_stop", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printer_controller/v1/printer_controller/print_job": { "post": { "tags": [ "PrinterControllerService" ], "operationId": "POSTprinter_controller_v1_printer_controller_print_job", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printer_controller/v1/printer_controller/job_state": { "get": { "tags": [ "PrinterControllerService" ], "operationId": "GETprinter_controller_v1_printer_controller_job_state", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.JobStatusResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printer_controller/v1/printer_controller/printer_state": { "get": { "tags": [ "PrinterControllerService" ], "operationId": "GETprinter_controller_v1_printer_controller_printer_state", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrinterStatusResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printer_controller/v1/printer_controller/notifications": { "get": { "tags": [ "PrinterControllerService" ], "operationId": "GETprinter_controller_v1_printer_controller_notifications", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.NotificationsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/module_info": { "get": { "tags": [ "PrinterGatewayModuleInfoService" ], "operationId": "GETprintergateway_module_v1_module_info", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ModuleInfoReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/feature_flags": { "get": { "tags": [ "PrinterGatewayModuleInfoService" ], "operationId": "GETprintergateway_module_v1_feature_flags", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlagsReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/release_notes": { "get": { "tags": [ "PrinterGatewayModuleInfoService" ], "operationId": "GETprintergateway_module_v1_release_notes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ReleaseNotesReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/health_checks": { "get": { "tags": [ "PrinterGatewayModuleInfoService" ], "operationId": "GETprintergateway_module_v1_health_checks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthChecksReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/job_status_history": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_job_status_history", "parameters": [ { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrintJobStatusHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/job_status_history/{id}": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_job_status_history_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrintJobStatusHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/printer_status_history": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_printer_status_history", "parameters": [ { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrinterStatusHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/printer_status_history/{id}": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_printer_status_history_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrinterStatusHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/notification_history": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_notification_history", "parameters": [ { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListNotificationHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/notification_history/{id}": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_notification_history_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetNotificationHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/print_job_request_parameters_history": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_print_job_request_parameters_history", "parameters": [ { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "paging.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "paging.includeTotalSize", "in": "query", "schema": { "type": "boolean" } }, { "name": "descending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrintJobRequestParametersHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/printergateway_module/v1/printer_history/print_job_request_parameters_history/{id}": { "get": { "tags": [ "PrinterHistoryService" ], "operationId": "GETprintergateway_module_v1_printer_history_print_job_request_parameters_history_{id}", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "printerConnectorId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrintJobRequestParametersHistoryReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/recipe_module/v1/recipe": { "post": { "tags": [ "RecipeService" ], "operationId": "POSTrecipe_module_v1_recipe", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.CreateRecipeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.CreateRecipeReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "get": { "tags": [ "RecipeService" ], "operationId": "GETrecipe_module_v1_recipe", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.ListRecipeReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "patch": { "tags": [ "RecipeService" ], "operationId": "PATCHrecipe_module_v1_recipe", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.UpdateRecipeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.UpdateRecipeReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/recipe_module/v1/recipe/{name}": { "get": { "tags": [ "RecipeService" ], "operationId": "GETrecipe_module_v1_recipe_{name}", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.GetRecipeReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "RecipeService" ], "operationId": "DELETErecipe_module_v1_recipe_{name}", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Empty" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/variable_module/v1/variable/{id}": { "get": { "tags": [ "VariableService" ], "operationId": "GETvariable_module_v1_variable_{id}", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.GetVariableReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/variable_module/v1/variable": { "get": { "tags": [ "VariableService" ], "operationId": "GETvariable_module_v1_variable", "parameters": [ { "name": "connection-id", "in": "header", "description": "The required PrinterController ConnectionId to be supplied to target a specific printer.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.ListVariableReply" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } } }, "components": { "schemas": { "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlag": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "boolean" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlagsReply": { "type": "object", "properties": { "featureFlags": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.FeatureFlag" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthCheck": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthStatus" }, "moduleName": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthChecksReply": { "type": "object", "properties": { "healthChecks": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthCheck" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.HealthStatus": { "enum": [ "UNKNOWN", "HEALTHY", "DEGRADED", "UNHEALTHY", "HEALTHCHECKDISABLED" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Module": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Version" }, "shortDescription": { "type": "string" }, "description": { "type": "string" }, "protobuf": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ProtoBuf" } }, "openapi": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ModuleInfoReply": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Module" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ProtoBuf": { "type": "object", "properties": { "name": { "type": "string" }, "contents": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.ReleaseNotesReply": { "type": "object", "properties": { "releaseNote": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.ModuleInfo.Protos.V1.Version": { "type": "object", "properties": { "name": { "type": "string" }, "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" }, "build": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit": { "type": "object", "properties": { "CreatedByUserName": { "type": "string" }, "CreatedDateTimeUtc": { "type": "string" }, "UpdatedByUserName": { "type": "string" }, "UpdatedDateTimeUtc": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.CreatePrinterConnectionReply": { "type": "object", "properties": { "printerConnection": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.CreatePrinterConnectionRequest": { "type": "object", "properties": { "printerConnection": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.CreatePrinterConnectorReply": { "type": "object", "properties": { "printerConnector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetNotificationHistoryReply": { "type": "object", "properties": { "notificationHistory": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.NotificationHistory" }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrintJobRequestParametersHistoryReply": { "type": "object", "properties": { "printJobRequestParametersHistory": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrintJobRequestParametersHistory" }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrintJobStatusHistoryReply": { "type": "object", "properties": { "jobStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.JobStatusHistory" }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrinterConnectionReply": { "type": "object", "properties": { "printerConnection": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrinterConnectorReply": { "type": "object", "properties": { "printerConnector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.GetPrinterStatusHistoryReply": { "type": "object", "properties": { "printerStatusHistory": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterStatusHistory" }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.JobStatusHistory": { "type": "object", "properties": { "jobStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.JobStatusResponse" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListNotificationHistoryReply": { "type": "object", "properties": { "notificationHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.NotificationHistory" } }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrintJobRequestParametersHistoryReply": { "type": "object", "properties": { "printJobRequestParametersHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrintJobRequestParametersHistory" } }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrintJobStatusHistoryReply": { "type": "object", "properties": { "jobStatusHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.JobStatusHistory" } }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrinterConnectionReply": { "type": "object", "properties": { "printerConnections": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection" } }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrinterConnectorReply": { "type": "object", "properties": { "printerConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.ListPrinterStatusHistoryReply": { "type": "object", "properties": { "printerStatusHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterStatusHistory" } }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.NotificationHistory": { "type": "object", "properties": { "notification": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Notification" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrintJobRequestParametersHistory": { "type": "object", "properties": { "printJobRequestParameters": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobRequestParameters" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection": { "type": "object", "properties": { "id": { "type": "string" }, "connectorId": { "type": "string" }, "connector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" }, "name": { "type": "string" }, "comment": { "type": "string" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector": { "type": "object", "properties": { "id": { "type": "string" }, "printerName": { "type": "string" }, "address": { "type": "string" }, "scheme": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "printerType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType" }, "physicalLocation": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isOnline": { "type": "boolean" }, "status": { "type": "string" }, "comment": { "type": "string" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterStatusHistory": { "type": "object", "properties": { "printerStatus": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrinterStatus" }, "audit": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Audit.Protos.V1.Audit" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterType": { "enum": [ "PRINTERTYPE_UNKNOWN", "PRINTERTYPE_DIGI_COMPACT", "PRINTERTYPE_DIGI_COMPACT_HC", "PRINTERTYPE_DIGI_7", "PRINTERTYPE_DIGI_MINI", "PRINTERTYPE_DIGI_COMPACT_SIMULATOR", "PRINTERTYPE_DIGI_TESTBED" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectionReply": { "type": "object", "properties": { "printerConnection": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectionRequest": { "type": "object", "properties": { "printerConnection": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnection" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectorReply": { "type": "object", "properties": { "printerConnector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.UpdatePrinterConnectorRequest": { "type": "object", "properties": { "printerConnector": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.PrinterGateway.Protos.V1.PrinterConnector" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.CreateRecipeReply": { "type": "object", "properties": { "recipe": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.CreateRecipeRequest": { "type": "object", "properties": { "recipe": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.DataType": { "enum": [ "DATA_TYPE_UNKNOWN", "DATA_TYPE_BOOLEAN", "DATA_TYPE_NULLABLE_BOOLEAN", "DATA_TYPE_INTEGER", "DATA_TYPE_FLOAT", "DATA_TYPE_STRING", "DATA_TYPE_DATE", "DATA_TYPE_DATE_TIME", "DATA_TYPE_TIME", "DATA_TYPE_UNSIGNED_INTEGER", "DATA_TYPE_SHORT", "DATA_TYPE_OBJECT" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.FileType": { "enum": [ "FileType_Unknown", "FileType_PDF", "FileType_ISI", "FileType_TIFF", "FileType_DJOB", "FileType_BMP", "FileType_PNG", "FileType_ZIP" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.GetRecipeReply": { "type": "object", "properties": { "recipe": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.GetVariableReply": { "type": "object", "properties": { "variable": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Variable" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.JobStatus": { "enum": [ "JobStatus_Unknown", "JobStatus_Idle", "JobStatus_Queued", "JobStatus_Active", "JobStatus_Printing", "JobStatus_Finished", "JobStatus_Canceled", "JobStatus_Error" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.JobStatusResponse": { "type": "object", "properties": { "jobId": { "type": "string" }, "jobName": { "type": "string" }, "status": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.JobStatus" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.ListRecipeReply": { "type": "object", "properties": { "recipes": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe" } }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.ListVariableReply": { "type": "object", "properties": { "variables": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Variable" } }, "paging": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.PrintManager.Paging.Protos.V1.PagingReply" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Notification": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.NotificationType" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "componentName": { "type": "string" }, "content": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.NotificationType": { "enum": [ "NotificationType_Unknown", "NotificationType_Info", "NotificationType_Warning", "NotificationType_Error" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.NotificationsResponse": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Notification" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintFile": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.FileType" }, "fileData": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobMode": { "type": "object", "properties": { "printMode": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintMode" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobRequest": { "type": "object", "properties": { "job": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintFile" }, "parameters": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobRequestParameters" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobRequestParameters": { "type": "object", "properties": { "jobTemplateId": { "type": "string" }, "jobTemplateCustomerReference": { "type": "string" }, "enabledLayers": { "type": "integer", "format": "int32" }, "enabledProducts": { "type": "integer", "format": "int64" }, "enabledSides": { "type": "integer", "format": "int32" }, "printJobMode": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobMode" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintJobResponse": { "type": "object", "properties": { "jobId": { "type": "string" }, "jobName": { "type": "string" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrintMode": { "enum": [ "PrintMode_Unknown", "PrintMode_Single", "PrintMode_Batch", "PrintMode_Continuous" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrinterStatus": { "enum": [ "PrinterStatus_Unknown", "PrinterStatus_Idle", "PrinterStatus_Starting", "PrinterStatus_Started", "PrinterStatus_Stopping", "PrinterStatus_Stopped", "PrinterStatus_Error" ], "type": "string" }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrinterStatusResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.PrinterStatus" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "createdDateTime": { "type": "string" }, "name": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Variable" } } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.UpdateRecipeReply": { "type": "object", "properties": { "recipe": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.UpdateRecipeRequest": { "type": "object", "properties": { "recipe": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Recipe" } }, "additionalProperties": false }, "Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.Variable": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dataType": { "$ref": "#/components/schemas/Bergstein.Digi.Shared.Interfaces.Printer.Protos.V1.DataType" }, "category": { "type": "string" }, "component": { "type": "string" }, "eventlog": { "type": "boolean" }, "datalog": { "type": "boolean" }, "recipe": { "type": "boolean" }, "configuration": { "type": "boolean" }, "value": { "type": "string" } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Any": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" } }, "Google.Protobuf.WellKnownTypes.Empty": { "type": "object", "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.ListValue": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.NullValue": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "Google.Protobuf.WellKnownTypes.Struct": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Value": { "type": "object", "properties": { "nullValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.NullValue" }, "hasNullValue": { "type": "boolean", "readOnly": true }, "numberValue": { "type": "number", "format": "double" }, "hasNumberValue": { "type": "boolean", "readOnly": true }, "stringValue": { "type": "string", "nullable": true }, "hasStringValue": { "type": "boolean", "readOnly": true }, "boolValue": { "type": "boolean" }, "hasBoolValue": { "type": "boolean", "readOnly": true }, "structValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Struct" }, "listValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.ListValue" }, "kindCase": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value.KindOneofCase" } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Value.KindOneofCase": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Google.Rpc.Status": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Any" } } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Please enter a valid token!", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "PrinterConnectionService" }, { "name": "PrinterConnectorService" }, { "name": "PrinterControllerService" }, { "name": "PrinterGatewayModuleInfoService" }, { "name": "PrinterHistoryService" }, { "name": "RecipeService" }, { "name": "VariableService" } ] }