Create an new format
Deprecated: display_name Deprecated: default_format
Permission required: edit_format_settings
643 matches
100 actions
Contract.fit
100 actions
- **Permission required:** view_statisticsGETv1.0.0
- Change the current user passwordPOSTv1.0.0
- Create a new API KeyPOSTv1.0.0
- Create a new API Key on inbox levelPOSTv1.0.0
- Create a projectPOSTv1.0.0
- Create an inboxPOSTv1.0.0
- Create connectionPOSTv1.0.0
- Create formatPOSTv1.0.0
- Create integrationPOSTv1.0.0
- Create reportPOSTv1.0.0
- Create rolePOSTv1.0.0
- Create userPOSTv1.0.0
- Delete a connectionDELETEv1.0.0
- Delete a reportDELETEv1.0.0
- Delete a roleDELETEv1.0.0
- Delete an API KeyDELETEv1.0.0
- Delete an inboxDELETEv1.0.0
- Delete an integrationDELETEv1.0.0
- Delete documentsDELETEv1.0.0
- Delete projectDELETEv1.0.0
- Delete scoped predictor settingsDELETEv1.0.0
- Delete scoped rule configDELETEv1.0.0
- Delete scoped sampling settingsDELETEv1.0.0
- Delete scoped sampling settingsDELETEv1.0.0
- Delete the documentDELETEv1.0.0
- Delete the formatDELETEv1.0.0
- Delete the thresholds settingsDELETEv1.0.0
- Evaluate a rule on a documentPOSTv1.0.0
- Generate custom output for documentsPOSTv1.0.0
- Generate report based on inputPOSTv1.0.0
- Generate report based on report idPOSTv1.0.0
- Get all API-KeyGETv1.0.0
- Get all API-Keys for this inboxGETv1.0.0
- Get all ConnectionsGETv1.0.0
- Get all data retention settingsGETv1.0.0
- Get all integrationsGETv1.0.0
- Get all predictor settingsGETv1.0.0
- Get all reportsGETv1.0.0
- Get all rolesGETv1.0.0
- Get all rule configsGETv1.0.0
- Get all sampling settingsGETv1.0.0
- Get all thresholds settingsGETv1.0.0
- Get all usersGETv1.0.0
- Get connectionGETv1.0.0
- Get custom output formatted documentGETv1.0.0
- Get details of an API-KeyGETv1.0.0
- Get document original fileGETv1.0.0
- Get documents in the inboxGETv1.0.0
- Get format attributesGETv1.0.0
- Get Inbox attributesGETv1.0.0
- Get inbox statisticsGETv1.0.0
- Get integration attributesDELETEv1.0.0
- Get integration attributesGETv1.0.0
- Get list of inboxesGETv1.0.0
- Get lists of formatGETv1.0.0
- Get paginated list of documents in the inboxGETv1.0.0
- Get processing runtime statsGETv1.0.0
- Get project attributesGETv1.0.0
- Get reportGETv1.0.0
- Get roleGETv1.0.0
- Get scoped dashboard settingGETv1.0.0
- Get scoped data retention settingsGETv1.0.0
- Get scoped predictor settingsGETv1.0.0
- Get scoped review settingGETv1.0.0
- Get scoped rule configGETv1.0.0
- Get scoped sampling settingsGETv1.0.0
- Get summary or details of automation blockersGETv1.0.0
- Get supported document_typesGETv1.0.0
- Get tags valuesGETv1.0.0
- Get the Accuracy counts on documents, sections and fields in the given inboxGETv1.0.0
- Get the Blue Dots statistics for the inboxPOSTv1.0.0
- Get the custom CSS fileGETv1.0.0
- Get the custom logoGETv1.0.0
- Get the documentGETv1.0.0
- Get the document textGETv1.0.0
- Get the document WorkflowGETv1.0.0
- Get the list of projectsGETv1.0.0
- Get the regexes that are generated by the rulePOSTv1.0.0
- Get the scoped thresholds settingsGETv1.0.0
- Get the STP counts on documents, sections and fields in the given inboxGETv1.0.0
- Get the text a where_to_search specification will generatePOSTv1.0.0
- Get userGETv1.0.0
- get_document_page_image_resourceGETv1.0.0
- get_document_page_image_thumbnail_resourceGETv1.0.0
- get_document_reverse_resourceGETv1.0.0
- get_email_integration_activation_resourceGETv1.0.0
- get_release_notesGETv1.0.0
- get_sso_config_resourcesGETv1.0.0
- get_usage_stats_resourceGETv1.0.0
- post_document_data_resourcePOSTv1.0.0
- post_document_queryPOSTv1.0.0
- post_enrichment_resourcePOSTv1.0.0
- post_sso_config_resourcesPOSTv1.0.0
- Process a table-level annotationPOSTv1.0.0
- Reset the user passwordPOSTv1.0.0
- Return info on the current userGETv1.0.0
- Schedule document reprocessingPOSTv1.0.0
- Schedule inbox reprocessingPOSTv1.0.0
- Submit a feedbackPOSTv1.0.0
- Update document statusPOSTv1.0.0
Other/Contract.fit
Create format
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
- 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
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
{
"type": "object",
"required": [
"labels",
"name"
],
"properties": {
"display_name": {
"type": "string"
},
"document_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"field_name"
],
"properties": {
"display_name": {
"type": "string"
},
"field_name": {
"type": "string"
}
}
}
},
"labels": {
"type": "array",
"items": {
"type": "object",
"required": [
"field_name"
],
"properties": {
"category": {
"type": "string",
"enum": [
"annotation",
"tag",
"separator",
"computed"
]
},
"count_in_evaluation": {
"type": "boolean",
"description": "A flag that determines whether to count this field for evaluation"
},
"description": {
"type": "string",
"description": "A description of this field"
},
"display_name": {
"type": "string"
},
"field_name": {
"type": "string"
},
"formula": {
"type": "string",
"description": "An excel-like formula for conditional logic"
},
"initialized": {
"type": "boolean"
},
"is_library": {
"type": "boolean"
},
"mandatory": {
"type": "boolean"
},
"mandatory_if": {
"type": "object",
"description": "A value to decide if mandatory based on other field"
},
"multiple": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"active",
"name"
],
"properties": {
"active": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"scope": {
"type": "string",
"enum": [
"document",
"page",
"section"
]
},
"type": {
"type": "string",
"enum": [
"string",
"date",
"integer",
"float",
"currency",
"alphanumeric",
"national_identification_number_be",
"boolean",
"datetime",
"address"
]
},
"visible": {
"type": "boolean"
},
"visible_if": {
"type": "object",
"description": "A value to decide if shown in UI"
}
}
}
},
"name": {
"type": "string"
},
"separators": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"page"
],
"properties": {
"name": {
"type": "string"
},
"page": {
"type": "integer"
}
}
}
},
"table_types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collapsed": {
"type": "boolean"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"required": [
"field_name"
],
"properties": {
"category": {
"type": "string",
"enum": [
"annotation",
"tag",
"separator",
"computed"
]
},
"count_in_evaluation": {
"type": "boolean",
"description": "A flag that determines whether to count this field for evaluation"
},
"description": {
"type": "string",
"description": "A description of this field"
},
"display_name": {
"type": "string"
},
"field_name": {
"type": "string"
},
"formula": {
"type": "string",
"description": "An excel-like formula for conditional logic"
},
"initialized": {
"type": "boolean"
},
"is_library": {
"type": "boolean"
},
"mandatory": {
"type": "boolean"
},
"mandatory_if": {
"type": "object",
"description": "A value to decide if mandatory based on other field"
},
"multiple": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"active",
"name"
],
"properties": {
"active": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"scope": {
"type": "string",
"enum": [
"document",
"page",
"section"
]
},
"type": {
"type": "string",
"enum": [
"string",
"date",
"integer",
"float",
"currency",
"alphanumeric",
"national_identification_number_be",
"boolean",
"datetime",
"address"
]
},
"visible": {
"type": "boolean"
},
"visible_if": {
"type": "object",
"description": "A value to decide if shown in UI"
}
}
}
},
"contains_line_items": {
"type": "boolean"
},
"initialized": {
"type": "boolean"
},
"label": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"document",
"page",
"section"
]
}
}
}
}
}
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}