Creates a new template. If template configuration is not specified in the request body then an empty template is created. Template is placed to the workspace specified in authentication params. Template configuration must be sent in the request body.
643 matches
11 actions
PDF Generator
11 actions
Other/PDF Generator
Create template
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
{
"type": "object",
"description": "Template configuration",
"required": [
"name"
],
"properties": {
"isDraft": {
"type": "boolean",
"description": "Indicates if the template is a draft or published."
},
"layout": {
"type": "object",
"description": "Defines template layout (e.g page format, margins).",
"properties": {
"emptyLabels": {
"type": "integer",
"description": "Defines how many pages or labels should be empty"
},
"format": {
"type": "string",
"description": "Defines template page size",
"enum": [
"A4",
"letter",
"custom"
]
},
"height": {
"type": "number",
"description": "Page height in units"
},
"margins": {
"type": "object",
"description": "Page margins in units",
"properties": {
"bottom": {
"type": "number"
},
"left": {
"type": "number"
},
"right": {
"type": "number"
},
"top": {
"type": "number"
}
}
},
"orientation": {
"type": "string",
"description": "Page orientation",
"enum": [
"portrait",
"landscape"
]
},
"repeatLayout": {
"type": "object",
"description": "Defines page size if layout is repeated on the page e.g sheet labels",
"properties": {
"format": {
"type": "string",
"description": "Defines template page size",
"enum": [
"A4",
"letter",
"custom"
]
},
"height": {
"type": "number",
"description": "Page height in units"
},
"width": {
"type": "number",
"description": "Page width in units"
}
}
},
"rotaion": {
"type": "integer",
"description": "Page rotation in degrees",
"enum": [
0,
90,
180,
270
]
},
"unit": {
"type": "string",
"description": "Measure unit",
"enum": [
"cm",
"in"
]
},
"width": {
"type": "number",
"description": "Page width in units"
}
}
},
"name": {
"type": "string",
"description": "Template name"
},
"pages": {
"type": "array",
"description": "Defines page or label size, margins and components on page or label",
"items": {
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"type": "object",
"description": "Template component definition",
"properties": {
"cls": {
"type": "string",
"description": "Defines component class/type",
"enum": [
"labelComponent",
"numberComponent",
"textComponent",
"imageComponent",
"dateComponent",
"hlineComponent",
"vlineComponent",
"tableComponent",
"compositeComponent",
"barcodeComponent",
"qrcodeComponent",
"chartComponent",
"rectangleComponent",
"headerComponent",
"footerComponent",
"checkboxComponent",
"radioComponent"
]
},
"dataIndex": {
"type": "string",
"description": "Defines data field for Table and Container components which are used to iterate over list of items"
},
"height": {
"type": "number",
"description": "Height in units"
},
"id": {
"type": "string",
"description": "Component id"
},
"left": {
"type": "number",
"description": "Position from the page left in units"
},
"top": {
"type": "number",
"description": "Position from the page top in units"
},
"value": {
"type": "string",
"description": "Component value"
},
"width": {
"type": "number",
"description": "Width in units"
},
"zindex": {
"type": "integer",
"description": "Defines the rendering order on page. Components with smaller zindex are rendered before"
}
}
}
},
"height": {
"type": "number",
"description": "Page height in units"
},
"margins": {
"type": "object",
"properties": {
"bottom": {
"type": "number",
"description": "Page or label margin from bottom"
},
"right": {
"type": "number",
"description": "Page or label margin from right"
}
}
},
"width": {
"type": "number",
"description": "Page width in units"
}
}
}
},
"tags": {
"type": "array",
"description": "A list of tags assigned to a template",
"items": {
"type": "string"
}
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"dataSettings": {
"type": "object",
"description": "Defines filter and sort option for root data set.",
"properties": {
"filterBy": {
"type": "array",
"items": {
"type": "object"
}
},
"sortBy": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"editor": {
"type": "object",
"description": "Configuration preferences for the editor",
"properties": {
"heightMultiplier": {
"type": "number"
}
}
},
"id": {
"type": "integer",
"description": "Unique identifier"
},
"isDraft": {
"type": "boolean",
"description": "Indicates if the template is a draft or published."
},
"layout": {
"type": "object",
"description": "Defines template layout (e.g page format, margins).",
"properties": {
"emptyLabels": {
"type": "integer",
"description": "Defines how many pages or labels should be empty"
},
"format": {
"type": "string",
"description": "Defines template page size",
"enum": [
"A4",
"letter",
"custom"
]
},
"height": {
"type": "number",
"description": "Page height in units"
},
"margins": {
"type": "object",
"description": "Page margins in units",
"properties": {
"bottom": {
"type": "number"
},
"left": {
"type": "number"
},
"right": {
"type": "number"
},
"top": {
"type": "number"
}
}
},
"orientation": {
"type": "string",
"description": "Page orientation",
"enum": [
"portrait",
"landscape"
]
},
"repeatLayout": {
"type": "object",
"description": "Defines page size if layout is repeated on the page e.g sheet labels",
"properties": {
"format": {
"type": "string",
"description": "Defines template page size",
"enum": [
"A4",
"letter",
"custom"
]
},
"height": {
"type": "number",
"description": "Page height in units"
},
"width": {
"type": "number",
"description": "Page width in units"
}
}
},
"rotation": {
"type": "integer",
"description": "Page rotation in degrees",
"enum": [
0,
90,
180,
270
]
},
"unit": {
"type": "string",
"description": "Measure unit",
"enum": [
"cm",
"in"
]
},
"width": {
"type": "number",
"description": "Page width in units"
}
}
},
"name": {
"type": "string",
"description": "Template name"
},
"pages": {
"type": "array",
"description": "Defines page or label size, margins and components on page or label",
"items": {
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"type": "object",
"description": "Template component definition",
"properties": {
"cls": {
"type": "string",
"description": "Defines component class/type",
"enum": [
"labelComponent",
"numberComponent",
"textComponent",
"imageComponent",
"dateComponent",
"hlineComponent",
"vlineComponent",
"tableComponent",
"compositeComponent",
"barcodeComponent",
"qrcodeComponent",
"chartComponent",
"rectangleComponent",
"headerComponent",
"footerComponent",
"checkboxComponent",
"radioComponent"
]
},
"dataIndex": {
"type": "string",
"description": "Defines data field for Table and Container components which are used to iterate over list of items"
},
"height": {
"type": "number",
"description": "Height in units"
},
"id": {
"type": "string",
"description": "Component id"
},
"left": {
"type": "number",
"description": "Position from the page left in units"
},
"top": {
"type": "number",
"description": "Position from the page top in units"
},
"value": {
"type": "string",
"description": "Component value"
},
"width": {
"type": "number",
"description": "Width in units"
},
"zindex": {
"type": "integer",
"description": "Defines the rendering order on page. Components with smaller zindex are rendered before"
}
}
}
},
"height": {
"type": "number",
"description": "Page height in units"
},
"margins": {
"type": "object",
"properties": {
"bottom": {
"type": "number",
"description": "Page or label margin from bottom"
},
"right": {
"type": "number",
"description": "Page or label margin from right"
}
}
},
"width": {
"type": "number",
"description": "Page width in units"
}
}
}
},
"tags": {
"type": "array",
"description": "A list of tags assigned to a template",
"items": {
"type": "string"
}
}
}
}
}
}