{ "openapi": "3.0.1", "info": { "title": "ThermalLabel Web API", "description": "[ThermalLabel Web API](https://neodynamic.com/products/printing/thermal-label/docker) generates advanced barcode labels supporting data merging, expressions/formulas, and conversion to printer commands like Zebra ZPL & EPL, EPSON ESC/POS, Honeywell-Intermec Fingerprint/DirectProtocol, HP PCL as well as exporting to PDF, SVG, PNG, JPG, PCX and HTML formats.", "contact": { "name": "Neodynamic", "url": "https://neodynamic.com/support", "email": "" }, "license": { "name": "Use under Neodynamic EULA", "url": "https://neodynamic.com/eula" }, "version": "v7" }, "paths": { "/Items/BarcodeItem": { "get": { "tags": [ "Items" ], "summary": "Returns a BarcodeItem.", "operationId": "getBarcodeItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarcodeItem" } } } } } } }, "/Items/TextItem": { "get": { "tags": [ "Items" ], "summary": "Returns a TextItem.", "operationId": "getTextItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextItem" } } } } } } }, "/Items/ImageItem": { "get": { "tags": [ "Items" ], "summary": "Returns an ImageItem.", "operationId": "getImageItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageItem" } } } } } } }, "/Items/RectangleShapeItem": { "get": { "tags": [ "Items" ], "summary": "Returns a RectangleShapeItem.", "operationId": "getRectangleShapeItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RectangleShapeItem" } } } } } } }, "/Items/CircleShapeItem": { "get": { "tags": [ "Items" ], "summary": "Returns a CircleShapeItem.", "operationId": "getCircleShapeItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CircleShapeItem" } } } } } } }, "/Items/EllipseShapeItem": { "get": { "tags": [ "Items" ], "summary": "Returns a EllipseShapeItem.", "operationId": "getEllipseShapeItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EllipseShapeItem" } } } } } } }, "/Items/LineShapeItem": { "get": { "tags": [ "Items" ], "summary": "Returns a LineShapeItem.", "operationId": "getLineShapeItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineShapeItem" } } } } } } }, "/Items/LiteralItem": { "get": { "tags": [ "Items" ], "summary": "Returns a LiteralItem.", "operationId": "getLiteralItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiteralItem" } } } } } } }, "/Items/RFIDTagItem": { "get": { "tags": [ "Items" ], "summary": "Returns a RFIDTagItem.", "operationId": "getRFIDTagItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RFIDTagItem" } } } } } } }, "/Items/RepeaterItem": { "get": { "tags": [ "Items" ], "summary": "Returns a RepeaterItem.", "operationId": "getRepeaterItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeaterItem" } } } } } } }, "/Items/TableShapeItem": { "get": { "tags": [ "Items" ], "summary": "Returns a TableShapeItem.", "operationId": "getTableShapeItem", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableShapeItem" } } } } } } }, "/Items/TableColumn": { "get": { "tags": [ "Items" ], "summary": "Returns a TableColumn.", "operationId": "getTableColumn", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableColumn" } } } } } } }, "/Items/TableRow": { "get": { "tags": [ "Items" ], "summary": "Returns a TableRow.", "operationId": "getTableRow", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableRow" } } } } } } }, "/ThermalLabel": { "get": { "tags": [ "ThermalLabel" ], "summary": "Returns a ThermalLabel.", "operationId": "getThermalLabel", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThermalLabel" } } } } } } }, "/ThermalLabel/ThermalLabelPage": { "get": { "tags": [ "ThermalLabel" ], "summary": "Returns a ThermalLabelPage.", "operationId": "getThermalLabelPage", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThermalLabelPage" } } } } } } }, "/ThermalLabel/ThermalLabelFont": { "get": { "tags": [ "ThermalLabel" ], "summary": "Returns a ThermalLabelFont.", "operationId": "getThermalLabelFont", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThermalLabelFont" } } } } } } }, "/ThermalLabel/Convert": { "post": { "tags": [ "ThermalLabel" ], "summary": "Converts a ThermalLabel template to Printer Commands, Images, and Documents formats.", "operationId": "Convert", "requestBody": { "description": "The conversion data including the ThermalLabel template and related info.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConvertData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConvertData" } } } }, "responses": { "200": { "description": "Returns the conversion output for the specified ThermalLabel template.", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml": { "schema": { "type": "string", "format": "binary" } }, "image/vnd.zbrush.pcx": { "schema": { "type": "string", "format": "binary" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "text/html": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.zpl": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.epl": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.fingerprint": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.dp": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.escpos": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.hp-pcl": { "schema": { "type": "string", "format": "binary" } }, "image/png+json": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg+json": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml+json": { "schema": { "type": "string", "format": "binary" } }, "image/vnd.zbrush.pcx+json": { "schema": { "type": "string", "format": "binary" } }, "application/pdf+json": { "schema": { "type": "string", "format": "binary" } }, "text/html+json": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.zpl+json": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.epl+json": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.fingerprint+json": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.dp+json": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.escpos+json": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.hp-pcl+json": { "schema": { "type": "string", "format": "binary" } }, "image/png+zip": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg+zip": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml+zip": { "schema": { "type": "string", "format": "binary" } }, "image/vnd.zbrush.pcx+zip": { "schema": { "type": "string", "format": "binary" } }, "application/pdf+zip": { "schema": { "type": "string", "format": "binary" } }, "text/html+zip": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.zpl+zip": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.epl+zip": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.fingerprint+zip": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.dp+zip": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.escpos+zip": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.hp-pcl+zip": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "If an error occurs during the conversion process.", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/svg+xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/vnd.zbrush.pcx": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.zpl": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.epl": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.fingerprint": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.dp": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.escpos": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.hp-pcl": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/svg+xml+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/vnd.zbrush.pcx+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/html+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.zpl+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.epl+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.fingerprint+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.dp+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.escpos+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.hp-pcl+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/svg+xml+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/vnd.zbrush.pcx+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/html+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.zpl+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.epl+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.fingerprint+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.dp+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.escpos+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/vnd.hp-pcl+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ThermalLabel/Thumbnail": { "post": { "tags": [ "ThermalLabel" ], "summary": "Creates a thumbnail image of a ThermalLabel document.", "operationId": "Thumbnail", "requestBody": { "description": "The thumbnail data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThumbnailData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThumbnailData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ThumbnailData" } } } }, "responses": { "200": { "description": "Returns the thumbnail image for the specified ThermalLabel document.", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml": { "schema": { "type": "string", "format": "binary" } }, "image/png+json": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg+json": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml+json": { "schema": { "type": "string", "format": "binary" } }, "image/png+zip": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg+zip": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml+zip": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "If an error occurs during the thumbnail generation.", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/svg+xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/svg+xml+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/svg+xml+zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ThermalLabelEditor": { "get": { "tags": [ "ThermalLabelEditor" ], "summary": "Process the ThermalLabel Editor requests.", "operationId": "getEditor", "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "ThermalLabelEditor" ], "summary": "Process the ThermalLabel Editor requests.", "operationId": "Editor", "responses": { "200": { "description": "Success" } } } } }, "components": { "schemas": { "BarcodeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "text": { "type": "string", "description": "The additional text to show in the barcode image e.g. 'Product ID'. Note: This is not the value to encode. Default value is an empty string.", "nullable": true, "example": "" }, "barColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The bars' color of the barcode. Default value is Black." }, "barColorHex": { "type": "string", "description": "The bars' background color in hex notation.", "nullable": true, "example": "" }, "barHeight": { "type": "number", "description": "The bars' height of the barcode. Default value is 0.5", "format": "double", "example": 0.5 }, "barWidth": { "type": "number", "description": "The narrow bars' width of the barcode. In barcode terminology this is X value. Default value is 0.0104", "format": "double", "example": 0.0104 }, "barRatio": { "type": "number", "description": "The wide bars' width compared to the narrow bars' width. In barcode terminology this is N value. Default value is 2", "format": "double", "example": 2 }, "rotationAngle": { "type": "integer", "description": "The rotation angle, in 90 degrees increments only, to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "codabarStartChar": { "enum": [ "A", "B", "C", "D" ], "type": "string", "description": "The start character for Codabar symbology. Possible values are: A, B, C or D. Default value is A" }, "codabarStopChar": { "enum": [ "A", "B", "C", "D" ], "type": "string", "description": "The stop character for Codabar symbology. Possible values are: A, B, C or D. Default value is A" }, "displayStartStopChar": { "type": "boolean", "description": "Whether start and stop characters must be displayed on the barcode. Default value is true", "example": true }, "code": { "type": "string", "description": "The value to encode. Default value is \"1234567890\"", "nullable": true }, "codeEncoding": { "enum": [ "Text", "Base64", "Hex" ], "type": "string", "description": "The character encoding format of the Code property value. Default value is Text" }, "addChecksum": { "type": "boolean", "description": "Whether checksum must be calculated and attached to the value to encode. Default value is true", "example": true }, "eanUpcGuardBar": { "type": "boolean", "description": "Whether guard bars must be drawn for EAN and UPC symbologies. Default value is true", "example": true }, "eanUpcGuardBarHeight": { "type": "number", "description": "The guard bars' height. In general, this value should be a bit greater than the BarHeight property. Default value is 0.55", "format": "double", "example": 0.55 }, "code128CharSet": { "enum": [ "Auto", "A", "B", "C" ], "type": "string", "description": "The characters set to use in the Code 128 symbology. Possible values are: Auto, A, B or C. Default value is Auto" }, "planetHeightTallBar": { "type": "number", "description": "The tall bars' height of Planet symbology. Default value is 0.2", "format": "double", "example": 0.2 }, "planetHeightShortBar": { "type": "number", "description": "The short bars' height of Planet symbology. Default value is 0.1", "format": "double", "example": 0.1 }, "postnetHeightTallBar": { "type": "number", "description": "The tall bars' height of Postnet symbology. Default value is 0.2", "format": "double", "example": 0.2 }, "postnetHeightShortBar": { "type": "number", "description": "The short bars' height of Postnet symbology. Default value is 0.1", "format": "double", "example": 0.1 }, "symbology": { "enum": [ "Codabar", "Code11", "Code16k", "Code39", "Code93", "Code128", "DataMatrix", "Ean8", "Ean13", "Industrial2of5", "Interleaved2of5", "Isbn", "Msi", "Pdf417", "Planet", "Postnet", "UccEan128", "UpcA", "UpcE", "UspsOneCode4CB", "RoyalMail", "AustraliaPost", "RoyalTpgPostKix", "Sscc18", "Pzn", "DeutschePostLeitcode", "DeutschePostIdentcode", "UspsTrayLabel", "UspsSackLabel", "EanVelocity", "SingaporePost", "Jan8", "Jan13", "SwissPostParcel", "Opc", "Ean99", "Itf14", "Scc14", "Issn", "Ismn", "NumlyNumber", "QRCode", "UspsFim", "UspsHorizontalBars", "Telepen", "Pharmacode", "Semacode", "Code32", "UspsPicUccEan128", "FedExGround96", "AztecCode", "CompactPdf417", "MacroPdf417", "MicroPdf417", "VicsBol", "VicsScacPro", "ItalianPost25", "Isbt128", "HibcLic39", "HibcLic128", "HibcPas39", "HibcPas128", "UspsIntelligentMail", "EanUpcAddOn2", "EanUpcAddOn5", "UspsPicCode128", "GS1DataBarOmnidirectional", "GS1DataBar14", "Rss14", "GS1DataBarTruncated", "GS1DataBar14Truncated", "Rss14Truncated", "GS1DataBarStacked", "GS1DataBar14Stacked", "Rss14Stacked", "GS1DataBarStackedOmnidirectional", "GS1DataBar14StackedOmnidirectional", "Rss14StackedOmnidirectional", "GS1DataBarLimited", "RssLimited", "GS1DataBarExpanded", "RssExpanded", "GS1DataBarExpandedStacked", "RssExpandedStacked", "GS1128", "MaxiCode", "MicroQRCode", "Matrix2of5", "DanishPostal39", "FrenchPostal39AR", "IATA2of5", "AustraliaPostDomesticEParcelBarcode", "UspsIntelligentMailContainerBarcode", "KodakPatchCode", "GS1DataMatrix", "Ean13CCA", "Ean13CCB", "Ean8CCA", "Ean8CCB", "UpcACCA", "UpcACCB", "UpcECCA", "UpcECCB", "UccEan128CCA", "UccEan128CCB", "UccEan128CCC", "GS1128CCA", "GS1128CCB", "GS1128CCC", "GS1DataBarOmnidirectionalCCA", "GS1DataBar14CCA", "Rss14CCA", "GS1DataBarOmnidirectionalCCB", "GS1DataBar14CCB", "Rss14CCB", "GS1DataBarTruncatedCCA", "GS1DataBar14TruncatedCCA", "Rss14TruncatedCCA", "GS1DataBarTruncatedCCB", "GS1DataBar14TruncatedCCB", "Rss14TruncatedCCB", "GS1DataBarLimitedCCA", "RssLimitedCCA", "GS1DataBarLimitedCCB", "RssLimitedCCB", "GS1DataBarStackedCCA", "GS1DataBar14StackedCCA", "Rss14StackedCCA", "GS1DataBarStackedCCB", "GS1DataBar14StackedCCB", "Rss14StackedCCB", "GS1DataBarStackedOmnidirectionalCCA", "GS1DataBar14StackedOmnidirectionalCCA", "Rss14StackedOmnidirectionalCCA", "GS1DataBarStackedOmnidirectionalCCB", "GS1DataBar14StackedOmnidirectionalCCB", "Rss14StackedOmnidirectionalCCB", "GS1DataBarExpandedCCA", "RssExpandedCCA", "GS1DataBarExpandedCCB", "RssExpandedCCB", "GS1DataBarExpandedStackedCCA", "RssExpandedStackedCCA", "GS1DataBarExpandedStackedCCB", "RssExpandedStackedCCB", "Ean14", "Dun14Itf", "Dun14Ean", "GS1QRCode", "Ppn", "IFAsecurPharm", "DhlAwb", "HibcLicDataMatrix", "HibcLicQRCode", "HibcLicAztecCode", "HibcPasDataMatrix", "HibcPasQRCode", "HibcPasAztecCode", "Isbt128DataMatrix", "DeutschePostResponsePlusPostMatrix", "DeutschePostBzl", "UspsIntelligentMailPackageBarcode", "HanXinCode", "JapanPost", "KoreaPost", "DataLogic2of5", "MailmarkCMDM", "Mailmark4StateC", "Mailmark4StateL", "DotCode", "GS1AztecCode", "SwissQRCode", "Plessey", "EPCQRCode", "Code49", "CodablockF", "Tlc39", "HibcLicCodablockF", "HibcPasCodablockF", "TriOptic", "DINSpecQRCode", "DINSpecDataMatrix", "RectMicroQRCode", "GS1RectMicroQRCode", "DPDCode", "DAFT" ], "type": "string", "description": "The barcode symbology/standard to generate. Default value is Code39" }, "quietZone": { "$ref": "#/components/schemas/FrameThickness" }, "displayChecksum": { "type": "boolean", "description": "Whether checksum value must be displayed after the value to encode on the barcode. Default value is true", "example": true }, "displayCode": { "type": "boolean", "description": "Whether the value to encode must be displayed on the barcode. Default value is true", "example": true }, "textAlignment": { "enum": [ "AboveCenter", "AboveLeft", "AboveRight", "AboveJustify", "BelowCenter", "BelowLeft", "BelowRight", "BelowJustify" ], "type": "string", "description": "The text alignment for Text property. Default value is AboveCenter" }, "codeAlignment": { "enum": [ "AboveCenter", "AboveLeft", "AboveRight", "AboveJustify", "BelowCenter", "BelowLeft", "BelowRight", "BelowJustify" ], "type": "string", "description": "The text alignment for Code property. Default value is BelowCenter" }, "code16kMode": { "enum": [ "Mode0", "Mode1", "Mode2" ], "type": "string", "description": "The mode to use for Code16k symbology. Modes supported are: Mode 0, 1, and 2. Default value is Mode1" }, "code39FullAsciiMode": { "type": "boolean", "description": "Whether the Full ASCII mode (a.k.a. Extended version) for Code 39 symbology should be used. Default value is true", "example": true }, "code93FullAsciiMode": { "type": "boolean", "description": "Whether the Full ASCII mode (a.k.a. Extended version) for Code 93 symbology should be used. Default value is true", "example": true }, "dataMatrixModuleSize": { "type": "number", "description": "The Data Matrix module size. The module is each indivual black square which composes the whole of Data Matrix symbol. Default value is 0.0417", "format": "double", "example": 0.0417 }, "dataMatrixProcessTilde": { "type": "boolean", "description": "Whether tilde character '~' should be processed when Data Matrix code is being generated. Default value is false", "example": false }, "dataMatrixFormat": { "enum": [ "Auto", "AutoDMRE", "C10X10", "C12X12", "C8X18", "C14X14", "C8X32", "C16X16", "C12X26", "C18X18", "C20X20", "C12X36", "C22X22", "C16X36", "C24X24", "C26X26", "C16X48", "C32X32", "C36X36", "C40X40", "C44X44", "C48X48", "C52X52", "C64X64", "C72X72", "C80X80", "C88X88", "C96X96", "C104X104", "C120X120", "C132X132", "C144X144", "DMRE8X48", "DMRE8X64", "DMRE12X64", "DMRE24X32", "DMRE26X32", "DMRE24X36", "DMRE16X64", "DMRE26X40", "DMRE24X48", "DMRE26X48", "DMRE24X64", "DMRE26X64" ], "type": "string", "description": "The Data Matrix Format to use on that symbology. Default value is Auto" }, "dataMatrixEncoding": { "enum": [ "Auto", "Ascii", "C40", "Text", "Base256", "AnsiX12", "EDIFACT" ], "type": "string", "description": "The Data Matrix Encoding to use on that symbology. Default value is Auto" }, "eanUpcSupplement": { "enum": [ "None", "Digits2", "Digits5" ], "type": "string", "description": "The supplement type to use with EAN and UPC symbologies. Default value is None" }, "eanUpcSupplementTopMargin": { "type": "number", "description": "The height of the margin above the EAN/UPC supplement bars. Default value is 0.15", "format": "double", "example": 0.15 }, "eanUpcSupplementSeparation": { "type": "number", "description": "The gap separation between the barcode and its supplement. Default value is 0.15", "format": "double", "example": 0.15 }, "eanUpcSupplementCode": { "type": "string", "description": "The supplement value for EAN and UPC symbologies. Default value is \"0\"", "nullable": true }, "upcESystem": { "enum": [ "System0", "System1" ], "type": "string", "description": "The number system to use for UPC-E symbology. Default value is System0" }, "pdf417Rows": { "type": "integer", "description": "The number of rows to use for PDF417 symbology. Default value is 0 (Auto)", "format": "int32", "example": 0 }, "pdf417Columns": { "type": "integer", "description": "The number of columns to use for PDF417 symbology. Default value is (Auto)", "format": "int32" }, "pdf417ErrorCorrectionLevel": { "enum": [ "Level0", "Level1", "Level2", "Level3", "Level4", "Level5", "Level6", "Level7", "Level8" ], "type": "string", "description": "The Error Correction Level to apply for PDF417 symbology. Default value is Level2" }, "pdf417CompactionType": { "enum": [ "Auto", "Binary", "Text", "Numeric" ], "type": "string", "description": "The Compaction Type to apply for PDF417 symbology. Default value is Auto" }, "pdf417Truncated": { "type": "boolean", "description": "Whether the right side of PDF417 barcode is truncated (removed). Default value is false", "example": false }, "pdf417ProcessTilde": { "type": "boolean", "description": "Whether tilde character '~' should be processed when PDF417 code is being generated. Default value is false", "example": false }, "pdf417ByteEncodingName": { "type": "string", "description": "The Encoding Name (Code Page) to be used for PDF417 Byte Compaction mode. Default value is \"ISO-8859-1\".", "nullable": true }, "postal4StateTrackerBarHeight": { "type": "number", "description": "The tracker bar's height. Default value is 0.08", "format": "double", "example": 0.08 }, "postal4StateTrackerBarWidth": { "type": "number", "description": "The tracker bar's width. Default value is 0.0208", "format": "double", "example": 0.0208 }, "postal4StateBarsSpacing": { "type": "number", "description": "The gap spacing between bars. Default value is 0.0313", "format": "double", "example": 0.0313 }, "postal4StateAddStartStopChar": { "type": "boolean", "description": "Whether start and stop characters must be added and drawn on the barcode. Default value is true", "example": true }, "bearerBarStyle": { "enum": [ "None", "Frame", "HorizontalRules" ], "type": "string", "description": "Gets or set the bearer bars' type that must be drawn with the barcode. Bearer bar is only available for 2 of 5, Code 128 and UCC.EAN 128 barcodes. Default value is None" }, "bearerBarThickness": { "type": "number", "description": "The bearer bars' thickness. Default value is 0.05", "format": "double", "example": 0.05 }, "eanUpcDisplayLightMarginIndicator": { "type": "boolean", "description": "Whether light margin indicators must be displayed in the EAN/UPC barcodes. Default value is false", "example": false }, "qRCodeModuleSize": { "type": "number", "description": "The QR Code module size. The module is each indivual black square which composes the whole of QR Code symbol. Default value is 0.0417", "format": "double", "example": 0.0417 }, "qRCodeEncoding": { "enum": [ "Auto", "Numeric", "AlphaNumeric", "Kanji", "Byte" ], "type": "string", "description": "The QR Code Encoding to use on that symbology. Default value is Auto" }, "qRCodeByteEncodingName": { "type": "string", "description": "The Encoding Name (Code Page) to be used for QR Code Byte Compaction mode. Default value is \"ISO-8859-1\"", "nullable": true }, "qRCodeErrorCorrectionLevel": { "enum": [ "L", "M", "Q", "H" ], "type": "string", "description": "The Error Correction Level to apply for QR Code symbology. Default value is M" }, "qRCodeVersion": { "enum": [ "Auto", "V01", "V02", "V03", "V04", "V05", "V06", "V07", "V08", "V09", "V10", "V11", "V12", "V13", "V14", "V15", "V16", "V17", "V18", "V19", "V20", "V21", "V22", "V23", "V24", "V25", "V26", "V27", "V28", "V29", "V30", "V31", "V32", "V33", "V34", "V35", "V36", "V37", "V38", "V39", "V40" ], "type": "string", "description": "The QR Code Version to use on that symbology. Default value is Auto" }, "qRCodeMask": { "enum": [ "Auto", "Mask0", "Mask1", "Mask2", "Mask3", "Mask4", "Mask5", "Mask6", "Mask7" ], "type": "string", "description": "The QR Code Mask pattern to use on that symbology. Default is Auto." }, "uspsFimPattern": { "enum": [ "A", "B", "C", "D" ], "type": "string", "description": "The USPS FIM pattern to use on that symbology. Default value is A" }, "uspsHorizontalBarsCount": { "type": "integer", "description": "The number of horizontal bars to be drawn. Default value is 10", "format": "int32", "example": 10 }, "telepenEncoding": { "enum": [ "Ascii", "Numeric" ], "type": "string", "description": "The Telepen Encoding to use on that symbology. Default value is Ascii" }, "pharmacodeThinBarWidth": { "type": "number", "description": "The width of Pharmacode Thin Bars. Default value is 0.0208", "format": "double", "example": 0.0208 }, "pharmacodeThickBarWidth": { "type": "number", "description": "The width of Pharmacode Thick Bars. Default value is 0.0625", "format": "double", "example": 0.0625 }, "pharmacodeBarsSpacing": { "type": "number", "description": "The gap between Pharmacode bars. Default value is 0.0417", "format": "double", "example": 0.0417 }, "backColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The background color of the barcode. Default value is White" }, "backColorHex": { "type": "string", "description": "The background color of the barcode in hex notation.", "nullable": true, "example": "" }, "font": { "$ref": "#/components/schemas/Font" }, "foreColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The foreground color of the value to encode. Default value is Black" }, "foreColorHex": { "type": "string", "description": "The foreground color of the value to encode in hex notation.", "nullable": true, "example": "" }, "textFont": { "$ref": "#/components/schemas/Font" }, "textForeColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The foreground color of the text. Default value is Black" }, "textForeColorHex": { "type": "string", "description": "The foreground color of the text in hex notation.", "nullable": true, "example": "" }, "aztecCodeModuleSize": { "type": "number", "description": "The Aztec Code module size. The module is each indivual black square which composes the whole of Aztec Code symbol. Default value is 0.0417", "format": "double", "example": 0.0417 }, "aztecCodeFormat": { "enum": [ "Auto", "C15X15Compact", "C19X19", "C19X19Compact", "C23X23", "C23X23Compact", "C27X27", "C27X27Compact", "C31X31", "C37X37", "C41X41", "C45X45", "C49X49", "C53X53", "C57X57", "C61X61", "C67X67", "C71X71", "C75X75", "C79X79", "C83X83", "C87X87", "C91X91", "C95X95", "C101X101", "C105X105", "C109X109", "C113X113", "C117X117", "C121X121", "C125X125", "C131X131", "C135X135", "C139X139", "C143X143", "C147X147", "C151X151" ], "type": "string", "description": "The Aztec Code Format to use on that symbology. Default value is Auto" }, "aztecCodeErrorCorrection": { "type": "integer", "description": "The Error Correction Percentage to apply for Aztec Code symbology. Default value is 23.", "format": "int32", "example": 23 }, "aztecCodeRune": { "type": "integer", "description": "The Aztec Code Rune value. It must be a value from 0 to 255 and is available for Aztec Code Compact Format only. Default value is -1 (disabled)", "format": "int32", "example": -1 }, "aztecCodeByteEncodingName": { "type": "string", "description": "The Encoding Name (Code Page) to be used for Aztec Code symbology. Default value is \"ISO-8859-1\"", "nullable": true }, "pdf417SegmentIndex": { "type": "integer", "description": "The Segment Index for a Macro PDF417 symbol. Its value must be 0 (zero) up to 99998 and must be less than the value in Pdf417SegmentCount property. Default value is 0 (zero)", "format": "int32", "example": 0 }, "pdf417SegmentCount": { "type": "integer", "description": "The number of Macro PDF417 symbols. Its value must be less than or equal to 99999. Default value is 0 (zero)", "format": "int32", "example": 0 }, "pdf417FileId": { "type": "string", "description": "The File ID of the Macro PDF417 symbol. Its value must be a sequence of codewords (Each codeword value must be a number between 000 and 899) and must be the same for all data segments. Default value is \"000\"", "nullable": true }, "pdf417AspectRatio": { "type": "number", "description": "The ratio of the height to the overall width of the PDF417 symbol. Its value must be 0 (zero) up to 1 (one). Default value is 0 (zero)", "format": "double", "example": 0 }, "microPdf417Version": { "enum": [ "Auto", "V1X11", "V1X14", "V1X17", "V1X20", "V1X24", "V1X28", "V2X8", "V2X11", "V2X14", "V2X17", "V2X20", "V2X23", "V2X26", "V3X6", "V3X8", "V3X10", "V3X12", "V3X15", "V3X20", "V3X26", "V3X32", "V3X38", "V3X44", "V4X4", "V4X6", "V4X8", "V4X10", "V4X12", "V4X15", "V4X20", "V4X26", "V4X32", "V4X38", "V4X44" ], "type": "string", "description": "The MicroPDF417 version (a predefined combinations of numbers of columns and rows) to be generated. Default value is Auto" }, "isbt128DataStructure": { "enum": [ "DS001", "DS002", "DS003", "DS004", "DS005", "DS006", "DS007", "DS008", "DS009", "DS010", "DS011", "DS012", "DS013", "DS014", "DS015", "DS016", "DS017", "DS018", "DS019", "DS020", "DS021", "DS022", "DS023", "DS024", "DS025", "DS026", "DS027", "DS028", "DS029", "DS030", "DS031", "DS032", "DS033", "DS034" ], "type": "string", "description": "The ISBT 128 Data Structure to be generated. Default value is DS001" }, "hibcFormatHumanReadableText": { "type": "boolean", "description": "Whether the Human Readable Text is formatted as specified by HIBC Standards i.e. Zeros are displayed as Slashed-Zeros and the Space character is displayed as an Underscore. Default value is true", "example": true }, "useQuietZoneForText": { "type": "boolean", "description": "Whether quiet zones are used for drawing Text, Code and HumanReadableText properties. Default value is false", "example": false }, "barWidthAdjustment": { "type": "number", "description": "The Bar Width Adjustment. Default value is 0 (zero)", "format": "double", "example": 0 }, "humanReadableText": { "type": "string", "description": "The Human Readable Text to be displayed instead of the value to encode specified in the Code property. Default value is an empty string", "nullable": true, "example": "" }, "microQRCodeVersion": { "enum": [ "Auto", "M1", "M2", "M3", "M4" ], "type": "string", "description": "The Micro QR Code Version to use on that symbology. Default value is Auto" }, "msiChecksum": { "enum": [ "OneMod10", "TwoMod10", "Mod11AndMod10" ], "type": "string", "description": "The checksum mode to be used on MSI symbology. Default value is OneMod10" }, "segmentsPerRow": { "type": "integer", "description": "The number of segments per row to be used in GS1 DataBar Expanded Stacked or RSS Expanded Stacked symbologies. It must be an even number ranging from 2 up to 22. Default value is 4.", "format": "int32", "example": 4 }, "maxiCodeMode": { "enum": [ "Mode2", "Mode3", "Mode4", "Mode5", "Mode6" ], "type": "string", "description": "The MaxiCode mode. Default value is Mode4" }, "maxiCodeProcessTilde": { "type": "boolean", "description": "Whether tilde character '~' should be processed when MaxiCode code is being generated. Default value is false", "example": false }, "maxiCodeSymbolIndex": { "type": "integer", "description": "The Symbol Index for a Structured Appended MaxiCode. Its value must be 1 up to 8 and must be less than the value in MaxiCodeSymbolCount property. Default value is 1", "format": "int32", "example": 1 }, "maxiCodeSymbolCount": { "type": "integer", "description": "The number of MaxiCode symbols in a Structured Appended format. Its value must be less than or equal to 8. Default value is 1", "format": "int32", "example": 1 }, "aztecCodeProcessTilde": { "type": "boolean", "description": "Whether tilde character '~' should be processed when Aztec Code is being generated. Default value is false", "example": false }, "qRCodeProcessTilde": { "type": "boolean", "description": "Whether tilde character '~' should be processed when QR Code is being generated. Default value is false", "example": false }, "dataMatrixByteEncodingName": { "type": "string", "description": "The Encoding Name (Code Page) to be used for DataMatrix in Byte Compaction mode. Default value is \"ISO-8859-1\"", "nullable": true }, "dataMatrixSymbolCount": { "type": "integer", "description": "The number of Data Matrix symbols. Its value must be less than or equal to 16. Default value is 1", "format": "int32", "example": 1 }, "dataMatrixSymbolIndex": { "type": "integer", "description": "The Index for a Data Matrix symbol. Its value must be 1 up to 16 and must be less than or equal to the value in DataMatrixSegmentCount property. Default value is 1", "format": "int32", "example": 1 }, "dataMatrixFileId": { "type": "string", "description": "The File ID of the Data Matrix symbol. Its value must be a sequence of codewords (Each codeword value must be a number between 001 and 254) and must be the same for all data segments. Default value is \"001001\"", "nullable": true }, "sizing": { "enum": [ "None", "Fill", "FitProportional", "AutoSize" ], "type": "string", "description": "The barcode sizing. Default value is None" }, "barcodeAlignment": { "enum": [ "TopLeft", "TopCenter", "TopRight", "MiddleLeft", "MiddleCenter", "MiddleRight", "BottomLeft", "BottomCenter", "BottomRight" ], "type": "string", "description": "The barcode alignment. Default value is TopLeft" }, "cornerRadius": { "$ref": "#/components/schemas/RectangleCornerRadius" }, "borderThickness": { "$ref": "#/components/schemas/FrameThickness" }, "borderColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The color of the border of the rectangle container. Default value is Black" }, "borderColorHex": { "type": "string", "description": "The color of the border of the rectangle container in hex notation.", "nullable": true, "example": "" }, "barcodePadding": { "$ref": "#/components/schemas/FrameThickness" }, "width": { "type": "number", "description": "The width of the rectangle container. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the rectangle container. Default value is 0.5", "format": "double", "example": 0.5 }, "counterStep": { "type": "integer", "description": "The step for the counter. The counter will increase (positive) or decrease (negative) by this number on every printed label. Default value is 0 (zero)", "format": "int32", "example": 0 }, "counterUseLeadingZeros": { "type": "boolean", "description": "Whether leading zeros are printed or suppressed when using counters. Default value is false", "example": false }, "mask": { "type": "string", "description": "The input Mask for the value to encode. Default value is an empty string", "nullable": true, "example": "" }, "maskIncrement": { "type": "string", "description": "The mask increment. The increment is the value to be added to the value to encode on each label to be printed. Default value is an empty string", "nullable": true, "example": "" }, "hideIfEmpty": { "type": "boolean", "description": "Whether the barcode symbol is not displayed or printed if the value to encode is empty. Default value is false", "example": false }, "eanUpcMagnificationFactor": { "type": "number", "description": "The Magnification Factor for EAN/UPC barcodes. Default is 0 (Zero/Disabled).", "format": "float", "example": 0 }, "hibcUseIsoIec15434Encoding": { "type": "boolean", "description": "Whether the ISO/IEC 15434 Protocol is used to encode the HIBC LIC or PAS Data Structures in 2D symbols. Default is False.", "example": false }, "codeFormatPattern": { "type": "string", "description": "The string pattern to format the Code property. The result of the format process is the one which will be encoded! Based on String.Format(). Default value is empty (Disabled).", "nullable": true, "example": "" }, "textFormatPattern": { "type": "string", "description": "The string pattern to format the Text property. Based on String.Format(). Default value is empty (Disabled).", "nullable": true, "example": "" }, "hanXinCodeByteEncodingName": { "type": "string", "description": "The Encoding Name (Code Page) to be used for Han Xin Code Binary Byte Encoding mode. Default it ISO-8859-1.", "nullable": true, "example": "" }, "hanXinCodeEncoding": { "enum": [ "Auto", "Numeric", "Text", "BinaryByte", "ChineseReg1", "ChineseReg2", "GB18030Bytes2", "GB18030Bytes4" ], "type": "string", "description": "The Han Xin Code Encoding to use on that symbology. Default value is Auto" }, "hanXinCodeErrorCorrectionLevel": { "enum": [ "L1", "L2", "L3", "L4" ], "type": "string", "description": "The Error Correction Level to apply for Han Xin Code symbology. Default value is L1" }, "hanXinCodeVersion": { "enum": [ "Auto", "V01", "V02", "V03", "V04", "V05", "V06", "V07", "V08", "V09", "V10", "V11", "V12", "V13", "V14", "V15", "V16", "V17", "V18", "V19", "V20", "V21", "V22", "V23", "V24", "V25", "V26", "V27", "V28", "V29", "V30", "V31", "V32", "V33", "V34", "V35", "V36", "V37", "V38", "V39", "V40", "V41", "V42", "V43", "V44", "V45", "V46", "V47", "V48", "V49", "V50", "V51", "V52", "V53", "V54", "V55", "V56", "V57", "V58", "V59", "V60", "V61", "V62", "V63", "V64", "V65", "V66", "V67", "V68", "V69", "V70", "V71", "V72", "V73", "V74", "V75", "V76", "V77", "V78", "V79", "V80", "V81", "V82", "V83", "V84" ], "type": "string", "description": "The Han Xin Code Version to use on that symbology. Default value is Auto" }, "hanXinCodeModuleSize": { "type": "number", "description": "The module size. The unit of measure must be specified to BarcodeUnit property. Default value is 0.0417", "format": "double", "example": 0.0417 }, "hanXinCodeProcessTilde": { "type": "boolean", "description": "Whether tilde character should be processed when Han Xin Code is being generated. Default value is false", "example": false }, "itf14LeftHMark": { "enum": [ "None", "Mark1", "Mark2", "Mark3", "Mark4", "Mark5", "Mark6", "Mark7" ], "type": "string", "description": "The H mark type for the left side of ITF-14 barcode symbol. Default is None." }, "itf14RightHMark": { "enum": [ "None", "Mark1", "Mark2", "Mark3", "Mark4", "Mark5", "Mark6", "Mark7" ], "type": "string", "description": "The H mark type for the right side of ITF-14 barcode symbol. Default is None." }, "errorBehavior": { "enum": [ "BlankImage", "ThrowException" ], "type": "string", "description": "What output type BarcodeItem will generate if an error occurs during barcode rendering. Default is BlankImage." }, "gS1DataStrictValidation": { "type": "boolean", "description": "Whether to strictly validate the specified GS1 Element Strings i.e. Application Identifier plus Data Field based on GS1 General Specifications rules. Default is false.", "example": false }, "maxiCodeDrawPixelBasedSymbol": { "type": "boolean", "description": "Whether the MaxiCode symbol is drawn by using a Pixel Based method; otherwise, a Vector based method is used. Default value is true", "example": true }, "dotCodeModuleSize": { "type": "number", "description": "The module size. The unit of measure must be specified to BarcodeUnit property. Default value is 0.0417", "format": "double", "example": 0.0417 }, "dotCodeProcessTilde": { "type": "boolean", "description": "Whether tilde character should be processed when DotCode is being generated. Default value is false", "example": false }, "dotCodeColumns": { "type": "integer", "description": "The number of columns to use for DotCode symbology. Default is zero i.e. auto.", "format": "int32", "example": 0 }, "dotCodeRows": { "type": "integer", "description": "The number of rows to use for DotCode symbology. Default is zero i.e. auto.", "format": "int32", "example": 0 }, "dotCodeAspectRatio": { "type": "string", "description": "The Columns (width) to Rows (height) Aspect Ratio for DotCode symbology. Aspect Ratio must be specified as C:R where C and R are integers e.g. 3:2", "nullable": true, "example": "" }, "dotCodeModuleShape": { "enum": [ "Circle", "Square" ], "type": "string", "description": "The shape of the modules that make the DotCode barcode symbol. Default is Circle." }, "dataMatrixIncludeRectFormatsInAutoMode": { "type": "boolean", "description": "Whether to consider Rectangular DataMatrix Formats when DataMatrixFormat is set to Auto. Default is false.", "example": false }, "code11TwoDigitsChecksum": { "type": "boolean", "description": "Whether Code 11 two digits checksum must be calculated and encoded. Defauls is false." }, "tlc39MicroPdf417BarWidth": { "type": "number", "description": "The narrow bar width for TLC39's MicroPdf417 symbol. The unit of measure must be specified to BarcodeUnit property.", "format": "double" }, "tlc39MicroPdf417RowBarHeight": { "type": "number", "description": "The row bar height for TLC39's MicroPdf417 symbol. The unit of measure must be specified to BarcodeUnit property.", "format": "double" }, "rightToLeft": { "type": "boolean", "description": "Whether the human readable text should draw right-to-left for RTL languages. Default value is false", "example": false }, "rectMicroQRCodeVersion": { "enum": [ "Auto", "R7x43", "R7x59", "R7x77", "R7x99", "R7x139", "R9x43", "R9x59", "R9x77", "R9x99", "R9x139", "R11x27", "R11x43", "R11x59", "R11x77", "R11x99", "R11x139", "R13x27", "R13x43", "R13x59", "R13x77", "R13x99", "R13x139", "R15x43", "R15x59", "R15x77", "R15x99", "R15x139", "R17x43", "R17x59", "R17x77", "R17x99", "R17x139" ], "type": "string", "description": "The Rectangular Micro QR Code Version to use on that symbology. Default value is Auto" }, "artBarImagePattern": { "type": "string", "description": "The image file (path or Base64 string) that will be used as a pattern to fill all the bars that compose the barcode symbol.", "nullable": true, "example": "" }, "artLogoImage": { "type": "string", "description": "The logo image file (path or Base64 string) that will be used to stamp it on top or bottom of the barcode symbol.", "nullable": true, "example": "" }, "artLogoImagePosition": { "enum": [ "Top", "Bottom" ], "type": "string", "description": "The position of the logo image file on the barcode symbol. Default is Top." }, "artLogoImagePercentage": { "type": "integer", "description": "The percentage used to resize the logo image based on the barcode symbol size. Default is 20.", "format": "int32", "example": 20 }, "artLogoImageOpacity": { "type": "integer", "description": "The opacity [from 1 to 100 (fully opaque)] of the image logo file. Default is 100.", "format": "int32", "example": 100 }, "artModuleShape": { "enum": [ "Rect", "RoundRect", "Dot", "Circle", "ZebraHorizontal", "ZebraVertical", "Diamond" ], "type": "string", "description": "The barcode symbol modules/bars artistic shape. Default is Rect." }, "artFinderShape": { "enum": [ "Rect", "RoundRect", "Circle" ], "type": "string", "description": "The barcode symbol finders artistic shape. Default is Rect." }, "printAsResidentElement": { "type": "boolean", "description": "Whether the barcode is printed by using the resident command. Default is false.", "example": false } }, "additionalProperties": false, "description": "BarcodeItem" }, "CircleShapeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "strokeThickness": { "type": "number", "description": "The border thickness. Default value is 0.0104", "format": "double", "example": 0.0104 }, "strokeColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The border color. Default value is Black" }, "strokeColorHex": { "type": "string", "description": "The border color in hex notation.", "nullable": true, "example": "" }, "width": { "type": "number", "description": "The width of the shape item. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the shape item. Default value is 1", "format": "double", "example": 1 }, "strokeStyle": { "enum": [ "Solid", "Dash", "Dot" ], "type": "string", "description": "The stroke style. Default is Solid" }, "strokeStylePattern": { "type": "string", "description": "The stroke style pattern. The patter specifies the dash length, and the gap length separated by a pipe e.g. `0.2|0.1`. More than one pair of pattern is supported e.g. `0.1|0.2|0.1|0.5`. If empty, both patterns will be the value from StrokeThickness property. Default is empty", "nullable": true }, "fillColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The fill color. Default value is White which will produce a transparent fill." }, "fillColorHex": { "type": "string", "description": "The fill color in hex notation.", "nullable": true, "example": "" }, "rotationAngle": { "type": "integer", "description": "The rotation angle to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true } }, "additionalProperties": false, "description": "CircleShapeItem" }, "ConvertData": { "type": "object", "properties": { "thermalLabel": { "type": "string", "description": "The ThermalLabel template in XML, JSON or Base64 formats.", "default": "", "nullable": true }, "dataSource": { "type": "string", "description": "The data source in XML or JSON formats to merge with the specified ThermalLabel.", "default": "", "nullable": true, "example": "" }, "dpi": { "type": "integer", "description": "The output image resolution.", "format": "int32", "default": 96, "example": 96 }, "pageOrientation": { "enum": [ "Portrait", "Landscape90", "Portrait180", "Landscape270" ], "type": "string", "description": "The page orientation.", "default": "Portrait", "example": "Portrait" }, "copies": { "type": "integer", "description": "The number of print copies.", "format": "int32", "default": 1, "example": 1 }, "replicates": { "type": "integer", "description": "The number of print replicates.", "format": "int32", "default": 0, "example": 0 }, "pdfMetadata": { "$ref": "#/components/schemas/PdfMetadata" }, "scaleX": { "type": "number", "description": "The scaling factor in the X direction for Image conversion.", "format": "double", "default": 1, "example": 1 }, "scaleY": { "type": "number", "description": "The scaling factor in the Y direction for Image conversion.", "format": "double", "default": 1, "example": 1 } }, "additionalProperties": false, "description": "It specifies the ThermalLabel conversion data." }, "EllipseShapeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "strokeThickness": { "type": "number", "description": "The border thickness. Default value is 0.0104", "format": "double", "example": 0.0104 }, "strokeColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The border color. Default value is Black" }, "strokeColorHex": { "type": "string", "description": "The border color in hex notation.", "nullable": true, "example": "" }, "width": { "type": "number", "description": "The width of the shape item. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the shape item. Default value is 1", "format": "double", "example": 1 }, "strokeStyle": { "enum": [ "Solid", "Dash", "Dot" ], "type": "string", "description": "The stroke style. Default is Solid" }, "strokeStylePattern": { "type": "string", "description": "The stroke style pattern. The patter specifies the dash length, and the gap length separated by a pipe e.g. `0.2|0.1`. More than one pair of pattern is supported e.g. `0.1|0.2|0.1|0.5`. If empty, both patterns will be the value from StrokeThickness property. Default is empty", "nullable": true }, "fillColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The fill color. Default value is White which will produce a transparent fill." }, "fillColorHex": { "type": "string", "description": "The fill color in hex notation.", "nullable": true, "example": "" }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "rotationAngle": { "type": "integer", "description": "The rotation angle to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "EllipseShapeItem" }, "Font": { "type": "object", "properties": { "name": { "type": "string", "description": "The face name of this object. Default value is NativePrinterFontA", "nullable": true }, "nameAtPrinterStorage": { "type": "string", "description": "The name of this object available in the Printer's internal storage including the drive location and name, for example B:ARIAL. IMPORTANT: The name must be 1 to 8 alphanumeric characters long.", "nullable": true, "example": "" }, "size": { "type": "number", "description": "The size of this object. Default value is 10", "format": "double", "example": 10 }, "bold": { "type": "boolean", "description": "A value that indicates whether this object is bold. Default value is false", "example": false }, "italic": { "type": "boolean", "description": "A value that indicates whether this object is italic. Default value is false", "example": false }, "underline": { "type": "boolean", "description": "A value that indicates whether this object is underlined. Default value is false", "example": false }, "strikeout": { "type": "boolean", "description": "A value that indicates whether this object specifies a horizontal line through the font. Default value is false", "example": false }, "unit": { "enum": [ "Inch", "Millimeter", "Pixel", "Point", "Twip" ], "type": "string", "description": "The unit of measure for this object. Default value is Point" }, "customFontFile": { "type": "string", "description": "The custom font file to use for this object. It's the full path pointing out to the custom font file on local disk; or the font file content in Base64 format. Default value is an empty string", "nullable": true, "example": "" }, "customFontFileFamilyName": { "type": "string", "description": "The Font Family name of the type faces defined by the specified Custom Font File. Default value is an empty string", "nullable": true, "example": "" }, "isBitmapFont": { "type": "boolean", "description": "Whether the specified font is a Bitmap Font a.k.a. Pixel Font. Default value is false", "example": false }, "threshold": { "type": "integer", "description": "The threshold percentage used for converting the font glyphs to black and white graphics. Values range from 0 to 100. Default value is 90.", "format": "int32", "example": 90 }, "codePage": { "enum": [ "CP850", "CP1250", "CP1251", "CP1252", "CP1253", "CP1254", "CP1255", "UTF8" ], "type": "string", "description": "The Code Page to be used with this font. Default value is CP850" } }, "additionalProperties": false, "description": "Font" }, "FrameThickness": { "type": "object", "properties": { "left": { "type": "number", "description": "The width of the left side of the frame. Default value is 0 (zero)", "format": "double", "example": 0 }, "top": { "type": "number", "description": "The width of the upper side of the frame. Default value is 0 (zero)", "format": "double", "example": 0 }, "bottom": { "type": "number", "description": "The width of the lower side of the frame. Default value is 0 (zero)", "format": "double", "example": 0 }, "right": { "type": "number", "description": "The width of the right side of the frame. Default value is 0 (zero)", "format": "double", "example": 0 } }, "additionalProperties": false, "description": "FrameThickness" }, "ImageItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "sourceFile": { "type": "string", "description": "The image file path or URL. Default value is an empty string", "nullable": true, "example": "" }, "sourceBase64": { "type": "string", "description": "The Base64 string of the image content. Default value is an empty string", "nullable": true, "example": "" }, "width": { "type": "number", "description": "The width of the image item. Default value is 0 (zero)", "format": "double", "example": 0 }, "height": { "type": "number", "description": "The height of the image item. Default value is 0 (zero)", "format": "double", "example": 0 }, "monochromeSettings": { "$ref": "#/components/schemas/MonochromeSettings" }, "rotationAngle": { "type": "integer", "description": "The rotation angle to apply on the source image. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "flip": { "enum": [ "None", "X", "Y", "XY" ], "type": "string", "description": "The axis used for flipping. Default value is None" }, "lockAspectRatio": { "enum": [ "None", "WidthBased", "HeightBased", "Fit" ], "type": "string", "description": "How source image's proportions are maintained if it is resized. Default value is None" }, "isGrayscaleOrBlackWhite": { "type": "boolean", "description": "Whether the pixels composing the source image are grayscale or black and white based. Default is false.", "example": false }, "hideIfNotFound": { "type": "boolean", "description": "Whether the Image is not displayed or printed if it's not found. Default value is false", "example": false }, "nameAtPrinterStorage": { "type": "string", "description": "The name of this object available in the Printer's internal storage.", "nullable": true, "example": "" }, "sourceDpi": { "type": "integer", "description": "The DPI resolution of the source image. Default value is 96", "format": "int32", "example": 96 }, "convertToMonochrome": { "type": "boolean", "description": "Whether the pixels composing the source image must be converted to monochrome. Default is true.", "example": true } }, "additionalProperties": false, "description": "ImageItem" }, "LineShapeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "strokeThickness": { "type": "number", "description": "The border thickness. Default value is 0.0104", "format": "double", "example": 0.0104 }, "strokeColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The border color. Default value is Black" }, "strokeColorHex": { "type": "string", "description": "The border color in hex notation.", "nullable": true, "example": "" }, "width": { "type": "number", "description": "The width of the shape item. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the shape item. Default value is 1", "format": "double", "example": 1 }, "strokeStyle": { "enum": [ "Solid", "Dash", "Dot" ], "type": "string", "description": "The stroke style. Default is Solid" }, "strokeStylePattern": { "type": "string", "description": "The stroke style pattern. The patter specifies the dash length, and the gap length separated by a pipe e.g. `0.2|0.1`. More than one pair of pattern is supported e.g. `0.1|0.2|0.1|0.5`. If empty, both patterns will be the value from StrokeThickness property. Default is empty", "nullable": true }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "orientation": { "enum": [ "Horizontal", "Vertical", "DiagonalUp", "DiagonalDown" ], "type": "string", "description": "The line shape orientation. Default value is Horizontal" } }, "additionalProperties": false, "description": "LineShapeItem" }, "LiteralItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "text": { "type": "string", "description": "The text. Default value is an empty string", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "LiteralItem" }, "MonochromeSettings": { "type": "object", "properties": { "ditherMethod": { "enum": [ "Threshold", "PatternDiffusion", "FloydSteinberg", "OtsuThreshold" ], "type": "string", "description": "The dithering method to be used for monochrome conversion. Default value is OtsuThreshold." }, "threshold": { "type": "integer", "description": "The threshold percentage. Values range from 0 to 100. Default value is 50.", "format": "int32", "example": 50 }, "reverseEffect": { "type": "boolean", "description": "Whether monochrome effect should be reversed. Default value is false", "example": false } }, "additionalProperties": false, "description": "MonochromeSettings" }, "PdfMetadata": { "type": "object", "properties": { "author": { "type": "string", "nullable": true }, "creator": { "type": "string", "nullable": true }, "producer": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "useVectorDrawing": { "type": "boolean" }, "rasterEncodingQuality": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "RFIDLockMemoryBank": { "type": "object", "properties": { "apply": { "type": "boolean", "description": "Whether to apply these Lock Memory Bank options. Default value is false.", "example": false }, "killPassword": { "enum": [ "None", "Lock", "Open", "Unlock", "Protected" ], "type": "string", "description": "The lock/unlock option for the kill password. Default value is None" }, "accessPassword": { "enum": [ "None", "Lock", "Open", "Unlock", "Protected" ], "type": "string", "description": "The lock/unlock option for the access password. Default value is None" }, "epcMemoryBank": { "enum": [ "None", "Lock", "Open", "Unlock", "Protected" ], "type": "string", "description": "The lock/unlock option for the EPC memory bank. Default value is None" }, "userMemoryBank": { "enum": [ "None", "Lock", "Open", "Unlock", "Protected" ], "type": "string", "description": "The lock/unlock option for the USER memory bank. Default value is None" } }, "additionalProperties": false, "description": "RFIDLockMemoryBank" }, "RFIDPermaLockMemorySection": { "type": "object", "properties": { "apply": { "type": "boolean", "description": "Whether to apply these PermaLock Memory Section options. Default value is false.", "example": false }, "startingSection": { "type": "integer", "description": "The starting section of memory to lock. Default value is 0", "format": "int32", "example": 0 }, "numberOfSections": { "type": "integer", "description": "The number of sections to lock. Default value is 0", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "RFIDPermaLockMemorySection" }, "RFIDTagItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "ePCDataStructure": { "type": "string", "description": "The EPC Data Structure. Default value is an empty string.", "nullable": true, "example": "" }, "dataFormat": { "enum": [ "ASCII", "Hexadecimal", "EPC" ], "type": "string", "description": "The format in which the data will be encoded. Default is ASCII." }, "dataToEncode": { "type": "string", "description": "The data to encode. The format will depend on the value of the DataFormat property. Default is an empty string.", "nullable": true, "example": "" }, "tagType": { "enum": [ "Default", "None", "EPCClass0", "EPCClass0Plus", "EPCClass164bit", "EPCClass196bit", "UCODEEPC119", "ImpinjClass0Plus", "ISO1800006A", "EPCClass1Gen2", "ISO1800006B" ], "type": "string", "description": "The RFID tag type. Default value is Default" }, "startingBlock": { "type": "integer", "description": "The starting block number. Default value is -1", "format": "int32", "example": -1 }, "numberOfBytes": { "type": "integer", "description": "The number of bytes to write. Default value is 0", "format": "int32", "example": 0 }, "memoryBank": { "type": "string", "description": "The Gen 2 memory bank. Default value is an empty string.", "nullable": true, "example": "" }, "accessPassword": { "type": "string", "description": "The Access Password. Default value is an empty string.", "nullable": true, "example": "" }, "killPassword": { "type": "string", "description": "The Kill Password. Default value is an empty string.", "nullable": true, "example": "" }, "lockMemoryBank": { "$ref": "#/components/schemas/RFIDLockMemoryBank" }, "permaLockMemorySection": { "$ref": "#/components/schemas/RFIDPermaLockMemorySection" } }, "additionalProperties": false, "description": "RFIDTagItem" }, "RectangleCornerRadius": { "type": "object", "properties": { "topLeft": { "type": "number", "description": "The radius of the top-left corner. Default value is 0 (zero)", "format": "double", "example": 0 }, "topRight": { "type": "number", "description": "The radius of the top-right corner. Default value is 0 (zero)", "format": "double", "example": 0 }, "bottomRight": { "type": "number", "description": "The radius of the bottom-right corner. Default value is 0 (zero)", "format": "double", "example": 0 }, "bottomLeft": { "type": "number", "description": "The radius of the bottom-left corner. Default value is 0 (zero)", "format": "double", "example": 0 } }, "additionalProperties": false, "description": "RectangleCornerRadius" }, "RectangleShapeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "strokeThickness": { "type": "number", "description": "The border thickness. Default value is 0.0104", "format": "double", "example": 0.0104 }, "strokeColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The border color. Default value is Black" }, "strokeColorHex": { "type": "string", "description": "The border color in hex notation.", "nullable": true, "example": "" }, "width": { "type": "number", "description": "The width of the shape item. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the shape item. Default value is 1", "format": "double", "example": 1 }, "strokeStyle": { "enum": [ "Solid", "Dash", "Dot" ], "type": "string", "description": "The stroke style. Default is Solid" }, "strokeStylePattern": { "type": "string", "description": "The stroke style pattern. The patter specifies the dash length, and the gap length separated by a pipe e.g. `0.2|0.1`. More than one pair of pattern is supported e.g. `0.1|0.2|0.1|0.5`. If empty, both patterns will be the value from StrokeThickness property. Default is empty", "nullable": true }, "fillColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The fill color. Default value is White which will produce a transparent fill." }, "fillColorHex": { "type": "string", "description": "The fill color in hex notation.", "nullable": true, "example": "" }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "rotationAngle": { "type": "integer", "description": "The rotation angle to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "cornerRadius": { "$ref": "#/components/schemas/RectangleCornerRadius" } }, "additionalProperties": false, "description": "RectangleShapeItem" }, "RepeaterItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "width": { "type": "number", "description": "The width of the repeater item container. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the repeater item container. Default value is 1", "format": "double", "example": 1 }, "rotationAngle": { "type": "integer", "description": "The rotation angle, in 90 degrees increments only, to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "count": { "type": "integer", "description": "A fixed count to be repeated if no DataField is specified. Default value is 0 (zero)", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "RepeaterItem" }, "TableColumn": { "type": "object", "properties": { "width": { "type": "number", "description": "The width of the column. Default is zero, autosize.", "format": "double", "example": 0 }, "fillColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The fill color. Default value is White which will produce a transparent fill." }, "fillColorHex": { "type": "string", "description": "The fill color in hex notation.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "TableColumn" }, "TableRow": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of the row. Default is zero, autosize.", "format": "double", "example": 0 }, "fillColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The fill color. Default value is White which will produce a transparent fill." }, "fillColorHex": { "type": "string", "description": "The fill color in hex notation.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "TableRow" }, "TableShapeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "strokeThickness": { "type": "number", "description": "The border thickness. Default value is 0.0104", "format": "double", "example": 0.0104 }, "strokeColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The border color. Default value is Black" }, "strokeColorHex": { "type": "string", "description": "The border color in hex notation.", "nullable": true, "example": "" }, "width": { "type": "number", "description": "The width of the shape item. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the shape item. Default value is 1", "format": "double", "example": 1 }, "strokeStyle": { "enum": [ "Solid", "Dash", "Dot" ], "type": "string", "description": "The stroke style. Default is Solid" }, "strokeStylePattern": { "type": "string", "description": "The stroke style pattern. The patter specifies the dash length, and the gap length separated by a pipe e.g. `0.2|0.1`. More than one pair of pattern is supported e.g. `0.1|0.2|0.1|0.5`. If empty, both patterns will be the value from StrokeThickness property. Default is empty", "nullable": true }, "fillColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The fill color. Default value is White which will produce a transparent fill." }, "fillColorHex": { "type": "string", "description": "The fill color in hex notation.", "nullable": true, "example": "" }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "rotationAngle": { "type": "integer", "description": "The rotation angle, in 90 degrees increments only, to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "cornerRadius": { "$ref": "#/components/schemas/RectangleCornerRadius" }, "columns": { "type": "array", "items": { }, "description": "The list of TableColumn objects representing the columns for this TableShapeItem.", "nullable": true }, "rows": { "type": "array", "items": { }, "description": "The list of TableRow objects representing the rows for this TableShapeItem.", "nullable": true }, "columnsLineVisible": { "type": "boolean", "description": "Whether the columns line are visible or not. Default value is true.", "example": true }, "rowsLineVisible": { "type": "boolean", "description": "Whether the rows line are visible or not. Default value is true.", "example": true }, "rightSideVisible": { "type": "boolean", "description": "Whether the right side line is visible or not. Default value is true.", "example": true }, "leftSideVisible": { "type": "boolean", "description": "Whether the left side line is visible or not. Default value is true.", "example": true }, "topSideVisible": { "type": "boolean", "description": "Whether the top side line is visible or not. Default value is true.", "example": true }, "bottomSideVisible": { "type": "boolean", "description": "Whether the bottom side line is visible or not. Default value is true.", "example": true } }, "additionalProperties": false, "description": "TableShapeItem" }, "TextItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The programmatic identifier or name assigned to the item. Default value is an empty string", "nullable": true, "example": "" }, "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "dataField": { "type": "string", "description": "The name of the field from the data source that contains the values to bind to this item. Default value is an empty string", "nullable": true, "example": "" }, "dataFieldFormatString": { "type": "string", "description": "The string that specifies the display format for the value of the data field. Default value is an empty string", "nullable": true, "example": "" }, "useCache": { "type": "boolean", "description": "Whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false", "example": false }, "cacheItemId": { "type": "string", "description": "The ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string", "nullable": true, "example": "" }, "printAsGraphic": { "type": "boolean", "description": "Whether the item's output is forced to be printed as a graphic. Default is false.", "example": false }, "visible": { "type": "boolean", "description": "Whether the item is visible and printed. Default is true.", "example": true }, "comments": { "type": "string", "description": "The comments associated to this item. Default is an empty string.", "nullable": true, "example": "" }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this item. Default is an empty string.", "nullable": true, "example": "" }, "locked": { "type": "boolean", "description": "Whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.", "example": false }, "editable": { "type": "boolean", "description": "Whether this item can be edited in the visual editor surface. Default is true.", "example": true }, "resizable": { "type": "boolean", "description": "Whether this item can be resizable in the visual editor surface. Default is true.", "example": true }, "expression": { "type": "string", "description": "An expression that will be evaluated when rendering this item. Default value is an empty string", "nullable": true, "example": "" }, "isDesignTime": { "type": "boolean", "description": "Whether this item is in design time in the visual editor surface. Default is false.", "example": false }, "groupName": { "type": "string", "description": "The group name which this item is part of. Default is empty.", "nullable": true }, "readOnly": { "type": "boolean", "description": "Whether the source content of this item can be changed or not. Default is false.", "example": false }, "typeName": { "type": "string", "description": "The Item Type name.", "nullable": true }, "text": { "type": "string", "description": "The text. Default value is an empty string", "nullable": true, "example": "" }, "font": { "$ref": "#/components/schemas/Font" }, "foreColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The foreground color of the text. Default value is Black" }, "foreColorHex": { "type": "string", "description": "The foreground color of the text in hex notation.", "nullable": true, "example": "" }, "rotationAngle": { "type": "integer", "description": "The rotation angle to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)", "format": "int32", "example": 0 }, "width": { "type": "number", "description": "The width of the text item. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the text item. Default value is 0.5", "format": "double", "example": 0.5 }, "counterStep": { "type": "integer", "description": "The step for the counter. The counter will increase (positive) or decrease (negative) by this number on every printed label. Default value is 0 (zero)", "format": "int32", "example": 0 }, "counterUseLeadingZeros": { "type": "boolean", "description": "Whether leading zeros are printed or suppressed when using counters. Default value is false", "example": false }, "mask": { "type": "string", "description": "The input Mask for the text. Default value is an empty string", "nullable": true, "example": "" }, "maskIncrement": { "type": "string", "description": "The mask increment. The increment is the value to be added to the text on each label to be printed. Default value is an empty string", "nullable": true, "example": "" }, "rightToLeft": { "type": "boolean", "description": "Whether the text should draw right-to-left for RTL languages. Default value is false", "example": false }, "sizing": { "enum": [ "None", "Stretch", "FontSizeScaling", "ParagraphScaling", "Arc", "Vertical", "OuterArc", "ParagraphScalingAndFill", "AutoSize", "OverflowSplit" ], "type": "string", "description": "The text sizing. Default value is None" }, "cornerRadius": { "$ref": "#/components/schemas/RectangleCornerRadius" }, "borderThickness": { "$ref": "#/components/schemas/FrameThickness" }, "borderColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The color of the border of the rectangle container. Default value is Black" }, "borderColorHex": { "type": "string", "description": "The color of the border of the rectangle container in hex notation.", "nullable": true, "example": "" }, "backColor": { "enum": [ "Black", "White" ], "type": "string", "description": "The background color of the text. Default value is White" }, "backColorHex": { "type": "string", "description": "The background color of the text in hex notation.", "nullable": true, "example": "" }, "textPadding": { "$ref": "#/components/schemas/FrameThickness" }, "textAlignment": { "enum": [ "Left", "Center", "Right", "Justify" ], "type": "string", "description": "The alignment of the text. Default value is Left" }, "cultureName": { "type": "string", "description": "The Culture Name for text formatting. Default is en-US. Other sample values: de-DE, es-ES, etc. Any value supported by .NET CultureInfo class.", "nullable": true }, "maxLength": { "type": "integer", "description": "The maximum number of characters allowed for this text item object. Default is 0 which means that unlimited number of characters will be allowed.", "format": "int32", "example": 0 }, "hideIfEmpty": { "type": "boolean", "description": "Whether this text item is not displayed or printed if the value to encode is empty. Default value is false", "example": false }, "inputMaskPattern": { "type": "string", "description": "The input mask pattern to use at design time on the label editor. Default is an empty string.", "nullable": true, "example": "" }, "inputMaskPromptChar": { "type": "string", "description": "The character used to represent the absence of user input. At design time on the label editor, this character will be displayed in the TextItem for any input mask pattern position that the end user has not yet filled in. Default is an underscore (_)." }, "strokeThickness": { "type": "number", "description": "The text stroke thickness. Default value is 0.", "format": "double", "example": 0 }, "strokeColorHex": { "type": "string", "description": "The text stroke color in hex notation.", "nullable": true, "example": "" }, "charSpacing": { "type": "number", "description": "The horizontal spacing behavior between text characters. This value is added to the natural spacing between characters while rendering the text. A positive value will cause characters to spread farther apart, while a negative value will bring characters closer together. Unit depends on the current ThermalLabel Unit property. Default value is 0", "format": "double", "example": 0 }, "lineSpacing": { "type": "number", "description": "The vertical spacing behavior between lines of text. This value is added to the natural line spacing. A positive value will cause lines to spread farther apart, while a negative value will bring lines closer together. Unit depends on the current ThermalLabel Unit property. Default value is 0", "format": "double", "example": 0 }, "validationRegEx": { "type": "string", "description": "The regular expression (must be based in the ECMAScript regex engine) that determines the pattern used to validate this text item. Default value is an empty string", "nullable": true, "example": "" }, "validationErrorMessage": { "type": "string", "description": "The text for the error message when validation fails. Default value is an empty string", "nullable": true, "example": "" }, "multiline": { "type": "boolean", "description": "Whether the text can span more than one line. Default is true.", "example": true }, "textVerticalAlignment": { "enum": [ "Top", "Bottom", "Middle" ], "type": "string", "description": "The alignment of the text. Default value is Top" }, "minFontSize": { "type": "number", "description": "The minimum font size for FontSizeScaling, ParagraphScaling and ParagraphScalingAndFill Sizing options. Unit depends on the current Font Unit property. Default value is 0", "format": "double", "example": 0 }, "useSlashedZero": { "type": "boolean", "description": "Whether zero char should be replaced by a zero with a slash through it. Default is false.", "example": false }, "scaleX": { "type": "number", "description": "The scaling factor in the X direction. Default value is 1.", "format": "double", "example": 1 }, "scaleY": { "type": "number", "description": "The scaling factor in the Y direction. Default value is 1.", "format": "double", "example": 1 } }, "additionalProperties": false, "description": "TextItem" }, "ThermalLabel": { "type": "object", "properties": { "width": { "type": "number", "description": "The width of the thermal label. The unit of measurement is specified by UnitType property. Default value is 1", "format": "double", "example": 1 }, "height": { "type": "number", "description": "The height of the thermal label. The unit of measurement is specified by UnitType property. Default value is 1", "format": "double", "example": 1 }, "unitType": { "enum": [ "Cm", "Inch", "Mm", "DotsPerInch", "Point", "Pica", "Mils", "Twip" ], "type": "string", "description": "The Unit of Measurement for the thermal label. The Unit of Measurement affects the thermal label size as well as its items' dimensions and locations. Default value is Inch" }, "items": { "type": "array", "items": { }, "description": "The list of Items composing the label.", "nullable": true }, "dataFieldReplicates": { "type": "string", "description": "The DataField name from the data source that must be used for specifying the number of replicates for each data source row. Default is an empty string", "nullable": true, "example": "" }, "gapLength": { "type": "number", "description": "The vertical gap length between labels. The unit of measurement is specified by UnitType property. Default value is 0 (zero)", "format": "double", "example": 0 }, "markLength": { "type": "number", "description": "The mark length or thickness between labels. The unit of measurement is specified by UnitType property. Default value is 0 (zero)", "format": "double", "example": 0 }, "offsetLength": { "type": "number", "description": "The offset length or thickness between labels. The unit of measurement is specified by UnitType property. Default value is 0 (zero)", "format": "double", "example": 0 }, "labelsPerRow": { "type": "integer", "description": "The number of labels per row in the media roll. Default value is 1", "format": "int32", "example": 1 }, "labelsHorizontalGapLength": { "type": "number", "description": "The horizontal gap length between labels when the media roll contains more than one label per row. The unit of measurement is specified by UnitType property. Default value is 0 (zero)", "format": "double", "example": 0 }, "isContinuous": { "type": "boolean", "description": "Whether this ThermalLabel is on a continuous media roll i.e. labels are not separated by gaps, spaces, notches, slots, or holes. Default is false.", "example": false }, "shape": { "enum": [ "Rectangle", "Ellipse" ], "type": "string", "description": "The shape of this ThermalLabel. Default is Rectangle." }, "printSpeed": { "type": "string", "description": "The media speed during printing. The value setting depends on the printer model and usually is in IPS (Inch Per Seconds). Look for it in the printer user manual.", "nullable": true, "example": "" }, "printMirror": { "type": "boolean", "description": "Whether this label is printed as a mirror image. Default is false.", "example": false }, "cutAfterPrinting": { "type": "boolean", "description": "Whether this label is cut after printing. Default is false.", "example": false }, "batchCut": { "type": "integer", "description": "Number of labels after which the cut will be performed. Default is 1.", "format": "int32", "example": 1 }, "darkness": { "type": "number", "description": "The output printing darkness setting which depends on the target printer type.", "format": "double" }, "expressions": { "type": "array", "items": { }, "description": "The list of Expressions to apply on the label.", "nullable": true }, "sheetLabelsWidth": { "type": "number", "description": "The width of the Sheet Labels where this thermal label is part of. The unit of measurement is specified by UnitType property. Default value is 0.", "format": "double", "example": 0 }, "sheetLabelsHeight": { "type": "number", "description": "The height of the Sheet Labels where this thermal label is part of. The unit of measurement is specified by UnitType property. Default value is 0.", "format": "double", "example": 0 }, "sheetLabelsCount": { "type": "integer", "description": "The total number individual labels of the Sheet Labels where this thermal label is part of. Default value is 0.", "format": "int32", "example": 0 }, "sheetLabelsMargin": { "$ref": "#/components/schemas/FrameThickness" }, "margin": { "$ref": "#/components/schemas/FrameThickness" }, "useDefaultMediaType": { "type": "boolean", "description": "Whether to use the default printer configuration for Media Type (Continuous, Web sensing, Mark sensing, etc). Default is false.", "example": false }, "designBackgroundImage": { "type": "string", "description": "A non-printing background image (in PNG format) that assists you in the design of your labels through the visual editors. Image must be specified in Base64 format.", "nullable": true, "example": "" }, "isDuplexDesign": { "type": "boolean", "description": "Whether this label is a duplex design. Default is false.", "example": false }, "tag": { "type": "string", "description": "An arbitrary string value that can be used to store custom information about this label. Default is an empty string.", "nullable": true, "example": "" }, "isSheetOfLabels": { "type": "boolean", "description": "Gets whether this label is a Sheet of labels type." }, "pages": { "type": "array", "items": { }, "description": "The list of ThermalLabelPage objects representing the pages within this label.", "nullable": true }, "fonts": { "type": "array", "items": {}, "description": "The list of ThermalLabelFont objects representing the embedded fonts within this label.", "nullable": true }, "isDataBound": { "type": "boolean", "description": "Gets whether any Item in the current label is data bound." } }, "additionalProperties": false, "description": "ThermalLabel" }, "ThermalLabelFont": { "type": "object", "properties": { "name": { "type": "string", "description": "The font name.", "nullable": true, "example": "" }, "data": { "type": "string", "description": "The base64 string representing the font binary content.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "ThermalLabelFont" }, "ThermalLabelPage": { "type": "object", "properties": { "x": { "type": "number", "description": "The x-coordinate of the upper-left corner of the page relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "y": { "type": "number", "description": "The y-coordinate of the upper-left corner of the page relative to the upper-left corner of its container. Default value is 0 (zero)", "format": "double", "example": 0 }, "height": { "type": "number", "description": "The height of the page. Default value is 0 (zero)", "format": "double", "example": 0 }, "width": { "type": "number", "description": "The width of the page. Default value is 0 (zero)", "format": "double", "example": 0 } }, "additionalProperties": false, "description": "ThermalLabelPage" }, "ThumbnailData": { "type": "object", "properties": { "thermalLabel": { "type": "string", "description": "The ThermalLabel document in XML, JSON or Base64 formats.", "default": "", "nullable": true }, "dataSource": { "type": "string", "description": "The data source in XML or JSON formats to merge with the specified ThermalLabel.", "default": "", "nullable": true, "example": "" }, "size": { "type": "integer", "description": "The output image size in pixel unit.", "format": "int32", "default": 200, "example": 200 }, "dpi": { "type": "integer", "description": "The output image resolution.", "format": "int32", "default": 96, "example": 96 }, "ignoreExpressions": { "type": "boolean", "description": "Whether any expressions found in the label should be ignored.", "default": false, "example": false }, "ignoreDataFields": { "type": "boolean", "description": "Whether any data fields found in the label should be ignored.", "default": false, "example": false } }, "additionalProperties": false, "description": "It specifies the thumbnail data." } } } }