Schemathesis 4.30.1
API Coverage Report
2026-10-10 09:07:43
Operations
Operations called at least once
99.3% 162 of 163 called
Parameters
Tested with valid and invalid values
84.1% 503 of 598 covered
Keywords
Constraints tested both ways
75.8% 7155 of 9439 covered
Examples
Schema examples sent in tests
91.8% 68 of 74 used
Responses
Documented response codes hit
75.3% 156 of 207 received
Show
bulk_edit_objects 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Body33 of 33 keywords covered
application/json33 / 33
BulkEditObjectsRequest
#validinvalidschema
1253148{
2282114 "properties": {
32557 "all": {
42557 "type": "boolean",
5 "writeOnly": true
62557 },
72395 "filters": {
885n/a "additionalProperties": {},
92395 "type": "object",
10 "writeOnly": true
112395 },
122215 "merge": {
132215 "type": "boolean",
14 "writeOnly": true
152215 },
163617 "object_type": {
171n/a "allOf": [
183617 {
193617 "$ref": "#/components/schemas/ObjectTypeEnum"
203617 }
211n/a ],
22 "writeOnly": true
233617 },
2421316 "objects": {
2521311 "items": {
2628742 "type": "integer"
2721311 },
282245 "type": "array",
29 "writeOnly": true
3021316 },
313896 "operation": {
321n/a "allOf": [
333896 {
343896 "$ref": "#/components/schemas/OperationEnum"
353896 }
361n/a ],
37 "writeOnly": true
383896 },
392237 "owner": {
40230n/a "nullable": true,
412237 "type": "integer"
422237 },
4315867 "permissions": {
441n/a "allOf": [
4515867 {
4615867 "$ref": "#/components/schemas/SetPermissionsRequest"
4715867 }
481n/a ],
49 "writeOnly": true
5015867 }
51282114 },
5236729 "required": [
5336828 "object_type",
543951 "operation"
5536729 ],
563965 "type": "object"
57253148}
Referenced Components (4)20 of 20 keywords
ObjectTypeEnum3 of 3 keywords
13617{
23617 "enum": [
3204n/a "tags",
484n/a "correspondents",
540n/a "document_types",
633n/a "storage_paths"
73617 ],
83635 "type": "string"
93617}
OperationEnum3 of 3 keywords
13896{
23896 "enum": [
3230n/a "set_permissions",
4159n/a "delete"
53896 ],
63905 "type": "string"
73896}
PermissionSetRequest9 of 9 keywords
130362{
225352 "properties": {
326328 "groups": {
424514 "items": {
54016 "type": "integer"
624514 },
7291n/a "nullable": true,
827714 "type": "array"
926328 },
1027124 "users": {
1125016 "items": {
1210720 "type": "integer"
1325016 },
14295n/a "nullable": true,
152878 "type": "array"
1627124 }
1725352 },
1835510 "type": "object"
1930362}
SetPermissionsRequest5 of 5 keywords
115867{
213359 "properties": {
315631 "change": {
415631 "$ref": "#/components/schemas/PermissionSetRequest"
515631 },
614731 "view": {
714731 "$ref": "#/components/schemas/PermissionSetRequest"
814731 }
913359 },
102178 "type": "object"
1115867}
Responses1 of 1 documented received
codedescriptionhitsavg
2005339ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5024ms
401Unauthorized2213ms
41523ms
500Internal Server Error65ms
Examples2 / 2 used
Body: application/json
falseBulkEditObjectsRequest.all
falseBulkEditObjectsRequest.merge
config 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Responses1 of 1 documented received
codedescriptionhitsavg
20034585ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized9262ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1407219{
2407219 "type": "integer"
3407219}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body10413ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4443ms
401Unauthorized785ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164347{
264347 "type": "integer"
364347}
Responses1 of 1 documented received
codedescriptionhitsavg
2005455ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found784ms
401Unauthorized675ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1462060{
2462060 "type": "integer"
3462060}
Body546 of 546 keywords covered
application/json182 / 182
PatchedApplicationConfigurationRequest
13281350{
22021335 "properties": {
3131712 "ai_enabled": {
41329n/a "nullable": true,
5131712 "type": "boolean"
6131712 },
7181321 "app_logo": {
81312n/a "format": "binary",
91339n/a "nullable": true,
1031309 "pattern": "(?:jpg|png|gif|svg)$",
11132712 "type": "string"
12181321 },
13131515 "app_title": {
1413113 "maxLength": 48,
151330n/a "nullable": true,
16131812 "type": "string"
17131515 },
18129921 "archive_file_generation": {
191320n/a "nullable": true,
20129921 "oneOf": [
2191311 {
2291311 "$ref": "#/components/schemas/ArchiveFileGenerationEnum"
2391311 },
2461314 {
2561314 "$ref": "#/components/schemas/BlankEnum"
2661314 },
27128436 {
28128436 "$ref": "#/components/schemas/NullEnum"
29128436 }
30129921 ],
31129921 },
32131616 "barcode_asn_prefix": {
3313063 "maxLength": 32,
341332n/a "nullable": true,
35131913 "type": "string"
36131616 },
37129126 "barcode_dpi": {
38129423 "format": "int64",
3912973 "maximum": 9223372036854775807,
4012946 "minimum": 1,
411317n/a "nullable": true,
42130215 "type": "integer"
43129126 },
44129912 "barcode_enable_asn": {
451311n/a "nullable": true,
46129912 "type": "boolean"
47129912 },
48130112 "barcode_enable_tag": {
491313n/a "nullable": true,
50130112 "type": "boolean"
51130112 },
52129212 "barcode_enable_tiff_support": {
531304n/a "nullable": true,
54129212 "type": "boolean"
55129212 },
56127025 "barcode_max_pages": {
57127322 "format": "int64",
5812763 "maximum": 9223372036854775807,
5912736 "minimum": 1,
601295n/a "nullable": true,
61128015 "type": "integer"
62127025 },
63129612 "barcode_retain_split_pages": {
641308n/a "nullable": true,
65129612 "type": "boolean"
66129612 },
67128312 "barcode_store_values": {
681295n/a "nullable": true,
69128312 "type": "boolean"
70128312 },
71127915 "barcode_string": {
7212733 "maxLength": 32,
731294n/a "nullable": true,
74128212 "type": "string"
75127915 },
761281n/a "barcode_tag_mapping": {
771281n/a "nullable": true
781281n/a },
79127512 "barcode_tag_split": {
801287n/a "nullable": true,
81127512 "type": "boolean"
82127512 },
83125823 "barcode_upscale": {
84126417 "format": "double",
8512586 "minimum": 1.0,
861281n/a "nullable": true,
87126912 "type": "number"
88125823 },
89126812 "barcodes_enabled": {
901280n/a "nullable": true,
91126812 "type": "boolean"
92126812 },
93125521 "color_conversion_strategy": {
941276n/a "nullable": true,
95125521 "oneOf": [
96161260 {
97161260 "$ref": "#/components/schemas/ColorConversionStrategyEnum"
98161260 },
9991267 {
10091267 "$ref": "#/components/schemas/BlankEnum"
10191267 },
102123046 {
103123046 "$ref": "#/components/schemas/NullEnum"
104123046 }
105125521 ],
106125521 },
107126512 "deskew": {
1081277n/a "nullable": true,
109126512 "type": "boolean"
110126512 },
111124628 "image_dpi": {
112124925 "format": "int64",
11312523 "maximum": 9223372036854775807,
11412496 "minimum": 1,
1151274n/a "nullable": true,
116125915 "type": "integer"
117124628 },
118125715 "language": {
11912483 "maxLength": 32,
1201272n/a "nullable": true,
121126012 "type": "string"
122125715 },
123124518 "llm_api_key": {
12412443 "maxLength": 1024,
12512443 "minLength": 1,
1261263n/a "nullable": true,
127125112 "type": "string"
128124518 },
129124821 "llm_backend": {
1301269n/a "nullable": true,
131124821 "oneOf": [
132111258 {
133111258 "$ref": "#/components/schemas/LlmBackendEnum"
134111258 },
135111258 {
136111258 "$ref": "#/components/schemas/BlankEnum"
137111258 },
138122643 {
139122643 "$ref": "#/components/schemas/NullEnum"
140122643 }
141124821 ],
142124821 },
143123025 "llm_context_size": {
144123322 "format": "int64",
14512363 "maximum": 9223372036854775807,
14612336 "minimum": 1,
1471255n/a "nullable": true,
148124015 "type": "integer"
149123025 },
150123718 "llm_embedding_api_key": {
15112353 "maxLength": 1024,
15212353 "minLength": 1,
1531255n/a "nullable": true,
154124312 "type": "string"
155123718 },
156123721 "llm_embedding_backend": {
1571258n/a "nullable": true,
158123721 "oneOf": [
159101248 {
160101248 "$ref": "#/components/schemas/LlmEmbeddingBackendEnum"
161101248 },
162121246 {
163121246 "$ref": "#/components/schemas/BlankEnum"
164121246 },
165121543 {
166121543 "$ref": "#/components/schemas/NullEnum"
167121543 }
168123721 ],
169123721 },
170122424 "llm_embedding_chunk_size": {
171122721 "format": "int64",
17212303 "maximum": 9223372036854775807,
17312276 "minimum": 1,
1741248n/a "nullable": true,
175123315 "type": "integer"
176122424 },
177123515 "llm_embedding_endpoint": {
17812303 "maxLength": 256,
1791250n/a "nullable": true,
180123812 "type": "string"
181123515 },
182124015 "llm_embedding_model": {
18312283 "maxLength": 128,
1841255n/a "nullable": true,
185124312 "type": "string"
186124015 },
187122415 "llm_endpoint": {
18812193 "maxLength": 256,
1891239n/a "nullable": true,
190122712 "type": "string"
191122415 },
192122415 "llm_model": {
19312213 "maxLength": 128,
1941239n/a "nullable": true,
195122712 "type": "string"
196122415 },
197122617 "llm_output_language": {
19812193 "maxLength": 32,
1991243n/a "nullable": true,
200122914 "type": "string"
201122617 },
202120527 "llm_request_timeout": {
203120824 "format": "int64",
20412113 "maximum": 9223372036854775807,
20512086 "minimum": 1,
2061232n/a "nullable": true,
207121715 "type": "integer"
208120527 },
209120820 "max_image_pixels": {
210121117 "format": "double",
21112083 "minimum": 0.0,
2121228n/a "nullable": true,
213121612 "type": "number"
214120820 },
215120921 "mode": {
2161230n/a "nullable": true,
217120921 "oneOf": [
218171213 {
219171213 "$ref": "#/components/schemas/ModeEnum"
220171213 },
22181222 {
22281222 "$ref": "#/components/schemas/BlankEnum"
22381222 },
224118446 {
225118446 "$ref": "#/components/schemas/NullEnum"
226118446 }
227120921 ],
228120921 },
229120921 "output_type": {
2301230n/a "nullable": true,
231120921 "oneOf": [
232181212 {
233181212 "$ref": "#/components/schemas/OutputTypeEnum"
234181212 },
235131217 {
236131217 "$ref": "#/components/schemas/BlankEnum"
237131217 },
238117852 {
239117852 "$ref": "#/components/schemas/NullEnum"
240117852 }
241120921 ],
242120921 },
243119628 "pages": {
244119925 "format": "int64",
24512023 "maximum": 9223372036854775807,
24611996 "minimum": 1,
2471224n/a "nullable": true,
248120915 "type": "integer"
249119628 },
250120218 "remote_ocr_api_key": {
25112003 "maxLength": 1024,
25212003 "minLength": 1,
2531220n/a "nullable": true,
254120812 "type": "string"
255120218 },
256120115 "remote_ocr_endpoint": {
25711963 "maxLength": 256,
2581216n/a "nullable": true,
259120412 "type": "string"
260120115 },
261118621 "remote_ocr_engine": {
2621207n/a "nullable": true,
263118621 "oneOf": [
26451202 {
26551202 "$ref": "#/components/schemas/RemoteOcrEngineEnum"
26651202 },
26741203 {
26841203 "$ref": "#/components/schemas/BlankEnum"
26941203 },
270117730 {
271117730 "$ref": "#/components/schemas/NullEnum"
272117730 }
273118621 ],
274118621 },
275118321 "remote_ocr_mode": {
2761204n/a "nullable": true,
277118321 "oneOf": [
27871197 {
27971197 "$ref": "#/components/schemas/RemoteOcrModeEnum"
28071197 },
28151199 {
28251199 "$ref": "#/components/schemas/BlankEnum"
28351199 },
284117133 {
285117133 "$ref": "#/components/schemas/NullEnum"
286117133 }
287118321 ],
288118321 },
289119812 "rotate_pages": {
2901210n/a "nullable": true,
291119812 "type": "boolean"
292119812 },
293118222 "rotate_pages_threshold": {
294118519 "format": "double",
29511823 "minimum": 0.0,
2961204n/a "nullable": true,
297119212 "type": "number"
298118222 },
299118121 "unpaper_clean": {
3001202n/a "nullable": true,
301118121 "oneOf": [
302101192 {
303101192 "$ref": "#/components/schemas/UnpaperCleanEnum"
304101192 },
305111191 {
306111191 "$ref": "#/components/schemas/BlankEnum"
307111191 },
308116042 {
309116042 "$ref": "#/components/schemas/NullEnum"
310116042 }
311118121 ],
312118121 },
3131188n/a "user_args": {
3141188n/a "nullable": true
3151188n/a }
3162021335 },
317166315 "type": "object"
3183281350}
Referenced Components (11)31 of 31 keywords
ArchiveFileGenerationEnum3 of 3 keywords
191311{
291311 "enum": [
33n/a "auto",
43n/a "always",
53n/a "never"
691311 ],
7181302 "type": "string"
891311}
BlankEnum2 of 2 keywords
17911117{
27911117 "enum": [
379n/a ""
47911117 ]
57911117}
ColorConversionStrategyEnum3 of 3 keywords
1161260{
2161260 "enum": [
33n/a "LeaveColorUnchanged",
43n/a "RGB",
54n/a "UseDeviceIndependentColor",
63n/a "Gray",
73n/a "CMYK"
8161260 ],
9281248 "type": "string"
10161260}
LlmBackendEnum3 of 3 keywords
1111258{
2111258 "enum": [
36n/a "openai-like",
45n/a "ollama"
5111258 ],
6251244 "type": "string"
7111258}
LlmEmbeddingBackendEnum3 of 3 keywords
1101248{
2101248 "enum": [
34n/a "openai-like",
43n/a "huggingface",
53n/a "ollama"
6101248 ],
7251233 "type": "string"
8101248}
ModeEnum3 of 3 keywords
1171213{
2171213 "enum": [
34n/a "auto",
46n/a "force",
54n/a "redo",
63n/a "off"
7171213 ],
8281202 "type": "string"
9171213}
NullEnum2 of 2 keywords
110825371{
210825371 "enum": [
310825n/a null
410825371 ]
510825371}
OutputTypeEnum3 of 3 keywords
1181212{
2181212 "enum": [
33n/a "pdf",
43n/a "pdfa",
55n/a "pdfa-1",
64n/a "pdfa-2",
73n/a "pdfa-3"
8181212 ],
9341196 "type": "string"
10181212}
RemoteOcrEngineEnum3 of 3 keywords
151202{
251202 "enum": [
35n/a "azureai"
451202 ],
5121195 "type": "string"
651202}
RemoteOcrModeEnum3 of 3 keywords
171197{
271197 "enum": [
33n/a "always",
44n/a "workflow_only"
571197 ],
6151189 "type": "string"
771197}
UnpaperCleanEnum3 of 3 keywords
1101192{
2101192 "enum": [
33n/a "clean",
44n/a "clean-final",
53n/a "none"
6101192 ],
7241178 "type": "string"
8101192}
application/x-www-form-urlencoded182 / 182
PatchedApplicationConfigurationRequest
11671150{
21511150 "properties": {
3151033 "ai_enabled": {
41048n/a "nullable": true,
5151033 "type": "boolean"
6151033 },
731044 "app_logo": {
81047n/a "format": "binary",
91047n/a "nullable": true,
1031044 "pattern": "(?:jpg|png|gif|svg)$",
111047n/a "type": "string"
1231044 },
1310423 "app_title": {
1410423 "maxLength": 48,
151045n/a "nullable": true,
161045n/a "type": "string"
1710423 },
18101918 "archive_file_generation": {
191037n/a "nullable": true,
20101918 "oneOf": [
21131024 {
22131024 "$ref": "#/components/schemas/ArchiveFileGenerationEnum"
23131024 },
2481029 {
2581029 "$ref": "#/components/schemas/BlankEnum"
2681029 },
2799839 {
2899839 "$ref": "#/components/schemas/NullEnum"
2999839 }
30101918 ],
31101918 },
3210443 "barcode_asn_prefix": {
3310443 "maxLength": 32,
341047n/a "nullable": true,
351047n/a "type": "string"
3610443 },
37101922 "barcode_dpi": {
38102219 "format": "int64",
3910223 "maximum": 9223372036854775807,
4010223 "minimum": 1,
411041n/a "nullable": true,
42102516 "type": "integer"
43101922 },
44201016 "barcode_enable_asn": {
451036n/a "nullable": true,
46201016 "type": "boolean"
47201016 },
48181007 "barcode_enable_tag": {
491025n/a "nullable": true,
50181007 "type": "boolean"
51181007 },
52221003 "barcode_enable_tiff_support": {
531025n/a "nullable": true,
54221003 "type": "boolean"
55221003 },
56100828 "barcode_max_pages": {
57101224 "format": "int64",
5810123 "maximum": 9223372036854775807,
5910114 "minimum": 1,
601036n/a "nullable": true,
61101521 "type": "integer"
62100828 },
6315997 "barcode_retain_split_pages": {
641012n/a "nullable": true,
6515997 "type": "boolean"
6615997 },
6718996 "barcode_store_values": {
681014n/a "nullable": true,
6918996 "type": "boolean"
7018996 },
7110023 "barcode_string": {
7210023 "maxLength": 32,
731005n/a "nullable": true,
741005n/a "type": "string"
7510023 },
76990n/a "barcode_tag_mapping": {
77990n/a "nullable": true
78990n/a },
7914995 "barcode_tag_split": {
801009n/a "nullable": true,
8114995 "type": "boolean"
8214995 },
8397630 "barcode_upscale": {
8498521 "format": "double",
859769 "minimum": 1.0,
861006n/a "nullable": true,
8798521 "type": "number"
8897630 },
8912979 "barcodes_enabled": {
90991n/a "nullable": true,
9112979 "type": "boolean"
9212979 },
9398219 "color_conversion_strategy": {
941001n/a "nullable": true,
9598219 "oneOf": [
9623978 {
9723978 "$ref": "#/components/schemas/ColorConversionStrategyEnum"
9823978 },
997994 {
1007994 "$ref": "#/components/schemas/BlankEnum"
1017994 },
10295249 {
10395249 "$ref": "#/components/schemas/NullEnum"
10495249 }
10598219 ],
10698219 },
10716971 "deskew": {
108987n/a "nullable": true,
10916971 "type": "boolean"
11016971 },
11197118 "image_dpi": {
11297415 "format": "int64",
1139743 "maximum": 9223372036854775807,
1149743 "minimum": 1,
115989n/a "nullable": true,
11697712 "type": "integer"
11797118 },
1189943 "language": {
1199943 "maxLength": 32,
120997n/a "nullable": true,
121997n/a "type": "string"
1229943 },
1239887 "llm_api_key": {
1249914 "maxLength": 1024,
1259923 "minLength": 1,
126995n/a "nullable": true,
127995n/a "type": "string"
1289887 },
12996018 "llm_backend": {
130978n/a "nullable": true,
13196018 "oneOf": [
13212966 {
13312966 "$ref": "#/components/schemas/LlmBackendEnum"
13412966 },
1356972 {
1366972 "$ref": "#/components/schemas/BlankEnum"
1376972 },
13894236 {
13994236 "$ref": "#/components/schemas/NullEnum"
14094236 }
14196018 ],
14296018 },
14395924 "llm_context_size": {
14496221 "format": "int64",
1459623 "maximum": 9223372036854775807,
1469623 "minimum": 1,
147983n/a "nullable": true,
14896518 "type": "integer"
14995924 },
1509746 "llm_embedding_api_key": {
1519773 "maxLength": 1024,
1529773 "minLength": 1,
153980n/a "nullable": true,
154980n/a "type": "string"
1559746 },
15695919 "llm_embedding_backend": {
157978n/a "nullable": true,
15895919 "oneOf": [
15911967 {
16011967 "$ref": "#/components/schemas/LlmEmbeddingBackendEnum"
16111967 },
16210968 {
16310968 "$ref": "#/components/schemas/BlankEnum"
16410968 },
16593840 {
16693840 "$ref": "#/components/schemas/NullEnum"
16793840 }
16895919 ],
16995919 },
17094821 "llm_embedding_chunk_size": {
17195118 "format": "int64",
1729513 "maximum": 9223372036854775807,
1739513 "minimum": 1,
174969n/a "nullable": true,
17595415 "type": "integer"
17694821 },
1779783 "llm_embedding_endpoint": {
1789783 "maxLength": 256,
179981n/a "nullable": true,
180981n/a "type": "string"
1819783 },
1829513 "llm_embedding_model": {
1839513 "maxLength": 128,
184954n/a "nullable": true,
185954n/a "type": "string"
1869513 },
1879644 "llm_endpoint": {
1889644 "maxLength": 256,
189968n/a "nullable": true,
190968n/a "type": "string"
1919644 },
1929714 "llm_model": {
1939714 "maxLength": 128,
194975n/a "nullable": true,
195975n/a "type": "string"
1969714 },
1979513 "llm_output_language": {
1989513 "maxLength": 32,
199954n/a "nullable": true,
200954n/a "type": "string"
2019513 },
20292522 "llm_request_timeout": {
20392819 "format": "int64",
2049283 "maximum": 9223372036854775807,
2059283 "minimum": 1,
206947n/a "nullable": true,
20793116 "type": "integer"
20892522 },
20993119 "max_image_pixels": {
21093416 "format": "double",
2119313 "minimum": 0.0,
212950n/a "nullable": true,
21393416 "type": "number"
21493119 },
21592818 "mode": {
216946n/a "nullable": true,
21792818 "oneOf": [
21818928 {
21918928 "$ref": "#/components/schemas/ModeEnum"
22018928 },
22112934 {
22212934 "$ref": "#/components/schemas/BlankEnum"
22312934 },
22489848 {
22589848 "$ref": "#/components/schemas/NullEnum"
22689848 }
22792818 ],
22892818 },
22993625 "output_type": {
230961n/a "nullable": true,
23193625 "oneOf": [
23223938 {
23323938 "$ref": "#/components/schemas/OutputTypeEnum"
23423938 },
2355956 {
2365956 "$ref": "#/components/schemas/BlankEnum"
2375956 },
23890853 {
23990853 "$ref": "#/components/schemas/NullEnum"
24090853 }
24193625 ],
24293625 },
24392624 "pages": {
24492921 "format": "int64",
2459293 "maximum": 9223372036854775807,
2469293 "minimum": 1,
247950n/a "nullable": true,
24893218 "type": "integer"
24992624 },
2509466 "remote_ocr_api_key": {
2519493 "maxLength": 1024,
2529493 "minLength": 1,
253952n/a "nullable": true,
254952n/a "type": "string"
2559466 },
2569323 "remote_ocr_endpoint": {
2579323 "maxLength": 256,
258935n/a "nullable": true,
259935n/a "type": "string"
2609323 },
26191318 "remote_ocr_engine": {
262931n/a "nullable": true,
26391318 "oneOf": [
2644927 {
2654927 "$ref": "#/components/schemas/RemoteOcrEngineEnum"
2664927 },
26711920 {
26811920 "$ref": "#/components/schemas/BlankEnum"
26911920 },
27089833 {
27189833 "$ref": "#/components/schemas/NullEnum"
27289833 }
27391318 ],
27491318 },
27591519 "remote_ocr_mode": {
276934n/a "nullable": true,
27791519 "oneOf": [
27810924 {
27910924 "$ref": "#/components/schemas/RemoteOcrModeEnum"
28010924 },
28115919 {
28215919 "$ref": "#/components/schemas/BlankEnum"
28315919 },
28489044 {
28589044 "$ref": "#/components/schemas/NullEnum"
28689044 }
28791519 ],
28891519 },
28917905 "rotate_pages": {
290922n/a "nullable": true,
29117905 "type": "boolean"
29217905 },
29390615 "rotate_pages_threshold": {
29490912 "format": "double",
2959063 "minimum": 0.0,
296921n/a "nullable": true,
29790912 "type": "number"
29890615 },
29989618 "unpaper_clean": {
300914n/a "nullable": true,
30189618 "oneOf": [
30211903 {
30311903 "$ref": "#/components/schemas/UnpaperCleanEnum"
30411903 },
3056908 {
3066908 "$ref": "#/components/schemas/BlankEnum"
3076908 },
30887935 {
30987935 "$ref": "#/components/schemas/NullEnum"
31087935 }
31189618 ],
31289618 },
313897n/a "user_args": {
314897n/a "nullable": true
315897n/a }
3161511150 },
3171317n/a "type": "object"
3181671150}
Referenced Components (11)31 of 31 keywords
ArchiveFileGenerationEnum3 of 3 keywords
1131024{
2131024 "enum": [
33n/a "auto",
44n/a "always",
56n/a "never"
6131024 ],
739n/a "type": "string"
8131024}
BlankEnum2 of 2 keywords
1808600{
2808600 "enum": [
380n/a ""
4808600 ]
5808600}
ColorConversionStrategyEnum3 of 3 keywords
123978{
223978 "enum": [
33n/a "LeaveColorUnchanged",
44n/a "RGB",
56n/a "UseDeviceIndependentColor",
67n/a "Gray",
73n/a "CMYK"
823978 ],
949n/a "type": "string"
1023978}
LlmBackendEnum3 of 3 keywords
112966{
212966 "enum": [
36n/a "openai-like",
46n/a "ollama"
512966 ],
636n/a "type": "string"
712966}
LlmEmbeddingBackendEnum3 of 3 keywords
111967{
211967 "enum": [
34n/a "openai-like",
44n/a "huggingface",
53n/a "ollama"
611967 ],
740n/a "type": "string"
811967}
ModeEnum3 of 3 keywords
118928{
218928 "enum": [
34n/a "auto",
44n/a "force",
56n/a "redo",
64n/a "off"
718928 ],
848n/a "type": "string"
918928}
NullEnum2 of 2 keywords
18303377{
28303377 "enum": [
38303n/a null
48303377 ]
58303377}
OutputTypeEnum3 of 3 keywords
123938{
223938 "enum": [
35n/a "pdf",
43n/a "pdfa",
57n/a "pdfa-1",
65n/a "pdfa-2",
73n/a "pdfa-3"
823938 ],
953n/a "type": "string"
1023938}
RemoteOcrEngineEnum3 of 3 keywords
14927{
24927 "enum": [
34n/a "azureai"
44927 ],
533n/a "type": "string"
64927}
RemoteOcrModeEnum3 of 3 keywords
110924{
210924 "enum": [
36n/a "always",
44n/a "workflow_only"
510924 ],
644n/a "type": "string"
710924}
UnpaperCleanEnum3 of 3 keywords
111903{
211903 "enum": [
34n/a "clean",
44n/a "clean-final",
53n/a "none"
611903 ],
735n/a "type": "string"
811903}
multipart/form-data182 / 182
PatchedApplicationConfigurationRequest
11461279{
21221279 "properties": {
3141208 "ai_enabled": {
41222n/a "nullable": true,
5141208 "type": "boolean"
6141208 },
731222 "app_logo": {
81225n/a "format": "binary",
91225n/a "nullable": true,
1031222 "pattern": "(?:jpg|png|gif|svg)$",
111225n/a "type": "string"
1231222 },
1312123 "app_title": {
1412123 "maxLength": 48,
151215n/a "nullable": true,
161215n/a "type": "string"
1712123 },
18118721 "archive_file_generation": {
191208n/a "nullable": true,
20118721 "oneOf": [
21101198 {
22101198 "$ref": "#/components/schemas/ArchiveFileGenerationEnum"
23101198 },
2431205 {
2531205 "$ref": "#/components/schemas/BlankEnum"
2631205 },
27117434 {
28117434 "$ref": "#/components/schemas/NullEnum"
29117434 }
30118721 ],
31118721 },
3212093 "barcode_asn_prefix": {
3312093 "maxLength": 32,
341212n/a "nullable": true,
351212n/a "type": "string"
3612093 },
37117925 "barcode_dpi": {
38118222 "format": "int64",
3911823 "maximum": 9223372036854775807,
4011823 "minimum": 1,
411204n/a "nullable": true,
42118519 "type": "integer"
43117925 },
44161194 "barcode_enable_asn": {
451210n/a "nullable": true,
46161194 "type": "boolean"
47161194 },
48221185 "barcode_enable_tag": {
491207n/a "nullable": true,
50221185 "type": "boolean"
51221185 },
52231182 "barcode_enable_tiff_support": {
531205n/a "nullable": true,
54231182 "type": "boolean"
55231182 },
56117327 "barcode_max_pages": {
57117624 "format": "int64",
5811763 "maximum": 9223372036854775807,
5911763 "minimum": 1,
601200n/a "nullable": true,
61117921 "type": "integer"
62117327 },
63201176 "barcode_retain_split_pages": {
641196n/a "nullable": true,
65201176 "type": "boolean"
66201176 },
67151181 "barcode_store_values": {
681196n/a "nullable": true,
69151181 "type": "boolean"
70151181 },
7111793 "barcode_string": {
7211793 "maxLength": 32,
731182n/a "nullable": true,
741182n/a "type": "string"
7511793 },
761173n/a "barcode_tag_mapping": {
771173n/a "nullable": true
781173n/a },
79161167 "barcode_tag_split": {
801183n/a "nullable": true,
81161167 "type": "boolean"
82161167 },
83115424 "barcode_upscale": {
84116315 "format": "double",
8511549 "minimum": 1.0,
861178n/a "nullable": true,
87116315 "type": "number"
88115424 },
89181156 "barcodes_enabled": {
901174n/a "nullable": true,
91181156 "type": "boolean"
92181156 },
93114621 "color_conversion_strategy": {
941167n/a "nullable": true,
95114621 "oneOf": [
96151152 {
97151152 "$ref": "#/components/schemas/ColorConversionStrategyEnum"
98151152 },
9961161 {
10061161 "$ref": "#/components/schemas/BlankEnum"
10161161 },
102112542 {
103112542 "$ref": "#/components/schemas/NullEnum"
104112542 }
105114621 ],
106114621 },
107181150 "deskew": {
1081168n/a "nullable": true,
109181150 "type": "boolean"
110181150 },
111114224 "image_dpi": {
112114521 "format": "int64",
11311453 "maximum": 9223372036854775807,
11411453 "minimum": 1,
1151166n/a "nullable": true,
116114818 "type": "integer"
117114224 },
11811593 "language": {
11911593 "maxLength": 32,
1201162n/a "nullable": true,
1211162n/a "type": "string"
12211593 },
12311596 "llm_api_key": {
12411623 "maxLength": 1024,
12511623 "minLength": 1,
1261165n/a "nullable": true,
1271165n/a "type": "string"
12811596 },
129113025 "llm_backend": {
1301155n/a "nullable": true,
131113025 "oneOf": [
13281147 {
13381147 "$ref": "#/components/schemas/LlmBackendEnum"
13481147 },
13561149 {
13661149 "$ref": "#/components/schemas/BlankEnum"
13761149 },
138111639 {
139111639 "$ref": "#/components/schemas/NullEnum"
140111639 }
141113025 ],
142113025 },
143112427 "llm_context_size": {
144112724 "format": "int64",
14511273 "maximum": 9223372036854775807,
14611273 "minimum": 1,
1471151n/a "nullable": true,
148113021 "type": "integer"
149112427 },
15011466 "llm_embedding_api_key": {
15111493 "maxLength": 1024,
15211493 "minLength": 1,
1531152n/a "nullable": true,
1541152n/a "type": "string"
15511466 },
156112625 "llm_embedding_backend": {
1571151n/a "nullable": true,
158112625 "oneOf": [
159131138 {
160131138 "$ref": "#/components/schemas/LlmEmbeddingBackendEnum"
161131138 },
16291142 {
16391142 "$ref": "#/components/schemas/BlankEnum"
16491142 },
165110447 {
166110447 "$ref": "#/components/schemas/NullEnum"
167110447 }
168112625 ],
169112625 },
170111424 "llm_embedding_chunk_size": {
171111721 "format": "int64",
17211173 "maximum": 9223372036854775807,
17311173 "minimum": 1,
1741138n/a "nullable": true,
175112018 "type": "integer"
176111424 },
17711383 "llm_embedding_endpoint": {
17811383 "maxLength": 256,
1791141n/a "nullable": true,
1801141n/a "type": "string"
18111383 },
18211313 "llm_embedding_model": {
18311313 "maxLength": 128,
1841134n/a "nullable": true,
1851134n/a "type": "string"
18611313 },
18711313 "llm_endpoint": {
18811313 "maxLength": 256,
1891134n/a "nullable": true,
1901134n/a "type": "string"
19111313 },
19211333 "llm_model": {
19311333 "maxLength": 128,
1941136n/a "nullable": true,
1951136n/a "type": "string"
19611333 },
19711313 "llm_output_language": {
19811313 "maxLength": 32,
1991134n/a "nullable": true,
2001134n/a "type": "string"
20111313 },
202109929 "llm_request_timeout": {
203110226 "format": "int64",
20411023 "maximum": 9223372036854775807,
20511023 "minimum": 1,
2061128n/a "nullable": true,
207110523 "type": "integer"
208109929 },
209110126 "max_image_pixels": {
210110423 "format": "double",
21111013 "minimum": 0.0,
2121127n/a "nullable": true,
213110423 "type": "number"
214110126 },
215109925 "mode": {
2161124n/a "nullable": true,
217109925 "oneOf": [
218141110 {
219141110 "$ref": "#/components/schemas/ModeEnum"
220141110 },
221101114 {
222101114 "$ref": "#/components/schemas/BlankEnum"
223101114 },
224107549 {
225107549 "$ref": "#/components/schemas/NullEnum"
226107549 }
227109925 ],
228109925 },
229109525 "output_type": {
2301120n/a "nullable": true,
231109525 "oneOf": [
232181102 {
233181102 "$ref": "#/components/schemas/OutputTypeEnum"
234181102 },
23581112 {
23681112 "$ref": "#/components/schemas/BlankEnum"
23781112 },
238106951 {
239106951 "$ref": "#/components/schemas/NullEnum"
240106951 }
241109525 ],
242109525 },
243108625 "pages": {
244108922 "format": "int64",
24510893 "maximum": 9223372036854775807,
24610893 "minimum": 1,
2471111n/a "nullable": true,
248109219 "type": "integer"
249108625 },
25010976 "remote_ocr_api_key": {
25111003 "maxLength": 1024,
25211003 "minLength": 1,
2531103n/a "nullable": true,
2541103n/a "type": "string"
25510976 },
25611003 "remote_ocr_endpoint": {
25711003 "maxLength": 256,
2581103n/a "nullable": true,
2591103n/a "type": "string"
26011003 },
261107821 "remote_ocr_engine": {
2621099n/a "nullable": true,
263107821 "oneOf": [
26431096 {
26531096 "$ref": "#/components/schemas/RemoteOcrEngineEnum"
26631096 },
26741095 {
26841095 "$ref": "#/components/schemas/BlankEnum"
26941095 },
270107128 {
271107128 "$ref": "#/components/schemas/NullEnum"
272107128 }
273107821 ],
274107821 },
275107925 "remote_ocr_mode": {
2761104n/a "nullable": true,
277107925 "oneOf": [
27891095 {
27991095 "$ref": "#/components/schemas/RemoteOcrModeEnum"
28091095 },
28151099 {
28251099 "$ref": "#/components/schemas/BlankEnum"
28351099 },
284106539 {
285106539 "$ref": "#/components/schemas/NullEnum"
286106539 }
287107925 ],
288107925 },
289181083 "rotate_pages": {
2901101n/a "nullable": true,
291181083 "type": "boolean"
292181083 },
293107321 "rotate_pages_threshold": {
294107618 "format": "double",
29510733 "minimum": 0.0,
2961094n/a "nullable": true,
297107618 "type": "number"
298107321 },
299107721 "unpaper_clean": {
3001098n/a "nullable": true,
301107721 "oneOf": [
302191079 {
303191079 "$ref": "#/components/schemas/UnpaperCleanEnum"
304191079 },
30551093 {
30651093 "$ref": "#/components/schemas/BlankEnum"
30751093 },
308105345 {
309105345 "$ref": "#/components/schemas/NullEnum"
310105345 }
311107721 ],
312107721 },
3131080n/a "user_args": {
3141080n/a "nullable": true
3151080n/a }
3161221279 },
3171425n/a "type": "object"
3181461279}
Referenced Components (11)31 of 31 keywords
ArchiveFileGenerationEnum3 of 3 keywords
1101198{
2101198 "enum": [
34n/a "auto",
43n/a "always",
53n/a "never"
6101198 ],
734n/a "type": "string"
8101198}
BlankEnum2 of 2 keywords
15610170{
25610170 "enum": [
356n/a ""
45610170 ]
55610170}
ColorConversionStrategyEnum3 of 3 keywords
1151152{
2151152 "enum": [
33n/a "LeaveColorUnchanged",
43n/a "RGB",
53n/a "UseDeviceIndependentColor",
63n/a "Gray",
73n/a "CMYK"
8151152 ],
942n/a "type": "string"
10151152}
LlmBackendEnum3 of 3 keywords
181147{
281147 "enum": [
35n/a "openai-like",
43n/a "ollama"
581147 ],
639n/a "type": "string"
781147}
LlmEmbeddingBackendEnum3 of 3 keywords
1131138{
2131138 "enum": [
33n/a "openai-like",
43n/a "huggingface",
57n/a "ollama"
6131138 ],
747n/a "type": "string"
8131138}
ModeEnum3 of 3 keywords
1141110{
2141110 "enum": [
33n/a "auto",
44n/a "force",
53n/a "redo",
64n/a "off"
7141110 ],
849n/a "type": "string"
9141110}
NullEnum2 of 2 keywords
19852374{
29852374 "enum": [
39852n/a null
49852374 ]
59852374}
OutputTypeEnum3 of 3 keywords
1181102{
2181102 "enum": [
33n/a "pdf",
43n/a "pdfa",
56n/a "pdfa-1",
63n/a "pdfa-2",
73n/a "pdfa-3"
8181102 ],
951n/a "type": "string"
10181102}
RemoteOcrEngineEnum3 of 3 keywords
131096{
231096 "enum": [
33n/a "azureai"
431096 ],
528n/a "type": "string"
631096}
RemoteOcrModeEnum3 of 3 keywords
191095{
291095 "enum": [
33n/a "always",
46n/a "workflow_only"
591095 ],
639n/a "type": "string"
791095}
UnpaperCleanEnum3 of 3 keywords
1191079{
2191079 "enum": [
33n/a "clean",
44n/a "clean-final",
512n/a "none"
6191079 ],
745n/a "type": "string"
8191079}
Responses1 of 1 documented received
codedescriptionhitsavg
2007677ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1124ms
500Internal Server Error22295ms
401Unauthorized437ms
400Bad Request15265ms
41533ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1449935{
2449935 "type": "integer"
3449935}
Body549 of 549 keywords covered
application/json183 / 183
ApplicationConfigurationRequest
14591332{
24601316 "properties": {
3130012 "ai_enabled": {
41312n/a "nullable": true,
5130012 "type": "boolean"
6130012 },
791296 "app_logo": {
81287n/a "format": "binary",
91305n/a "nullable": true,
1031284 "pattern": "(?:jpg|png|gif|svg)$",
11129312 "type": "string"
1291296 },
13129215 "app_title": {
1412893 "maxLength": 48,
151307n/a "nullable": true,
16129512 "type": "string"
17129215 },
18130121 "archive_file_generation": {
191322n/a "nullable": true,
20130121 "oneOf": [
21191303 {
22191303 "$ref": "#/components/schemas/ArchiveFileGenerationEnum"
23191303 },
24101312 {
25101312 "$ref": "#/components/schemas/BlankEnum"
26101312 },
27127250 {
28127250 "$ref": "#/components/schemas/NullEnum"
29127250 }
30130121 ],
31130121 },
32128415 "barcode_asn_prefix": {
3312773 "maxLength": 32,
341299n/a "nullable": true,
35128712 "type": "string"
36128415 },
37126626 "barcode_dpi": {
38126923 "format": "int64",
3912723 "maximum": 9223372036854775807,
4012696 "minimum": 1,
411292n/a "nullable": true,
42127715 "type": "integer"
43126626 },
44128612 "barcode_enable_asn": {
451298n/a "nullable": true,
46128612 "type": "boolean"
47128612 },
48127212 "barcode_enable_tag": {
491284n/a "nullable": true,
50127212 "type": "boolean"
51127212 },
52127812 "barcode_enable_tiff_support": {
531290n/a "nullable": true,
54127812 "type": "boolean"
55127812 },
56125527 "barcode_max_pages": {
57125824 "format": "int64",
5812613 "maximum": 9223372036854775807,
5912586 "minimum": 1,
601282n/a "nullable": true,
61126715 "type": "integer"
62125527 },
63127712 "barcode_retain_split_pages": {
641289n/a "nullable": true,
65127712 "type": "boolean"
66127712 },
67126412 "barcode_store_values": {
681276n/a "nullable": true,
69126412 "type": "boolean"
70126412 },
71126915 "barcode_string": {
7212653 "maxLength": 32,
731284n/a "nullable": true,
74127212 "type": "string"
75126915 },
761772n/a "barcode_tag_mapping": {
771772n/a "nullable": true
781772n/a },
79126612 "barcode_tag_split": {
801278n/a "nullable": true,
81126612 "type": "boolean"
82126612 },
83124125 "barcode_upscale": {
84124719 "format": "double",
8512416 "minimum": 1.0,
861266n/a "nullable": true,
87125412 "type": "number"
88124125 },
89125512 "barcodes_enabled": {
901267n/a "nullable": true,
91125512 "type": "boolean"
92125512 },
93124225 "color_conversion_strategy": {
941267n/a "nullable": true,
95124225 "oneOf": [
96181249 {
97181249 "$ref": "#/components/schemas/ColorConversionStrategyEnum"
98181249 },
9951262 {
10051262 "$ref": "#/components/schemas/BlankEnum"
10151262 },
102121948 {
103121948 "$ref": "#/components/schemas/NullEnum"
104121948 }
105124225 ],
106124225 },
107125512 "deskew": {
1081267n/a "nullable": true,
109125512 "type": "boolean"
110125512 },
111123729 "image_dpi": {
112124026 "format": "int64",
11312433 "maximum": 9223372036854775807,
11412406 "minimum": 1,
1151266n/a "nullable": true,
116125115 "type": "integer"
117123729 },
118124815 "language": {
11912403 "maxLength": 32,
1201263n/a "nullable": true,
121125112 "type": "string"
122124815 },
123123118 "llm_api_key": {
12412313 "maxLength": 1024,
12512313 "minLength": 1,
1261249n/a "nullable": true,
127123712 "type": "string"
128123118 },
129123421 "llm_backend": {
1301255n/a "nullable": true,
131123421 "oneOf": [
132131242 {
133131242 "$ref": "#/components/schemas/LlmBackendEnum"
134131242 },
135111244 {
136111244 "$ref": "#/components/schemas/BlankEnum"
137111244 },
138121045 {
139121045 "$ref": "#/components/schemas/NullEnum"
140121045 }
141123421 ],
142123421 },
143123426 "llm_context_size": {
144123723 "format": "int64",
14512403 "maximum": 9223372036854775807,
14612376 "minimum": 1,
1471260n/a "nullable": true,
148124515 "type": "integer"
149123426 },
150121918 "llm_embedding_api_key": {
15112193 "maxLength": 1024,
15212193 "minLength": 1,
1531237n/a "nullable": true,
154122512 "type": "string"
155121918 },
156121321 "llm_embedding_backend": {
1571234n/a "nullable": true,
158121321 "oneOf": [
159101224 {
160101224 "$ref": "#/components/schemas/LlmEmbeddingBackendEnum"
161101224 },
16241230 {
16341230 "$ref": "#/components/schemas/BlankEnum"
16441230 },
165119935 {
166119935 "$ref": "#/components/schemas/NullEnum"
167119935 }
168121321 ],
169121321 },
170121125 "llm_embedding_chunk_size": {
171121422 "format": "int64",
17212173 "maximum": 9223372036854775807,
17312146 "minimum": 1,
1741236n/a "nullable": true,
175122115 "type": "integer"
176121125 },
177122715 "llm_embedding_endpoint": {
17812183 "maxLength": 256,
1791242n/a "nullable": true,
180123012 "type": "string"
181122715 },
182121915 "llm_embedding_model": {
18312163 "maxLength": 128,
1841234n/a "nullable": true,
185122212 "type": "string"
186121915 },
187121615 "llm_endpoint": {
18812133 "maxLength": 256,
1891231n/a "nullable": true,
190121912 "type": "string"
191121615 },
192120915 "llm_model": {
19312063 "maxLength": 128,
1941224n/a "nullable": true,
195121212 "type": "string"
196120915 },
197120615 "llm_output_language": {
19812023 "maxLength": 32,
1991221n/a "nullable": true,
200120912 "type": "string"
201120615 },
202119629 "llm_request_timeout": {
203119926 "format": "int64",
20412023 "maximum": 9223372036854775807,
20511996 "minimum": 1,
2061225n/a "nullable": true,
207121015 "type": "integer"
208119629 },
209119623 "max_image_pixels": {
210119920 "format": "double",
21111963 "minimum": 0.0,
2121219n/a "nullable": true,
213120712 "type": "number"
214119623 },
215119621 "mode": {
2161217n/a "nullable": true,
217119621 "oneOf": [
218131204 {
219131204 "$ref": "#/components/schemas/ModeEnum"
220131204 },
22191208 {
22291208 "$ref": "#/components/schemas/BlankEnum"
22391208 },
224117443 {
225117443 "$ref": "#/components/schemas/NullEnum"
226117443 }
227119621 ],
228119621 },
229118621 "output_type": {
2301207n/a "nullable": true,
231118621 "oneOf": [
232191188 {
233191188 "$ref": "#/components/schemas/OutputTypeEnum"
234191188 },
23541203 {
23641203 "$ref": "#/components/schemas/BlankEnum"
23741203 },
238116344 {
239116344 "$ref": "#/components/schemas/NullEnum"
240116344 }
241118621 ],
242118621 },
243117926 "pages": {
244118223 "format": "int64",
24511853 "maximum": 9223372036854775807,
24611826 "minimum": 1,
2471205n/a "nullable": true,
248119015 "type": "integer"
249117926 },
250118618 "remote_ocr_api_key": {
25111813 "maxLength": 1024,
25211813 "minLength": 1,
2531204n/a "nullable": true,
254119212 "type": "string"
255118618 },
256119315 "remote_ocr_endpoint": {
25711873 "maxLength": 256,
2581208n/a "nullable": true,
259119612 "type": "string"
260119315 },
261116921 "remote_ocr_engine": {
2621190n/a "nullable": true,
263116921 "oneOf": [
26451185 {
26551185 "$ref": "#/components/schemas/RemoteOcrEngineEnum"
26651185 },
26751185 {
26851185 "$ref": "#/components/schemas/BlankEnum"
26951185 },
270115931 {
271115931 "$ref": "#/components/schemas/NullEnum"
272115931 }
273116921 ],
274116921 },
275117021 "remote_ocr_mode": {
2761191n/a "nullable": true,
277117021 "oneOf": [
27871184 {
27971184 "$ref": "#/components/schemas/RemoteOcrModeEnum"
28071184 },
28151186 {
28251186 "$ref": "#/components/schemas/BlankEnum"
28351186 },
284115833 {
285115833 "$ref": "#/components/schemas/NullEnum"
286115833 }
287117021 ],
288117021 },
289118212 "rotate_pages": {
2901194n/a "nullable": true,
291118212 "type": "boolean"
292118212 },
293116622 "rotate_pages_threshold": {
294116919 "format": "double",
29511663 "minimum": 0.0,
2961188n/a "nullable": true,
297117612 "type": "number"
298116622 },
299117021 "unpaper_clean": {
3001191n/a "nullable": true,
301117021 "oneOf": [
302221169 {
303221169 "$ref": "#/components/schemas/UnpaperCleanEnum"
304221169 },
30561185 {
30661185 "$ref": "#/components/schemas/BlankEnum"
30761185 },
308114249 {
309114249 "$ref": "#/components/schemas/NullEnum"
310114249 }
311117021 ],
312117021 },
3131773n/a "user_args": {
3141773n/a "nullable": true
3151773n/a }
3164601316 },
31717697 "required": [
31817724 "barcode_tag_mapping",
31917733 "user_args"
32017697 ],
321177615 "type": "object"
3224591332}
Referenced Components (11)31 of 31 keywords
ArchiveFileGenerationEnum3 of 3 keywords
1191303{
2191303 "enum": [
310n/a "auto",
46n/a "always",
53n/a "never"
6191303 ],
7321290 "type": "string"
8191303}
BlankEnum2 of 2 keywords
15911015{
25911015 "enum": [
359n/a ""
45911015 ]
55911015}
ColorConversionStrategyEnum3 of 3 keywords
1181249{
2181249 "enum": [
33n/a "LeaveColorUnchanged",
46n/a "RGB",
53n/a "UseDeviceIndependentColor",
63n/a "Gray",
73n/a "CMYK"
8181249 ],
9261241 "type": "string"
10181249}
LlmBackendEnum3 of 3 keywords
1131242{
2131242 "enum": [
38n/a "openai-like",
45n/a "ollama"
5131242 ],
6271228 "type": "string"
7131242}
LlmEmbeddingBackendEnum3 of 3 keywords
1101224{
2101224 "enum": [
33n/a "openai-like",
44n/a "huggingface",
53n/a "ollama"
6101224 ],
7171217 "type": "string"
8101224}
ModeEnum3 of 3 keywords
1131204{
2131204 "enum": [
34n/a "auto",
43n/a "force",
53n/a "redo",
63n/a "off"
7131204 ],
8251192 "type": "string"
9131204}
NullEnum2 of 2 keywords
110696378{
210696378 "enum": [
310696n/a null
410696378 ]
510696378}
OutputTypeEnum3 of 3 keywords
1191188{
2191188 "enum": [
36n/a "pdf",
44n/a "pdfa",
53n/a "pdfa-1",
63n/a "pdfa-2",
73n/a "pdfa-3"
8191188 ],
9261181 "type": "string"
10191188}
RemoteOcrEngineEnum3 of 3 keywords
151185{
251185 "enum": [
35n/a "azureai"
451185 ],
5131177 "type": "string"
651185}
RemoteOcrModeEnum3 of 3 keywords
171184{
271184 "enum": [
34n/a "always",
43n/a "workflow_only"
571184 ],
6151176 "type": "string"
771184}
UnpaperCleanEnum3 of 3 keywords
1221169{
2221169 "enum": [
312n/a "clean",
43n/a "clean-final",
57n/a "none"
6221169 ],
7311160 "type": "string"
8221169}
application/x-www-form-urlencoded183 / 183
ApplicationConfigurationRequest
11761123{
21871112 "properties": {
3131005 "ai_enabled": {
41018n/a "nullable": true,
5131005 "type": "boolean"
6131005 },
731021 "app_logo": {
81024n/a "format": "binary",
91024n/a "nullable": true,
1031021 "pattern": "(?:jpg|png|gif|svg)$",
111024n/a "type": "string"
1231021 },
1310163 "app_title": {
1410163 "maxLength": 48,
151019n/a "nullable": true,
161019n/a "type": "string"
1710163 },
18100225 "archive_file_generation": {
191027n/a "nullable": true,
20100225 "oneOf": [
21151012 {
22151012 "$ref": "#/components/schemas/ArchiveFileGenerationEnum"
23151012 },
24141013 {
25141013 "$ref": "#/components/schemas/BlankEnum"
26141013 },
2797354 {
2897354 "$ref": "#/components/schemas/NullEnum"
2997354 }
30100225 ],
31100225 },
3210193 "barcode_asn_prefix": {
3310193 "maxLength": 32,
341022n/a "nullable": true,
351022n/a "type": "string"
3610193 },
37100320 "barcode_dpi": {
38100617 "format": "int64",
3910063 "maximum": 9223372036854775807,
4010063 "minimum": 1,
411023n/a "nullable": true,
42100914 "type": "integer"
43100320 },
4414992 "barcode_enable_asn": {
451006n/a "nullable": true,
4614992 "type": "boolean"
4714992 },
4815984 "barcode_enable_tag": {
49999n/a "nullable": true,
5015984 "type": "boolean"
5115984 },
5216991 "barcode_enable_tiff_support": {
531007n/a "nullable": true,
5416991 "type": "boolean"
5516991 },
5696520 "barcode_max_pages": {
5796817 "format": "int64",
589683 "maximum": 9223372036854775807,
599683 "minimum": 1,
60985n/a "nullable": true,
6197114 "type": "integer"
6296520 },
6319977 "barcode_retain_split_pages": {
64996n/a "nullable": true,
6519977 "type": "boolean"
6619977 },
6712972 "barcode_store_values": {
68984n/a "nullable": true,
6912972 "type": "boolean"
7012972 },
719783 "barcode_string": {
729783 "maxLength": 32,
73981n/a "nullable": true,
74981n/a "type": "string"
759783 },
761284n/a "barcode_tag_mapping": {
771284n/a "nullable": true
781284n/a },
7913965 "barcode_tag_split": {
80978n/a "nullable": true,
8113965 "type": "boolean"
8213965 },
8396634 "barcode_upscale": {
8497525 "format": "double",
859669 "minimum": 1.0,
861000n/a "nullable": true,
8797525 "type": "number"
8896634 },
8919964 "barcodes_enabled": {
90983n/a "nullable": true,
9119964 "type": "boolean"
9219964 },
9395318 "color_conversion_strategy": {
94971n/a "nullable": true,
9595318 "oneOf": [
9617954 {
9717954 "$ref": "#/components/schemas/ColorConversionStrategyEnum"
9817954 },
998963 {
1008963 "$ref": "#/components/schemas/BlankEnum"
1018963 },
10292843 {
10392843 "$ref": "#/components/schemas/NullEnum"
10492843 }
10595318 ],
10695318 },
10715968 "deskew": {
108983n/a "nullable": true,
10915968 "type": "boolean"
11015968 },
11194424 "image_dpi": {
11294721 "format": "int64",
1139473 "maximum": 9223372036854775807,
1149473 "minimum": 1,
115968n/a "nullable": true,
11695018 "type": "integer"
11794424 },
1189683 "language": {
1199683 "maxLength": 32,
120971n/a "nullable": true,
121971n/a "type": "string"
1229683 },
1239617 "llm_api_key": {
1249644 "maxLength": 1024,
1259653 "minLength": 1,
126968n/a "nullable": true,
127968n/a "type": "string"
1289617 },
12994818 "llm_backend": {
130966n/a "nullable": true,
13194818 "oneOf": [
13215951 {
13315951 "$ref": "#/components/schemas/LlmBackendEnum"
13415951 },
1354962 {
1364962 "$ref": "#/components/schemas/BlankEnum"
1374962 },
13892937 {
13992937 "$ref": "#/components/schemas/NullEnum"
14092937 }
14194818 ],
14294818 },
14392918 "llm_context_size": {
14493215 "format": "int64",
1459323 "maximum": 9223372036854775807,
1469323 "minimum": 1,
147947n/a "nullable": true,
14893512 "type": "integer"
14992918 },
1509476 "llm_embedding_api_key": {
1519503 "maxLength": 1024,
1529503 "minLength": 1,
153953n/a "nullable": true,
154953n/a "type": "string"
1559476 },
15693418 "llm_embedding_backend": {
157952n/a "nullable": true,
15893418 "oneOf": [
15913939 {
16013939 "$ref": "#/components/schemas/LlmEmbeddingBackendEnum"
16113939 },
1627945 {
1637945 "$ref": "#/components/schemas/BlankEnum"
1647945 },
16591438 {
16691438 "$ref": "#/components/schemas/NullEnum"
16791438 }
16893418 ],
16993418 },
17093519 "llm_embedding_chunk_size": {
17193816 "format": "int64",
1729383 "maximum": 9223372036854775807,
1739383 "minimum": 1,
174954n/a "nullable": true,
17594113 "type": "integer"
17693519 },
1779433 "llm_embedding_endpoint": {
1789433 "maxLength": 256,
179946n/a "nullable": true,
180946n/a "type": "string"
1819433 },
1829433 "llm_embedding_model": {
1839433 "maxLength": 128,
184946n/a "nullable": true,
185946n/a "type": "string"
1869433 },
1879353 "llm_endpoint": {
1889353 "maxLength": 256,
189938n/a "nullable": true,
190938n/a "type": "string"
1919353 },
1929413 "llm_model": {
1939413 "maxLength": 128,
194944n/a "nullable": true,
195944n/a "type": "string"
1969413 },
1979253 "llm_output_language": {
1989253 "maxLength": 32,
199928n/a "nullable": true,
200928n/a "type": "string"
2019253 },
20291620 "llm_request_timeout": {
20391917 "format": "int64",
2049193 "maximum": 9223372036854775807,
2059193 "minimum": 1,
206936n/a "nullable": true,
20792214 "type": "integer"
20891620 },
20990716 "max_image_pixels": {
21091112 "format": "double",
2119074 "minimum": 0.0,
212923n/a "nullable": true,
21391112 "type": "number"
21490716 },
21590518 "mode": {
216923n/a "nullable": true,
21790518 "oneOf": [
21817906 {
21917906 "$ref": "#/components/schemas/ModeEnum"
22017906 },
2217916 {
2227916 "$ref": "#/components/schemas/BlankEnum"
2237916 },
22488142 {
22588142 "$ref": "#/components/schemas/NullEnum"
22688142 }
22790518 ],
22890518 },
22990118 "output_type": {
230919n/a "nullable": true,
23190118 "oneOf": [
23219900 {
23319900 "$ref": "#/components/schemas/OutputTypeEnum"
23419900 },
2353916 {
2363916 "$ref": "#/components/schemas/BlankEnum"
2373916 },
23887940 {
23987940 "$ref": "#/components/schemas/NullEnum"
24087940 }
24190118 ],
24290118 },
24390625 "pages": {
24491120 "format": "int64",
2459113 "maximum": 9223372036854775807,
2469095 "minimum": 1,
247931n/a "nullable": true,
24891417 "type": "integer"
24990625 },
2509096 "remote_ocr_api_key": {
2519123 "maxLength": 1024,
2529123 "minLength": 1,
253915n/a "nullable": true,
254915n/a "type": "string"
2559096 },
2569203 "remote_ocr_endpoint": {
2579203 "maxLength": 256,
258923n/a "nullable": true,
259923n/a "type": "string"
2609203 },
26190318 "remote_ocr_engine": {
262921n/a "nullable": true,
26390318 "oneOf": [
2649912 {
2659912 "$ref": "#/components/schemas/RemoteOcrEngineEnum"
2669912 },
26710911 {
26810911 "$ref": "#/components/schemas/BlankEnum"
26910911 },
27088437 {
27188437 "$ref": "#/components/schemas/NullEnum"
27288437 }
27390318 ],
27490318 },
27588618 "remote_ocr_mode": {
276904n/a "nullable": true,
27788618 "oneOf": [
27811893 {
27911893 "$ref": "#/components/schemas/RemoteOcrModeEnum"
28011893 },
2814900 {
2824900 "$ref": "#/components/schemas/BlankEnum"
2834900 },
28487133 {
28587133 "$ref": "#/components/schemas/NullEnum"
28687133 }
28788618 ],
28888618 },
28923900 "rotate_pages": {
290923n/a "nullable": true,
29123900 "type": "boolean"
29223900 },
29388933 "rotate_pages_threshold": {
29489923 "format": "double",
29588910 "minimum": 0.0,
296922n/a "nullable": true,
29789923 "type": "number"
29888933 },
29989518 "unpaper_clean": {
300913n/a "nullable": true,
30189518 "oneOf": [
30216897 {
30316897 "$ref": "#/components/schemas/UnpaperCleanEnum"
30416897 },
30510903 {
30610903 "$ref": "#/components/schemas/BlankEnum"
30710903 },
30886944 {
30986944 "$ref": "#/components/schemas/NullEnum"
31086944 }
31189518 ],
31289518 },
3131290n/a "user_args": {
3141290n/a "nullable": true
3151290n/a }
3161871112 },
317127524 "required": [
318128415 "barcode_tag_mapping",
31912909 "user_args"
320127524 ],
3211299n/a "type": "object"
3221761123}
Referenced Components (11)31 of 31 keywords
ArchiveFileGenerationEnum3 of 3 keywords
1151012{
2151012 "enum": [
34n/a "auto",
48n/a "always",
53n/a "never"
6151012 ],
754n/a "type": "string"
8151012}
BlankEnum2 of 2 keywords
1678429{
2678429 "enum": [
367n/a ""
4678429 ]
5678429}
ColorConversionStrategyEnum3 of 3 keywords
117954{
217954 "enum": [
33n/a "LeaveColorUnchanged",
43n/a "RGB",
53n/a "UseDeviceIndependentColor",
64n/a "Gray",
74n/a "CMYK"
817954 ],
943n/a "type": "string"
1017954}
LlmBackendEnum3 of 3 keywords
115951{
215951 "enum": [
36n/a "openai-like",
49n/a "ollama"
515951 ],
637n/a "type": "string"
715951}
LlmEmbeddingBackendEnum3 of 3 keywords
113939{
213939 "enum": [
34n/a "openai-like",
46n/a "huggingface",
53n/a "ollama"
613939 ],
738n/a "type": "string"
813939}
ModeEnum3 of 3 keywords
117906{
217906 "enum": [
33n/a "auto",
43n/a "force",
53n/a "redo",
68n/a "off"
717906 ],
842n/a "type": "string"
917906}
NullEnum2 of 2 keywords
18128368{
28128368 "enum": [
38128n/a null
48128368 ]
58128368}
OutputTypeEnum3 of 3 keywords
119900{
219900 "enum": [
36n/a "pdf",
43n/a "pdfa",
54n/a "pdfa-1",
63n/a "pdfa-2",
73n/a "pdfa-3"
819900 ],
940n/a "type": "string"
1019900}
RemoteOcrEngineEnum3 of 3 keywords
19912{
29912 "enum": [
39n/a "azureai"
49912 ],
537n/a "type": "string"
69912}
RemoteOcrModeEnum3 of 3 keywords
111893{
211893 "enum": [
37n/a "always",
44n/a "workflow_only"
511893 ],
633n/a "type": "string"
711893}
UnpaperCleanEnum3 of 3 keywords
116897{
216897 "enum": [
33n/a "clean",
43n/a "clean-final",
510n/a "none"
616897 ],
744n/a "type": "string"
816897}
multipart/form-data183 / 183
ApplicationConfigurationRequest
11271256{
21331250 "properties": {
3121179 "ai_enabled": {
41191n/a "nullable": true,
5121179 "type": "boolean"
6121179 },
731190 "app_logo": {
81193n/a "format": "binary",
91193n/a "nullable": true,
1031190 "pattern": "(?:jpg|png|gif|svg)$",
111193n/a "type": "string"
1231190 },
1311903 "app_title": {
1411903 "maxLength": 48,
151193n/a "nullable": true,
161193n/a "type": "string"
1711903 },
18116921 "archive_file_generation": {
191190n/a "nullable": true,
20116921 "oneOf": [
21101180 {
22101180 "$ref": "#/components/schemas/ArchiveFileGenerationEnum"
23101180 },
24111179 {
25111179 "$ref": "#/components/schemas/BlankEnum"
26111179 },
27114842 {
28114842 "$ref": "#/components/schemas/NullEnum"
29114842 }
30116921 ],
31116921 },
3211823 "barcode_asn_prefix": {
3311823 "maxLength": 32,
341185n/a "nullable": true,
351185n/a "type": "string"
3611823 },
37115224 "barcode_dpi": {
38115521 "format": "int64",
3911553 "maximum": 9223372036854775807,
4011553 "minimum": 1,
411176n/a "nullable": true,
42115818 "type": "integer"
43115224 },
44111165 "barcode_enable_asn": {
451176n/a "nullable": true,
46111165 "type": "boolean"
47111165 },
48111172 "barcode_enable_tag": {
491183n/a "nullable": true,
50111172 "type": "boolean"
51111172 },
52131158 "barcode_enable_tiff_support": {
531171n/a "nullable": true,
54131158 "type": "boolean"
55131158 },
56114524 "barcode_max_pages": {
57114821 "format": "int64",
5811483 "maximum": 9223372036854775807,
5911483 "minimum": 1,
601169n/a "nullable": true,
61115118 "type": "integer"
62114524 },
63121155 "barcode_retain_split_pages": {
641167n/a "nullable": true,
65121155 "type": "boolean"
66121155 },
67101150 "barcode_store_values": {
681160n/a "nullable": true,
69101150 "type": "boolean"
70101150 },
7111594 "barcode_string": {
7211594 "maxLength": 32,
731163n/a "nullable": true,
741163n/a "type": "string"
7511594 },
761374n/a "barcode_tag_mapping": {
771374n/a "nullable": true
781374n/a },
79101143 "barcode_tag_split": {
801153n/a "nullable": true,
81101143 "type": "boolean"
82101143 },
83112727 "barcode_upscale": {
84113618 "format": "double",
8511279 "minimum": 1.0,
861154n/a "nullable": true,
87113618 "type": "number"
88112727 },
8991136 "barcodes_enabled": {
901145n/a "nullable": true,
9191136 "type": "boolean"
9291136 },
93112721 "color_conversion_strategy": {
941148n/a "nullable": true,
95112721 "oneOf": [
96151133 {
97151133 "$ref": "#/components/schemas/ColorConversionStrategyEnum"
98151133 },
9971141 {
10071141 "$ref": "#/components/schemas/BlankEnum"
10171141 },
102110543 {
103110543 "$ref": "#/components/schemas/NullEnum"
104110543 }
105112721 ],
106112721 },
107121138 "deskew": {
1081150n/a "nullable": true,
109121138 "type": "boolean"
110121138 },
111111525 "image_dpi": {
112111822 "format": "int64",
11311183 "maximum": 9223372036854775807,
11411183 "minimum": 1,
1151140n/a "nullable": true,
116112119 "type": "integer"
117111525 },
11811353 "language": {
11911353 "maxLength": 32,
1201138n/a "nullable": true,
1211138n/a "type": "string"
12211353 },
12311356 "llm_api_key": {
12411383 "maxLength": 1024,
12511383 "minLength": 1,
1261141n/a "nullable": true,
1271141n/a "type": "string"
12811356 },
129111821 "llm_backend": {
1301139n/a "nullable": true,
131111821 "oneOf": [
132101129 {
133101129 "$ref": "#/components/schemas/LlmBackendEnum"
134101129 },
13541135 {
13641135 "$ref": "#/components/schemas/BlankEnum"
13741135 },
138110435 {
139110435 "$ref": "#/components/schemas/NullEnum"
140110435 }
141111821 ],
142111821 },
143110425 "llm_context_size": {
144110722 "format": "int64",
14511073 "maximum": 9223372036854775807,
14611073 "minimum": 1,
1471129n/a "nullable": true,
148111019 "type": "integer"
149110425 },
15011206 "llm_embedding_api_key": {
15111233 "maxLength": 1024,
15211233 "minLength": 1,
1531126n/a "nullable": true,
1541126n/a "type": "string"
15511206 },
156110221 "llm_embedding_backend": {
1571123n/a "nullable": true,
158110221 "oneOf": [
159131110 {
160131110 "$ref": "#/components/schemas/LlmEmbeddingBackendEnum"
161131110 },
16231120 {
16331120 "$ref": "#/components/schemas/BlankEnum"
16431120 },
165108637 {
166108637 "$ref": "#/components/schemas/NullEnum"
167108637 }
168110221 ],
169110221 },
170109329 "llm_embedding_chunk_size": {
171109626 "format": "int64",
17210963 "maximum": 9223372036854775807,
17310963 "minimum": 1,
1741122n/a "nullable": true,
175109923 "type": "integer"
176109329 },
17711163 "llm_embedding_endpoint": {
17811163 "maxLength": 256,
1791119n/a "nullable": true,
1801119n/a "type": "string"
18111163 },
18211143 "llm_embedding_model": {
18311143 "maxLength": 128,
1841117n/a "nullable": true,
1851117n/a "type": "string"
18611143 },
18711073 "llm_endpoint": {
18811073 "maxLength": 256,
1891110n/a "nullable": true,
1901110n/a "type": "string"
19111073 },
19211033 "llm_model": {
19311033 "maxLength": 128,
1941106n/a "nullable": true,
1951106n/a "type": "string"
19611033 },
19711023 "llm_output_language": {
19811023 "maxLength": 32,
1991105n/a "nullable": true,
2001105n/a "type": "string"
20111023 },
202107824 "llm_request_timeout": {
203108121 "format": "int64",
20410813 "maximum": 9223372036854775807,
20510813 "minimum": 1,
2061102n/a "nullable": true,
207108418 "type": "integer"
208107824 },
209108023 "max_image_pixels": {
210108320 "format": "double",
21110803 "minimum": 0.0,
2121103n/a "nullable": true,
213108320 "type": "number"
214108023 },
215107221 "mode": {
2161093n/a "nullable": true,
217107221 "oneOf": [
218131080 {
219131080 "$ref": "#/components/schemas/ModeEnum"
220131080 },
22141089 {
22241089 "$ref": "#/components/schemas/BlankEnum"
22341089 },
224105538 {
225105538 "$ref": "#/components/schemas/NullEnum"
226105538 }
227107221 ],
228107221 },
229107721 "output_type": {
2301098n/a "nullable": true,
231107721 "oneOf": [
232161082 {
233161082 "$ref": "#/components/schemas/OutputTypeEnum"
234161082 },
23581090 {
23681090 "$ref": "#/components/schemas/BlankEnum"
23781090 },
238105345 {
239105345 "$ref": "#/components/schemas/NullEnum"
240105345 }
241107721 ],
242107721 },
243106727 "pages": {
244107024 "format": "int64",
24510703 "maximum": 9223372036854775807,
24610703 "minimum": 1,
2471094n/a "nullable": true,
248107321 "type": "integer"
249106727 },
25010836 "remote_ocr_api_key": {
25110863 "maxLength": 1024,
25210863 "minLength": 1,
2531089n/a "nullable": true,
2541089n/a "type": "string"
25510836 },
25610793 "remote_ocr_endpoint": {
25710793 "maxLength": 256,
2581082n/a "nullable": true,
2591082n/a "type": "string"
26010793 },
261106121 "remote_ocr_engine": {
2621082n/a "nullable": true,
263106121 "oneOf": [
26441078 {
26541078 "$ref": "#/components/schemas/RemoteOcrEngineEnum"
26641078 },
26751077 {
26851077 "$ref": "#/components/schemas/BlankEnum"
26951077 },
270105230 {
271105230 "$ref": "#/components/schemas/NullEnum"
272105230 }
273106121 ],
274106121 },
275105721 "remote_ocr_mode": {
2761078n/a "nullable": true,
277105721 "oneOf": [
27871071 {
27971071 "$ref": "#/components/schemas/RemoteOcrModeEnum"
28071071 },
28161072 {
28261072 "$ref": "#/components/schemas/BlankEnum"
28361072 },
284104434 {
285104434 "$ref": "#/components/schemas/NullEnum"
286104434 }
287105721 ],
288105721 },
289111062 "rotate_pages": {
2901073n/a "nullable": true,
291111062 "type": "boolean"
292111062 },
293105318 "rotate_pages_threshold": {
294105615 "format": "double",
29510533 "minimum": 0.0,
2961071n/a "nullable": true,
297105615 "type": "number"
298105318 },
299104521 "unpaper_clean": {
3001066n/a "nullable": true,
301104521 "oneOf": [
30291057 {
30391057 "$ref": "#/components/schemas/UnpaperCleanEnum"
30491057 },
30531063 {
30631063 "$ref": "#/components/schemas/BlankEnum"
30731063 },
308103333 {
309103333 "$ref": "#/components/schemas/NullEnum"
310103333 }
311104521 ],
312104521 },
3131378n/a "user_args": {
3141378n/a "nullable": true
3151378n/a }
3161331250 },
317136914 "required": [
31813749 "barcode_tag_mapping",
31913785 "user_args"
320136914 ],
3211383n/a "type": "object"
3221271256}
Referenced Components (11)31 of 31 keywords
ArchiveFileGenerationEnum3 of 3 keywords
1101180{
2101180 "enum": [
34n/a "auto",
43n/a "always",
53n/a "never"
6101180 ],
742n/a "type": "string"
8101180}
BlankEnum2 of 2 keywords
1519966{
2519966 "enum": [
351n/a ""
4519966 ]
5519966}
ColorConversionStrategyEnum3 of 3 keywords
1151133{
2151133 "enum": [
33n/a "LeaveColorUnchanged",
43n/a "RGB",
53n/a "UseDeviceIndependentColor",
63n/a "Gray",
73n/a "CMYK"
8151133 ],
943n/a "type": "string"
10151133}
LlmBackendEnum3 of 3 keywords
1101129{
2101129 "enum": [
36n/a "openai-like",
44n/a "ollama"
5101129 ],
635n/a "type": "string"
7101129}
LlmEmbeddingBackendEnum3 of 3 keywords
1131110{
2131110 "enum": [
33n/a "openai-like",
44n/a "huggingface",
56n/a "ollama"
6131110 ],
737n/a "type": "string"
8131110}
ModeEnum3 of 3 keywords
1131080{
2131080 "enum": [
34n/a "auto",
43n/a "force",
53n/a "redo",
63n/a "off"
7131080 ],
838n/a "type": "string"
9131080}
NullEnum2 of 2 keywords
19680337{
29680337 "enum": [
39680n/a null
49680337 ]
59680337}
OutputTypeEnum3 of 3 keywords
1161082{
2161082 "enum": [
33n/a "pdf",
43n/a "pdfa",
53n/a "pdfa-1",
63n/a "pdfa-2",
74n/a "pdfa-3"
8161082 ],
945n/a "type": "string"
10161082}
RemoteOcrEngineEnum3 of 3 keywords
141078{
241078 "enum": [
34n/a "azureai"
441078 ],
530n/a "type": "string"
641078}
RemoteOcrModeEnum3 of 3 keywords
171071{
271071 "enum": [
34n/a "always",
43n/a "workflow_only"
571071 ],
634n/a "type": "string"
771071}
UnpaperCleanEnum3 of 3 keywords
191057{
291057 "enum": [
33n/a "clean",
43n/a "clean-final",
53n/a "none"
691057 ],
733n/a "type": "string"
891057}
Responses1 of 1 documented received
codedescriptionhitsavg
2004977ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request11605ms
404Not Found13763ms
500Internal Server Error14645ms
401Unauthorized359ms
41523ms
correspondents 6 operations 3 covered 3 partial 0 uncovered 0 not measured 71% #
Query Parameters11 of 11 keywords covered
full_perms1 / 1
#validinvalidschema
11876219{
21876219 "type": "boolean"
31876219}
id1 / 1
13509184{
23509184 "type": "integer"
33509184}
id__in2 / 2
11209851{
21209851 "items": {
382251296 "type": "integer"
41209851 },
52060n/a "type": "array"
61209851}
name__icontains1 / 1
11778n/a{
21778n/a "type": "string"
31778n/a}
name__iendswith1 / 1
11746n/a{
21746n/a "type": "string"
31746n/a}
name__iexact1 / 1
11816n/a{
21816n/a "type": "string"
31816n/a}
name__istartswith1 / 1
11764n/a{
21764n/a "type": "string"
31764n/a}
ordering1 / 1
11749n/a{
21749n/a "type": "string"
31749n/a}
page1 / 1
11643147{
21643147 "type": "integer"
31643147}
page_size1 / 1
11643232{
21643232 "type": "integer"
31643232}
Responses1 of 1 documented received
codedescriptionhitsavg
20019546ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found15225ms
401Unauthorized2933ms
400Bad Request3274ms
500Internal Server Error1616ms
Body65 of 93 keywords covered
application/json31 / 31
CorrespondentRequest
#validinvalidschema
11434230{
21443208 "properties": {
398518 "is_insensitive": {
498518 "type": "boolean"
598518 },
690513 "match": {
79053 "maxLength": 256,
890810 "type": "string"
990513 },
1088818 "matching_algorithm": {
111n/a "allOf": [
1288818 {
1388818 "$ref": "#/components/schemas/MatchingAlgorithm"
1488818 }
151n/a ],
168932 "maximum": 9223372036854775807,
178923 "minimum": 0
1888818 },
19161923 "name": {
2016257 "maxLength": 128,
2116266 "minLength": 1,
22163210 "type": "string"
23161923 },
2492912 "owner": {
25941n/a "nullable": true,
2692912 "type": "integer"
2792912 },
28797126 "set_permissions": {
291n/a "allOf": [
30797126 {
31797126 "$ref": "#/components/schemas/SetPermissionsRequest"
32797126 }
331n/a ],
34 "writeOnly": true
35797126 }
361443208 },
37164212 "required": [
38164212 "name"
39164212 ],
40165410 "type": "object"
411434230}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
188818{
288818 "enum": [
3352n/a 0,
455n/a 1,
596n/a 2,
694n/a 3,
7103n/a 4,
880n/a 5,
9108n/a 6
1088818 ],
1189313 "type": "integer"
1288818}
PermissionSetRequest9 of 9 keywords
11027124{
2823104 "properties": {
374158 "groups": {
458429 "items": {
567544 "type": "integer"
658429 },
7799n/a "nullable": true,
877029 "type": "array"
974158 },
1077152 "users": {
1161931 "items": {
12109253 "type": "integer"
1361931 },
14823n/a "nullable": true,
1580221 "type": "array"
1677152 }
17823104 },
18113120 "type": "object"
191027124}
SetPermissionsRequest5 of 5 keywords
1797126{
2558116 "properties": {
352362 "change": {
452362 "$ref": "#/components/schemas/PermissionSetRequest"
552362 },
650462 "view": {
750462 "$ref": "#/components/schemas/PermissionSetRequest"
850462 }
9558116 },
1091310 "type": "object"
11797126}
application/x-www-form-urlencoded17 / 31
CorrespondentRequest
1789491{
2790485 "properties": {
37094 "is_insensitive": {
47094 "type": "boolean"
57094 },
666214 "match": {
766214 "maxLength": 256,
8676n/a "type": "string"
966214 },
1066325 "matching_algorithm": {
111n/a "allOf": [
1266325 {
1366325 "$ref": "#/components/schemas/MatchingAlgorithm"
1466325 }
151n/a ],
166722 "maximum": 9223372036854775807,
176695 "minimum": 0
1866325 },
19124425 "name": {
20125910 "maxLength": 128,
21125415 "minLength": 1,
221269n/a "type": "string"
23124425 },
24232454 "owner": {
25686n/a "nullable": true,
26232454 "type": "integer"
27232454 },
2803 "set_permissions": {
290n/a "allOf": [
3003 {
3103 "$ref": "#/components/schemas/SetPermissionsRequest"
3203 }
330n/a ],
34 "writeOnly": true
3503 }
36790485 },
37126911 "required": [
38126911 "name"
39126911 ],
401280n/a "type": "object"
41789491}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
166325{
266325 "enum": [
3189n/a 0,
475n/a 1,
571n/a 2,
676n/a 3,
775n/a 4,
869n/a 5,
9108n/a 6
1066325 ],
1167414 "type": "integer"
1266325}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
103{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1003 "type": "object"
1103}
multipart/form-data17 / 31
CorrespondentRequest
1279588{
2279586 "properties": {
346616 "is_insensitive": {
446616 "type": "boolean"
546616 },
64916 "match": {
74916 "maxLength": 256,
8497n/a "type": "string"
94916 },
1048516 "matching_algorithm": {
111n/a "allOf": [
1248516 {
1348516 "$ref": "#/components/schemas/MatchingAlgorithm"
1448516 }
151n/a ],
164872 "maximum": 9223372036854775807,
174872 "minimum": 0
1848516 },
1984912 "name": {
208529 "maxLength": 128,
218583 "minLength": 1,
22861n/a "type": "string"
2384912 },
24151388 "owner": {
25539n/a "nullable": true,
26151388 "type": "integer"
27151388 },
280512 "set_permissions": {
290n/a "allOf": [
300512 {
310512 "$ref": "#/components/schemas/SetPermissionsRequest"
320512 }
330n/a ],
34 "writeOnly": true
350512 }
36279586 },
378616 "required": [
388616 "name"
398616 ],
40867n/a "type": "object"
41279588}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
148516{
248516 "enum": [
3220n/a 0,
450n/a 1,
555n/a 2,
634n/a 3,
737n/a 4,
852n/a 5,
937n/a 6
1048516 ],
1148912 "type": "integer"
1248516}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10512{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100512 "type": "object"
110512}
Responses1 of 1 documented received
codedescriptionhitsavg
20187014ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request32864ms
401Unauthorized1204ms
41523ms
500Internal Server Error156ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
122615{
222615 "type": "integer"
322615}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body9014ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1264ms
401Unauthorized2510ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
166212{
266212 "type": "integer"
366212}
Query Parameters1 of 1 keywords covered
full_perms1 / 1
116472{
216472 "type": "boolean"
316472}
Responses1 of 1 documented received
codedescriptionhitsavg
2003865ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2710ms
404Not Found2614ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
198213{
298213 "type": "integer"
398213}
Body62 of 90 keywords covered
application/json30 / 30
PatchedCorrespondentRequest
1300103{
212798 "properties": {
31777 "is_insensitive": {
41777 "type": "boolean"
51777 },
61626 "match": {
71621 "maxLength": 256,
81635 "type": "string"
91626 },
101639 "matching_algorithm": {
111n/a "allOf": [
121639 {
131639 "$ref": "#/components/schemas/MatchingAlgorithm"
141639 }
151n/a ],
161652 "maximum": 9223372036854775807,
171661 "minimum": 0
181639 },
191707 "name": {
201711 "maxLength": 128,
211711 "minLength": 1,
221725 "type": "string"
231707 },
241749 "owner": {
25183n/a "nullable": true,
261749 "type": "integer"
271749 },
2811565 "set_permissions": {
291n/a "allOf": [
3011565 {
3111565 "$ref": "#/components/schemas/SetPermissionsRequest"
3211565 }
331n/a ],
34 "writeOnly": true
3511565 }
3612798 },
373985 "type": "object"
38300103}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11639{
21639 "enum": [
3124n/a 0,
410n/a 1,
510n/a 2,
66n/a 3,
72n/a 4,
87n/a 5,
94n/a 6
101639 ],
111657 "type": "integer"
121639}
PermissionSetRequest9 of 9 keywords
122565{
220752 "properties": {
322430 "groups": {
421514 "items": {
55416 "type": "integer"
621514 },
7254n/a "nullable": true,
823816 "type": "array"
922430 },
1021930 "users": {
1120914 "items": {
121516 "type": "integer"
1320914 },
14249n/a "nullable": true,
1523316 "type": "array"
1621930 }
1720752 },
1827713 "type": "object"
1922565}
SetPermissionsRequest5 of 5 keywords
111565{
29360 "properties": {
311632 "change": {
411632 "$ref": "#/components/schemas/PermissionSetRequest"
511632 },
610933 "view": {
710933 "$ref": "#/components/schemas/PermissionSetRequest"
810933 }
99360 },
101755 "type": "object"
1111565}
application/x-www-form-urlencoded16 / 30
PatchedCorrespondentRequest
141114{
230114 "properties": {
31222 "is_insensitive": {
41222 "type": "boolean"
51222 },
61204 "match": {
71204 "maxLength": 256,
8124n/a "type": "string"
91204 },
1011012 "matching_algorithm": {
111n/a "allOf": [
1211012 {
1311012 "$ref": "#/components/schemas/MatchingAlgorithm"
1411012 }
151n/a ],
161162 "maximum": 9223372036854775807,
171126 "minimum": 0
1811012 },
191159 "name": {
201186 "maxLength": 128,
211213 "minLength": 1,
22124n/a "type": "string"
231159 },
2421104 "owner": {
25125n/a "nullable": true,
2621104 "type": "integer"
2721104 },
2800 "set_permissions": {
290n/a "allOf": [
3000 {
3100 "$ref": "#/components/schemas/SetPermissionsRequest"
3200 }
330n/a ],
34 "writeOnly": true
3500 }
3630114 },
37155n/a "type": "object"
3841114}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
111012{
211012 "enum": [
379n/a 0,
43n/a 1,
56n/a 2,
66n/a 3,
72n/a 4,
84n/a 5,
910n/a 6
1011012 ],
111184 "type": "integer"
1211012}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data16 / 30
PatchedCorrespondentRequest
165146{
228146 "properties": {
31415 "is_insensitive": {
41415 "type": "boolean"
51415 },
61442 "match": {
71442 "maxLength": 256,
8146n/a "type": "string"
91442 },
101379 "matching_algorithm": {
111n/a "allOf": [
121379 {
131379 "$ref": "#/components/schemas/MatchingAlgorithm"
141379 }
151n/a ],
161381 "maximum": 9223372036854775807,
171381 "minimum": 0
181379 },
191472 "name": {
201481 "maxLength": 128,
211481 "minLength": 1,
22149n/a "type": "string"
231472 },
2415125 "owner": {
25140n/a "nullable": true,
2615125 "type": "integer"
2715125 },
280139 "set_permissions": {
290n/a "allOf": [
300139 {
310139 "$ref": "#/components/schemas/SetPermissionsRequest"
320139 }
330n/a ],
34 "writeOnly": true
350139 }
3628146 },
37211n/a "type": "object"
3865146}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11379{
21379 "enum": [
398n/a 0,
44n/a 1,
517n/a 2,
64n/a 3,
73n/a 4,
82n/a 5,
99n/a 6
101379 ],
111397 "type": "integer"
121379}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10139{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100139 "type": "object"
110139}
Responses1 of 1 documented received
codedescriptionhitsavg
20029215ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3234ms
400Bad Request3476ms
401Unauthorized329ms
415113ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
199222{
299222 "type": "integer"
399222}
Body65 of 93 keywords covered
application/json31 / 31
CorrespondentRequest
1439106{
2440100 "properties": {
32745 "is_insensitive": {
42745 "type": "boolean"
52745 },
61956 "match": {
71951 "maxLength": 256,
81965 "type": "string"
91956 },
102689 "matching_algorithm": {
111n/a "allOf": [
122689 {
132689 "$ref": "#/components/schemas/MatchingAlgorithm"
142689 }
151n/a ],
162711 "maximum": 9223372036854775807,
172702 "minimum": 0
182689 },
195309 "name": {
205322 "maxLength": 128,
215322 "minLength": 1,
225345 "type": "string"
235309 },
2418612 "owner": {
25198n/a "nullable": true,
2618612 "type": "integer"
2718612 },
2817566 "set_permissions": {
291n/a "allOf": [
3017566 {
3117566 "$ref": "#/components/schemas/SetPermissionsRequest"
3217566 }
331n/a ],
34 "writeOnly": true
3517566 }
36440100 },
375391 "required": [
385391 "name"
395391 ],
405405 "type": "object"
41439106}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
12689{
22689 "enum": [
3141n/a 0,
434n/a 1,
560n/a 2,
68n/a 3,
77n/a 4,
811n/a 5,
97n/a 6
102689 ],
112716 "type": "integer"
122689}
PermissionSetRequest9 of 9 keywords
128566{
226956 "properties": {
328222 "groups": {
421614 "items": {
54516 "type": "integer"
621614 },
7304n/a "nullable": true,
82968 "type": "array"
928222 },
1023234 "users": {
1122116 "items": {
124724 "type": "integer"
1322116 },
14266n/a "nullable": true,
1524818 "type": "array"
1623234 }
1726956 },
1834110 "type": "object"
1928566}
SetPermissionsRequest5 of 5 keywords
117566{
214861 "properties": {
311734 "change": {
411734 "$ref": "#/components/schemas/PermissionSetRequest"
511734 },
616832 "view": {
716832 "$ref": "#/components/schemas/PermissionSetRequest"
816832 }
914861 },
102365 "type": "object"
1117566}
application/x-www-form-urlencoded17 / 31
CorrespondentRequest
1113108{
2113107 "properties": {
31182 "is_insensitive": {
41182 "type": "boolean"
51182 },
61322 "match": {
71322 "maxLength": 256,
8134n/a "type": "string"
91322 },
1013715 "matching_algorithm": {
111n/a "allOf": [
1213715 {
1313715 "$ref": "#/components/schemas/MatchingAlgorithm"
1413715 }
151n/a ],
161431 "maximum": 9223372036854775807,
171386 "minimum": 0
1813715 },
192127 "name": {
202163 "maxLength": 128,
212154 "minLength": 1,
22219n/a "type": "string"
232127 },
243093 "owner": {
25123n/a "nullable": true,
263093 "type": "integer"
273093 },
2800 "set_permissions": {
290n/a "allOf": [
3000 {
3100 "$ref": "#/components/schemas/SetPermissionsRequest"
3200 }
330n/a ],
34 "writeOnly": true
3500 }
36113107 },
372192 "required": [
382192 "name"
392192 ],
40221n/a "type": "object"
41113108}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
113715{
213715 "enum": [
380n/a 0,
416n/a 1,
511n/a 2,
63n/a 3,
711n/a 4,
811n/a 5,
95n/a 6
1013715 ],
111448 "type": "integer"
1213715}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data17 / 31
CorrespondentRequest
154134{
254134 "properties": {
31275 "is_insensitive": {
41275 "type": "boolean"
51275 },
61331 "match": {
71331 "maxLength": 256,
8134n/a "type": "string"
91331 },
1011213 "matching_algorithm": {
111n/a "allOf": [
1211213 {
1311213 "$ref": "#/components/schemas/MatchingAlgorithm"
1411213 }
151n/a ],
161153 "maximum": 9223372036854775807,
171171 "minimum": 0
1811213 },
191852 "name": {
201861 "maxLength": 128,
211861 "minLength": 1,
22187n/a "type": "string"
231852 },
2411116 "owner": {
25127n/a "nullable": true,
2611116 "type": "integer"
2711116 },
280130 "set_permissions": {
290n/a "allOf": [
300130 {
310130 "$ref": "#/components/schemas/SetPermissionsRequest"
320130 }
330n/a ],
34 "writeOnly": true
350130 }
3654134 },
371871 "required": [
381871 "name"
391871 ],
40188n/a "type": "object"
4154134}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
111213{
211213 "enum": [
392n/a 0,
45n/a 1,
53n/a 2,
62n/a 3,
73n/a 4,
85n/a 5,
92n/a 6
1011213 ],
111187 "type": "integer"
1211213}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10130{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100130 "type": "object"
110130}
Responses1 of 1 documented received
codedescriptionhitsavg
20015815ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4825ms
404Not Found3524ms
41513ms
401Unauthorized2112ms
custom_fields 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters10 of 10 keywords covered
id1 / 1
#validinvalidschema
13675191{
23675191 "type": "integer"
33675191}
id__in2 / 2
11208870{
21208870 "items": {
390423316 "type": "integer"
41208870 },
52078n/a "type": "array"
61208870}
name__icontains1 / 1
11936n/a{
21936n/a "type": "string"
31936n/a}
name__iendswith1 / 1
11910n/a{
21910n/a "type": "string"
31910n/a}
name__iexact1 / 1
11889n/a{
21889n/a "type": "string"
31889n/a}
name__istartswith1 / 1
11911n/a{
21911n/a "type": "string"
31911n/a}
ordering1 / 1
11871n/a{
21871n/a "type": "string"
31871n/a}
page1 / 1
11767102{
21767102 "type": "integer"
31767102}
page_size1 / 1
11824112{
21824112 "type": "integer"
31824112}
Responses1 of 1 documented received
codedescriptionhitsavg
20020306ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found15306ms
401Unauthorized2383ms
400Bad Request3005ms
500Internal Server Error2078ms
Body30 of 30 keywords covered
application/json10 / 10
CustomFieldRequest
#validinvalidschema
1110286{
2111463 "properties": {
3114324 "data_type": {
4114324 "$ref": "#/components/schemas/DataTypeEnum"
5114324 },
670n/a "extra_data": {
770n/a "nullable": true
870n/a },
9113441 "name": {
1011566 "maxLength": 128,
11114022 "minLength": 1,
12116213 "type": "string"
13113441 }
14111463 },
15116512 "required": [
16116710 "data_type",
1711752 "name"
18116512 ],
19117711 "type": "object"
20110286}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
1114324{
2114324 "enum": [
3123n/a "string",
4213n/a "url",
5105n/a "date",
6112n/a "boolean",
786n/a "integer",
8114n/a "float",
9117n/a "monetary",
1071n/a "documentlink",
11110n/a "select",
1292n/a "longtext"
13114324 ],
14115710 "type": "string"
15114324}
application/x-www-form-urlencoded10 / 10
CustomFieldRequest
11176127{
2121092 "properties": {
3121459 "data_type": {
4121459 "$ref": "#/components/schemas/DataTypeEnum"
5121459 },
646n/a "extra_data": {
746n/a "nullable": true
846n/a },
9124255 "name": {
10126136 "maxLength": 128,
11127819 "minLength": 1,
121297n/a "type": "string"
13124255 }
14121092 },
15126835 "required": [
16127330 "data_type",
1712976 "name"
18126835 ],
191303n/a "type": "object"
201176127}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
1121459{
2121459 "enum": [
3134n/a "string",
4158n/a "url",
5107n/a "date",
6131n/a "boolean",
7140n/a "integer",
8104n/a "float",
9103n/a "monetary",
10110n/a "documentlink",
1184n/a "select",
12143n/a "longtext"
13121459 ],
141273n/a "type": "string"
15121459}
multipart/form-data10 / 10
CustomFieldRequest
161438{
262230 "properties": {
363313 "data_type": {
463313 "$ref": "#/components/schemas/DataTypeEnum"
563313 },
653n/a "extra_data": {
753n/a "nullable": true
853n/a },
963317 "name": {
106419 "maxLength": 128,
116428 "minLength": 1,
12650n/a "type": "string"
1363317 }
1462230 },
156448 "required": [
166466 "data_type",
176502 "name"
186448 ],
19652n/a "type": "object"
2061438}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
163313{
263313 "enum": [
3100n/a "string",
493n/a "url",
577n/a "date",
640n/a "boolean",
743n/a "integer",
836n/a "float",
958n/a "monetary",
1046n/a "documentlink",
1158n/a "select",
1282n/a "longtext"
1363313 ],
14646n/a "type": "string"
1563313}
Responses1 of 1 documented received
codedescriptionhitsavg
201113114ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request24475ms
401Unauthorized1533ms
41523ms
500Internal Server Error17ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
12718{
22718 "type": "integer"
32718}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body13615ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1115ms
401Unauthorized328ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
169519{
269519 "type": "integer"
369519}
Responses1 of 1 documented received
codedescriptionhitsavg
2003695ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2835ms
401Unauthorized625ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
180418{
280418 "type": "integer"
380418}
Body27 of 27 keywords covered
application/json9 / 9
PatchedCustomFieldRequest
131135{
211026 "properties": {
310211 "data_type": {
410211 "$ref": "#/components/schemas/DataTypeEnum"
510211 },
644n/a "extra_data": {
744n/a "nullable": true
844n/a },
99418 "name": {
101005 "maxLength": 128,
11996 "minLength": 1,
121057 "type": "string"
139418 }
1411026 },
153379 "type": "object"
1631135}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
110211{
210211 "enum": [
332n/a "string",
417n/a "url",
57n/a "date",
65n/a "boolean",
72n/a "integer",
815n/a "float",
92n/a "monetary",
108n/a "documentlink",
119n/a "select",
125n/a "longtext"
1310211 ],
141085 "type": "string"
1510211}
application/x-www-form-urlencoded9 / 9
PatchedCustomFieldRequest
110528{
28028 "properties": {
38013 "data_type": {
48013 "$ref": "#/components/schemas/DataTypeEnum"
58013 },
623n/a "extra_data": {
723n/a "nullable": true
823n/a },
96821 "name": {
10836 "maxLength": 128,
117415 "minLength": 1,
1289n/a "type": "string"
136821 }
148028 },
15133n/a "type": "object"
1610528}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
18013{
28013 "enum": [
316n/a "string",
46n/a "url",
53n/a "date",
66n/a "boolean",
718n/a "integer",
810n/a "float",
93n/a "monetary",
1011n/a "documentlink",
113n/a "select",
124n/a "longtext"
138013 ],
1493n/a "type": "string"
158013}
multipart/form-data9 / 9
PatchedCustomFieldRequest
18910{
25210 "properties": {
3495 "data_type": {
4495 "$ref": "#/components/schemas/DataTypeEnum"
5495 },
628n/a "extra_data": {
728n/a "nullable": true
828n/a },
9426 "name": {
10444 "maxLength": 128,
11462 "minLength": 1,
1248n/a "type": "string"
13426 }
145210 },
1599n/a "type": "object"
168910}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
1495{
2495 "enum": [
321n/a "string",
46n/a "url",
51n/a "date",
66n/a "boolean",
74n/a "integer",
81n/a "float",
92n/a "monetary",
102n/a "documentlink",
112n/a "select",
124n/a "longtext"
13495 ],
1454n/a "type": "string"
15495}
Responses1 of 1 documented received
codedescriptionhitsavg
20029215ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3605ms
400Bad Request1326ms
401Unauthorized378ms
41516ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
17799{
27799 "type": "integer"
37799}
Body30 of 30 keywords covered
application/json10 / 10
CustomFieldRequest
133930{
234222 "properties": {
335210 "data_type": {
435210 "$ref": "#/components/schemas/DataTypeEnum"
535210 },
639n/a "extra_data": {
739n/a "nullable": true
839n/a },
934815 "name": {
103517 "maxLength": 128,
113553 "minLength": 1,
123585 "type": "string"
1334815 }
1434222 },
153613 "required": [
163622 "data_type",
173631 "name"
183613 ],
193645 "type": "object"
2033930}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
135210{
235210 "enum": [
332n/a "string",
4156n/a "url",
524n/a "date",
612n/a "boolean",
77n/a "integer",
828n/a "float",
99n/a "monetary",
1015n/a "documentlink",
1110n/a "select",
1259n/a "longtext"
1335210 ],
143575 "type": "string"
1535210}
application/x-www-form-urlencoded10 / 10
CustomFieldRequest
112827{
213916 "properties": {
31396 "data_type": {
41396 "$ref": "#/components/schemas/DataTypeEnum"
51396 },
623n/a "extra_data": {
723n/a "nullable": true
823n/a },
914410 "name": {
101522 "maxLength": 128,
111468 "minLength": 1,
12154n/a "type": "string"
1314410 }
1413916 },
1514411 "required": [
1614510 "data_type",
171541 "name"
1814411 ],
19155n/a "type": "object"
2012827}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
11396{
21396 "enum": [
323n/a "string",
420n/a "url",
513n/a "date",
611n/a "boolean",
76n/a "integer",
817n/a "float",
911n/a "monetary",
1017n/a "documentlink",
1113n/a "select",
128n/a "longtext"
131396 ],
14145n/a "type": "string"
151396}
multipart/form-data10 / 10
CustomFieldRequest
11387{
21405 "properties": {
31413 "data_type": {
41413 "$ref": "#/components/schemas/DataTypeEnum"
51413 },
627n/a "extra_data": {
727n/a "nullable": true
827n/a },
91422 "name": {
101431 "maxLength": 128,
111431 "minLength": 1,
12144n/a "type": "string"
131422 }
141405 },
151432 "required": [
161441 "data_type",
171441 "name"
181432 ],
19145n/a "type": "object"
201387}
Referenced Components (1)3 of 3 keywords
DataTypeEnum3 of 3 keywords
11413{
21413 "enum": [
324n/a "string",
411n/a "url",
519n/a "date",
65n/a "boolean",
75n/a "integer",
85n/a "float",
98n/a "monetary",
1050n/a "documentlink",
111n/a "select",
1213n/a "longtext"
131413 ],
14144n/a "type": "string"
151413}
Responses1 of 1 documented received
codedescriptionhitsavg
20017416ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2496ms
404Not Found3345ms
401Unauthorized2411ms
500Internal Server Error614ms
415114ms
document_types 6 operations 3 covered 3 partial 0 uncovered 0 not measured 71% #
Query Parameters11 of 11 keywords covered
full_perms1 / 1
#validinvalidschema
11996144{
21996144 "type": "boolean"
31996144}
id1 / 1
13772121{
23772121 "type": "integer"
33772121}
id__in2 / 2
11288800{
21288800 "items": {
392641626 "type": "integer"
41288800 },
52088n/a "type": "array"
61288800}
name__icontains1 / 1
11901n/a{
21901n/a "type": "string"
31901n/a}
name__iendswith1 / 1
11974n/a{
21974n/a "type": "string"
31974n/a}
name__iexact1 / 1
11908n/a{
21908n/a "type": "string"
31908n/a}
name__istartswith1 / 1
11866n/a{
21866n/a "type": "string"
31866n/a}
ordering1 / 1
11919n/a{
21919n/a "type": "string"
31919n/a}
page1 / 1
11825110{
21825110 "type": "integer"
31825110}
page_size1 / 1
11877114{
21877114 "type": "integer"
31877114}
Responses1 of 1 documented received
codedescriptionhitsavg
20019456ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found15834ms
401Unauthorized2723ms
400Bad Request3205ms
500Internal Server Error2126ms
Body65 of 93 keywords covered
application/json31 / 31
DocumentTypeRequest
#validinvalidschema
11194139{
21197131 "properties": {
36865 "is_insensitive": {
46865 "type": "boolean"
56865 },
668213 "match": {
76826 "maxLength": 256,
86887 "type": "string"
968213 },
1065714 "matching_algorithm": {
111n/a "allOf": [
1265714 {
1365714 "$ref": "#/components/schemas/MatchingAlgorithm"
1465714 }
151n/a ],
166615 "maximum": 9223372036854775807,
176651 "minimum": 0
1865714 },
19130520 "name": {
20130811 "maxLength": 128,
2113163 "minLength": 1,
2213196 "type": "string"
23130520 },
246678 "owner": {
25675n/a "nullable": true,
266678 "type": "integer"
276678 },
2860880 "set_permissions": {
291n/a "allOf": [
3060880 {
3160880 "$ref": "#/components/schemas/SetPermissionsRequest"
3260880 }
331n/a ],
34 "writeOnly": true
3560880 }
361197131 },
3713253 "required": [
3813253 "name"
3913253 ],
4013285 "type": "object"
411194139}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
165714{
265714 "enum": [
3210n/a 0,
479n/a 1,
577n/a 2,
660n/a 3,
769n/a 4,
883n/a 5,
979n/a 6
1065714 ],
116638 "type": "integer"
1265714}
PermissionSetRequest9 of 9 keywords
169685{
245375 "properties": {
342649 "groups": {
432025 "items": {
5625109 "type": "integer"
632025 },
7475n/a "nullable": true,
845124 "type": "array"
942649 },
1042333 "users": {
1132019 "items": {
1253376 "type": "integer"
1332019 },
14456n/a "nullable": true,
1544214 "type": "array"
1642333 }
1745375 },
1877110 "type": "object"
1969685}
SetPermissionsRequest5 of 5 keywords
160880{
239673 "properties": {
335541 "change": {
435541 "$ref": "#/components/schemas/PermissionSetRequest"
535541 },
634144 "view": {
734144 "$ref": "#/components/schemas/PermissionSetRequest"
834144 }
939673 },
106817 "type": "object"
1160880}
application/x-www-form-urlencoded17 / 31
DocumentTypeRequest
1904415{
2906412 "properties": {
36622 "is_insensitive": {
46622 "type": "boolean"
56622 },
66197 "match": {
76197 "maxLength": 256,
8626n/a "type": "string"
96197 },
1060432 "matching_algorithm": {
111n/a "allOf": [
1260432 {
1360432 "$ref": "#/components/schemas/MatchingAlgorithm"
1460432 }
151n/a ],
1661712 "maximum": 9223372036854775807,
176254 "minimum": 0
1860432 },
19128629 "name": {
20130114 "maxLength": 128,
21130015 "minLength": 1,
221315n/a "type": "string"
23128629 },
24297371 "owner": {
25668n/a "nullable": true,
26297371 "type": "integer"
27297371 },
2800 "set_permissions": {
290n/a "allOf": [
3000 {
3100 "$ref": "#/components/schemas/SetPermissionsRequest"
3200 }
330n/a ],
34 "writeOnly": true
3500 }
36906412 },
3713154 "required": [
3813154 "name"
3913154 ],
401319n/a "type": "object"
41904415}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
160432{
260432 "enum": [
3153n/a 0,
473n/a 1,
591n/a 2,
664n/a 3,
778n/a 4,
885n/a 5,
960n/a 6
1060432 ],
116297 "type": "integer"
1260432}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data17 / 31
DocumentTypeRequest
1239541{
2239541 "properties": {
347216 "is_insensitive": {
447216 "type": "boolean"
547216 },
64405 "match": {
74405 "maxLength": 256,
8445n/a "type": "string"
94405 },
1045713 "matching_algorithm": {
111n/a "allOf": [
1245713 {
1345713 "$ref": "#/components/schemas/MatchingAlgorithm"
1445713 }
151n/a ],
164622 "maximum": 9223372036854775807,
174595 "minimum": 0
1845713 },
197736 "name": {
207763 "maxLength": 128,
217763 "minLength": 1,
22779n/a "type": "string"
237736 },
24172318 "owner": {
25490n/a "nullable": true,
26172318 "type": "integer"
27172318 },
280478 "set_permissions": {
290n/a "allOf": [
300478 {
310478 "$ref": "#/components/schemas/SetPermissionsRequest"
320478 }
330n/a ],
34 "writeOnly": true
350478 }
36239541 },
377791 "required": [
387791 "name"
397791 ],
40780n/a "type": "object"
41239541}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
145713{
245713 "enum": [
3136n/a 0,
439n/a 1,
558n/a 2,
660n/a 3,
756n/a 4,
864n/a 5,
944n/a 6
1045713 ],
114646 "type": "integer"
1245713}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10478{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100478 "type": "object"
110478}
Responses1 of 1 documented received
codedescriptionhitsavg
20174914ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request31104ms
401Unauthorized1464ms
41513ms
500Internal Server Error96ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
137721{
237721 "type": "integer"
337721}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body8615ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2524ms
401Unauthorized605ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168621{
268621 "type": "integer"
368621}
Query Parameters1 of 1 keywords covered
full_perms1 / 1
1173121{
2173121 "type": "boolean"
3173121}
Responses1 of 1 documented received
codedescriptionhitsavg
2003325ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized279ms
404Not Found3484ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1103117{
2103117 "type": "integer"
3103117}
Body62 of 90 keywords covered
application/json30 / 30
PatchedDocumentTypeRequest
1396107{
2175101 "properties": {
31885 "is_insensitive": {
41885 "type": "boolean"
51885 },
61876 "match": {
71871 "maxLength": 256,
81885 "type": "string"
91876 },
102258 "matching_algorithm": {
111n/a "allOf": [
122258 {
132258 "$ref": "#/components/schemas/MatchingAlgorithm"
142258 }
151n/a ],
162271 "maximum": 9223372036854775807,
172271 "minimum": 0
182258 },
1917914 "name": {
201844 "maxLength": 128,
211835 "minLength": 1,
221885 "type": "string"
2317914 },
242266 "owner": {
25232n/a "nullable": true,
262266 "type": "integer"
272266 },
2813663 "set_permissions": {
291n/a "allOf": [
3013663 {
3113663 "$ref": "#/components/schemas/SetPermissionsRequest"
3213663 }
331n/a ],
34 "writeOnly": true
3513663 }
36175101 },
374976 "type": "object"
38396107}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
12258{
22258 "enum": [
3124n/a 0,
415n/a 1,
551n/a 2,
63n/a 3,
75n/a 4,
816n/a 5,
911n/a 6
102258 ],
112276 "type": "integer"
122258}
PermissionSetRequest9 of 9 keywords
126359{
223849 "properties": {
325727 "groups": {
423115 "items": {
512318 "type": "integer"
623115 },
7284n/a "nullable": true,
827212 "type": "array"
925727 },
1024426 "users": {
1122514 "items": {
1218416 "type": "integer"
1322514 },
14270n/a "nullable": true,
1525812 "type": "array"
1624426 }
1723849 },
1831210 "type": "object"
1926359}
SetPermissionsRequest5 of 5 keywords
113663{
210757 "properties": {
313330 "change": {
413330 "$ref": "#/components/schemas/PermissionSetRequest"
513330 },
613029 "view": {
713029 "$ref": "#/components/schemas/PermissionSetRequest"
813029 }
910757 },
101936 "type": "object"
1113663}
application/x-www-form-urlencoded16 / 30
PatchedDocumentTypeRequest
182125{
248125 "properties": {
31472 "is_insensitive": {
41472 "type": "boolean"
51472 },
61422 "match": {
71422 "maxLength": 256,
8144n/a "type": "string"
91422 },
1012511 "matching_algorithm": {
111n/a "allOf": [
1212511 {
1312511 "$ref": "#/components/schemas/MatchingAlgorithm"
1412511 }
151n/a ],
161312 "maximum": 9223372036854775807,
171285 "minimum": 0
1812511 },
191296 "name": {
201323 "maxLength": 128,
211323 "minLength": 1,
22135n/a "type": "string"
231296 },
2418121 "owner": {
25139n/a "nullable": true,
2618121 "type": "integer"
2718121 },
2800 "set_permissions": {
290n/a "allOf": [
3000 {
3100 "$ref": "#/components/schemas/SetPermissionsRequest"
3200 }
330n/a ],
34 "writeOnly": true
3500 }
3648125 },
37207n/a "type": "object"
3882125}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
112511{
212511 "enum": [
378n/a 0,
47n/a 1,
51n/a 2,
616n/a 3,
77n/a 4,
89n/a 5,
97n/a 6
1012511 ],
111333 "type": "integer"
1212511}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data16 / 30
PatchedDocumentTypeRequest
124151{
213151 "properties": {
31465 "is_insensitive": {
41465 "type": "boolean"
51465 },
61471 "match": {
71471 "maxLength": 256,
8148n/a "type": "string"
91471 },
101449 "matching_algorithm": {
111n/a "allOf": [
121449 {
131449 "$ref": "#/components/schemas/MatchingAlgorithm"
141449 }
151n/a ],
161452 "maximum": 9223372036854775807,
171461 "minimum": 0
181449 },
191416 "name": {
201461 "maxLength": 128,
211425 "minLength": 1,
22147n/a "type": "string"
231416 },
2423124 "owner": {
25147n/a "nullable": true,
2623124 "type": "integer"
2723124 },
280149 "set_permissions": {
290n/a "allOf": [
300149 {
310149 "$ref": "#/components/schemas/SetPermissionsRequest"
320149 }
330n/a ],
34 "writeOnly": true
350149 }
3613151 },
37175n/a "type": "object"
3824151}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11449{
21449 "enum": [
3107n/a 0,
45n/a 1,
53n/a 2,
63n/a 3,
74n/a 4,
83n/a 5,
919n/a 6
101449 ],
111476 "type": "integer"
121449}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10149{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100149 "type": "object"
110149}
Responses1 of 1 documented received
codedescriptionhitsavg
20032113ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3004ms
400Bad Request3965ms
401Unauthorized2510ms
41514ms
500Internal Server Error59ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
199912{
299912 "type": "integer"
399912}
Body65 of 93 keywords covered
application/json31 / 31
DocumentTypeRequest
1350103{
235197 "properties": {
32385 "is_insensitive": {
42385 "type": "boolean"
52385 },
61957 "match": {
71951 "maxLength": 256,
81966 "type": "string"
91957 },
101908 "matching_algorithm": {
111n/a "allOf": [
121908 {
131908 "$ref": "#/components/schemas/MatchingAlgorithm"
141908 }
151n/a ],
161921 "maximum": 9223372036854775807,
171921 "minimum": 0
181908 },
1943413 "name": {
204366 "maxLength": 128,
214402 "minLength": 1,
224425 "type": "string"
2343413 },
241915 "owner": {
25196n/a "nullable": true,
261915 "type": "integer"
271915 },
2814159 "set_permissions": {
291n/a "allOf": [
3014159 {
3114159 "$ref": "#/components/schemas/SetPermissionsRequest"
3214159 }
331n/a ],
34 "writeOnly": true
3514159 }
3635197 },
374471 "required": [
384471 "name"
394471 ],
404485 "type": "object"
41350103}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11908{
21908 "enum": [
3133n/a 0,
418n/a 1,
55n/a 2,
62n/a 3,
78n/a 4,
87n/a 5,
917n/a 6
101908 ],
111926 "type": "integer"
121908}
PermissionSetRequest9 of 9 keywords
128554{
224844 "properties": {
326022 "groups": {
423714 "items": {
56916 "type": "integer"
623714 },
7282n/a "nullable": true,
82748 "type": "array"
926022 },
1026322 "users": {
1125114 "items": {
1219216 "type": "integer"
1325114 },
14285n/a "nullable": true,
152778 "type": "array"
1626322 }
1724844 },
1832910 "type": "object"
1928554}
SetPermissionsRequest5 of 5 keywords
114159{
212454 "properties": {
314627 "change": {
414627 "$ref": "#/components/schemas/PermissionSetRequest"
514627 },
613927 "view": {
713927 "$ref": "#/components/schemas/PermissionSetRequest"
813927 }
912454 },
101955 "type": "object"
1114159}
application/x-www-form-urlencoded17 / 31
DocumentTypeRequest
1170123{
2172121 "properties": {
31372 "is_insensitive": {
41372 "type": "boolean"
51372 },
61372 "match": {
71372 "maxLength": 256,
8139n/a "type": "string"
91372 },
101265 "matching_algorithm": {
111n/a "allOf": [
121265 {
131265 "$ref": "#/components/schemas/MatchingAlgorithm"
141265 }
151n/a ],
161271 "maximum": 9223372036854775807,
171271 "minimum": 0
181265 },
192828 "name": {
202891 "maxLength": 128,
212837 "minLength": 1,
22290n/a "type": "string"
232828 },
2419114 "owner": {
25133n/a "nullable": true,
2619114 "type": "integer"
2719114 },
2800 "set_permissions": {
290n/a "allOf": [
3000 {
3100 "$ref": "#/components/schemas/SetPermissionsRequest"
3200 }
330n/a ],
34 "writeOnly": true
3500 }
36172121 },
372903 "required": [
382903 "name"
392903 ],
40293n/a "type": "object"
41170123}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11265{
21265 "enum": [
371n/a 0,
48n/a 1,
56n/a 2,
67n/a 3,
79n/a 4,
820n/a 5,
95n/a 6
101265 ],
111283 "type": "integer"
121265}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data17 / 31
DocumentTypeRequest
137132{
237132 "properties": {
31295 "is_insensitive": {
41295 "type": "boolean"
51295 },
61282 "match": {
71282 "maxLength": 256,
8130n/a "type": "string"
91282 },
101298 "matching_algorithm": {
111n/a "allOf": [
121298 {
131298 "$ref": "#/components/schemas/MatchingAlgorithm"
141298 }
151n/a ],
161301 "maximum": 9223372036854775807,
171301 "minimum": 0
181298 },
191662 "name": {
201671 "maxLength": 128,
211671 "minLength": 1,
22168n/a "type": "string"
231662 },
2423109 "owner": {
25132n/a "nullable": true,
2623109 "type": "integer"
2723109 },
280128 "set_permissions": {
290n/a "allOf": [
300128 {
310128 "$ref": "#/components/schemas/SetPermissionsRequest"
320128 }
330n/a ],
34 "writeOnly": true
350128 }
3637132 },
371681 "required": [
381681 "name"
391681 ],
40169n/a "type": "object"
4137132}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11298{
21298 "enum": [
395n/a 0,
414n/a 1,
53n/a 2,
63n/a 3,
76n/a 4,
85n/a 5,
93n/a 6
101298 ],
111316 "type": "integer"
121298}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10128{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100128 "type": "object"
110128}
Responses1 of 1 documented received
codedescriptionhitsavg
20021316ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3955ms
404Not Found3634ms
401Unauthorized397ms
415112ms
documents 35 operations 30 covered 5 partial 0 uncovered 0 not measured 84% #
Query Parameters151 of 151 keywords covered
added__date__gt2 / 2
#validinvalidschema
158784{
258784 "format": "date",
3671n/a "type": "string"
458784}
added__date__gte2 / 2
155135{
255135 "format": "date",
3586n/a "type": "string"
455135}
added__date__lt2 / 2
155841{
255841 "format": "date",
3599n/a "type": "string"
455841}
added__date__lte2 / 2
154420{
254420 "format": "date",
3564n/a "type": "string"
454420}
added__day1 / 1
156112{
256112 "type": "number"
356112}
added__gt2 / 2
155422{
255422 "format": "date-time",
3576n/a "type": "string"
455422}
added__gte2 / 2
156815{
256815 "format": "date-time",
3583n/a "type": "string"
456815}
added__lt2 / 2
154614{
254614 "format": "date-time",
3560n/a "type": "string"
454614}
added__lte2 / 2
157116{
257116 "format": "date-time",
3587n/a "type": "string"
457116}
added__month1 / 1
15549{
25549 "type": "number"
35549}
added__year1 / 1
154422{
254422 "type": "number"
354422}
archive_serial_number1 / 1
154613{
254613 "type": "integer"
354613}
archive_serial_number__gt1 / 1
153422{
253422 "type": "integer"
353422}
archive_serial_number__gte1 / 1
154011{
254011 "type": "integer"
354011}
archive_serial_number__isnull1 / 1
155713{
255713 "type": "boolean"
355713}
archive_serial_number__lt1 / 1
153418{
253418 "type": "integer"
353418}
archive_serial_number__lte1 / 1
153210{
253210 "type": "integer"
353210}
checksum__icontains1 / 1
1544n/a{
2544n/a "type": "string"
3544n/a}
checksum__iendswith1 / 1
1547n/a{
2547n/a "type": "string"
3547n/a}
checksum__iexact1 / 1
1541n/a{
2541n/a "type": "string"
3541n/a}
checksum__istartswith1 / 1
1539n/a{
2539n/a "type": "string"
3539n/a}
content__icontains2 / 2
15323{
25323 "minLength": 1,
3535n/a "type": "string"
45323}
content__iendswith2 / 2
15356{
25356 "minLength": 1,
3541n/a "type": "string"
45356}
content__iexact2 / 2
15295{
25295 "minLength": 1,
3534n/a "type": "string"
45295}
content__istartswith2 / 2
15433{
25433 "minLength": 1,
3546n/a "type": "string"
45433}
correspondent__id1 / 1
180611{
280611 "type": "integer"
380611}
correspondent__id__in2 / 2
151526{
251526 "items": {
364232 "type": "integer"
451526 },
5541n/a "type": "array"
651526}
correspondent__id__none1 / 1
152510{
252510 "type": "integer"
352510}
correspondent__isnull1 / 1
152015{
252015 "type": "boolean"
352015}
correspondent__name__icontains1 / 1
1532n/a{
2532n/a "type": "string"
3532n/a}
correspondent__name__iendswith1 / 1
1523n/a{
2523n/a "type": "string"
3523n/a}
correspondent__name__iexact1 / 1
1529n/a{
2529n/a "type": "string"
3529n/a}
correspondent__name__istartswith1 / 1
1531n/a{
2531n/a "type": "string"
3531n/a}
created__date__gt2 / 2
152112{
252112 "format": "date",
3533n/a "type": "string"
452112}
created__date__gte2 / 2
150712{
250712 "format": "date",
3519n/a "type": "string"
450712}
created__date__lt2 / 2
150513{
250513 "format": "date",
3518n/a "type": "string"
450513}
created__date__lte2 / 2
151030{
251030 "format": "date",
3540n/a "type": "string"
451030}
created__day1 / 1
151826{
251826 "type": "number"
351826}
created__gt2 / 2
151716{
251716 "format": "date",
3533n/a "type": "string"
451716}
created__gte2 / 2
151112{
251112 "format": "date",
3523n/a "type": "string"
451112}
created__lt2 / 2
151514{
251514 "format": "date",
3529n/a "type": "string"
451514}
created__lte2 / 2
149512{
249512 "format": "date",
3507n/a "type": "string"
449512}
created__month1 / 1
151710{
251710 "type": "number"
351710}
created__year1 / 1
15148{
25148 "type": "number"
35148}
custom_field_query2 / 2
15193{
25193 "minLength": 1,
3522n/a "type": "string"
45193}
custom_fields__icontains2 / 2
15064{
25064 "minLength": 1,
3510n/a "type": "string"
45064}
custom_fields__id__all1 / 1
151311{
251311 "type": "integer"
351311}
custom_fields__id__in1 / 1
151314{
251314 "type": "integer"
351314}
custom_fields__id__none1 / 1
149815{
249815 "type": "integer"
349815}
document_type__id1 / 1
178311{
278311 "type": "integer"
378311}
document_type__id__in2 / 2
147518{
247518 "items": {
349324 "type": "integer"
447518 },
5493n/a "type": "array"
647518}
document_type__id__none1 / 1
149410{
249410 "type": "integer"
349410}
document_type__isnull1 / 1
148910{
248910 "type": "boolean"
348910}
document_type__name__icontains1 / 1
1513n/a{
2513n/a "type": "string"
3513n/a}
document_type__name__iendswith1 / 1
1509n/a{
2509n/a "type": "string"
3509n/a}
document_type__name__iexact1 / 1
1516n/a{
2516n/a "type": "string"
3516n/a}
document_type__name__istartswith1 / 1
1514n/a{
2514n/a "type": "string"
3514n/a}
fields2 / 2
1517n/a{
2517n/a "items": {
3772n/a "type": "string"
4517n/a },
5517n/a "type": "array"
6517n/a}
full_perms1 / 1
149810{
249810 "type": "boolean"
349810}
has_custom_fields1 / 1
149311{
249311 "type": "boolean"
349311}
has_duplicates1 / 1
148515{
248515 "type": "boolean"
348515}
id1 / 1
150411{
250411 "type": "integer"
350411}
id__in2 / 2
149526{
249526 "items": {
364739 "type": "integer"
449526 },
5521n/a "type": "array"
649526}
is_in_inbox1 / 1
149112{
249112 "type": "boolean"
349112}
is_tagged1 / 1
147510{
247510 "type": "boolean"
347510}
mime_type1 / 1
1484n/a{
2484n/a "type": "string"
3484n/a}
modified__date__gt2 / 2
149212{
249212 "format": "date",
3504n/a "type": "string"
449212}
modified__date__gte2 / 2
148412{
248412 "format": "date",
3496n/a "type": "string"
448412}
modified__date__lt2 / 2
148313{
248313 "format": "date",
3496n/a "type": "string"
448313}
modified__date__lte2 / 2
147514{
247514 "format": "date",
3489n/a "type": "string"
447514}
modified__day1 / 1
14789{
24789 "type": "number"
34789}
modified__gt2 / 2
146512{
246512 "format": "date-time",
3477n/a "type": "string"
446512}
modified__gte2 / 2
148314{
248314 "format": "date-time",
3497n/a "type": "string"
448314}
modified__lt2 / 2
147013{
247013 "format": "date-time",
3483n/a "type": "string"
447013}
modified__lte2 / 2
150212{
250212 "format": "date-time",
3514n/a "type": "string"
450212}
modified__month1 / 1
14729{
24729 "type": "number"
34729}
modified__year1 / 1
14688{
24688 "type": "number"
34688}
ordering1 / 1
1483n/a{
2483n/a "type": "string"
3483n/a}
original_filename__icontains1 / 1
1482n/a{
2482n/a "type": "string"
3482n/a}
original_filename__iendswith1 / 1
1489n/a{
2489n/a "type": "string"
3489n/a}
original_filename__iexact1 / 1
1484n/a{
2484n/a "type": "string"
3484n/a}
original_filename__istartswith1 / 1
1473n/a{
2473n/a "type": "string"
3473n/a}
owner__id1 / 1
147310{
247310 "type": "integer"
347310}
owner__id__in2 / 2
145020{
245020 "items": {
352923 "type": "integer"
445020 },
5470n/a "type": "array"
645020}
owner__id__none1 / 1
148313{
248313 "type": "integer"
348313}
owner__isnull1 / 1
147012{
247012 "type": "boolean"
347012}
page1 / 1
145816{
245816 "type": "integer"
345816}
page_size1 / 1
146411{
246411 "type": "integer"
346411}
query1 / 1
1498n/a{
2498n/a "type": "string"
3498n/a}
search1 / 1
1473n/a{
2473n/a "type": "string"
3473n/a}
shared_by__id1 / 1
146210{
246210 "type": "boolean"
346210}
storage_path__id1 / 1
170719{
270719 "type": "integer"
370719}
storage_path__id__in2 / 2
144619{
244619 "items": {
360238 "type": "integer"
444619 },
5465n/a "type": "array"
644619}
storage_path__id__none1 / 1
147610{
247610 "type": "integer"
347610}
storage_path__isnull1 / 1
149210{
249210 "type": "boolean"
349210}
storage_path__name__icontains1 / 1
1458n/a{
2458n/a "type": "string"
3458n/a}
storage_path__name__iendswith1 / 1
1459n/a{
2459n/a "type": "string"
3459n/a}
storage_path__name__iexact1 / 1
1459n/a{
2459n/a "type": "string"
3459n/a}
storage_path__name__istartswith1 / 1
1457n/a{
2457n/a "type": "string"
3457n/a}
tags__id1 / 1
145011{
245011 "type": "integer"
345011}
tags__id__all1 / 1
144813{
244813 "type": "integer"
344813}
tags__id__in1 / 1
145212{
245212 "type": "integer"
345212}
tags__id__none1 / 1
145210{
245210 "type": "integer"
345210}
tags__name__icontains1 / 1
1455n/a{
2455n/a "type": "string"
3455n/a}
tags__name__iendswith1 / 1
1462n/a{
2462n/a "type": "string"
3462n/a}
tags__name__iexact1 / 1
1444n/a{
2444n/a "type": "string"
3444n/a}
tags__name__istartswith1 / 1
1462n/a{
2462n/a "type": "string"
3462n/a}
text1 / 1
1489n/a{
2489n/a "type": "string"
3489n/a}
title__icontains1 / 1
1442n/a{
2442n/a "type": "string"
3442n/a}
title__iendswith1 / 1
1454n/a{
2454n/a "type": "string"
3454n/a}
title__iexact1 / 1
1431n/a{
2431n/a "type": "string"
3431n/a}
title__istartswith1 / 1
1439n/a{
2439n/a "type": "string"
3439n/a}
title_content2 / 2
14615{
24615 "minLength": 1,
3466n/a "type": "string"
44615}
title_search1 / 1
1449n/a{
2449n/a "type": "string"
3449n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
200104312ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request8808ms
500Internal Server Error8312ms
401Unauthorized576ms
404Not Found1910ms
Body18 of 18 keywords covered
application/json18 / 18
BulkDownloadRequest
#validinvalidschema
1386152{
2316118 "properties": {
333125 "all": {
433125 "type": "boolean",
5 "writeOnly": true
633125 },
731230 "compression": {
81n/a "allOf": [
931230 {
1031230 "$ref": "#/components/schemas/CompressionEnum"
1131230 }
121n/a ],
1331230 },
1428231 "content": {
151n/a "allOf": [
1628231 {
1728231 "$ref": "#/components/schemas/ContentEnum"
1828231 }
191n/a ],
2028231 },
2127221 "documents": {
2227210 "items": {
2333120 "type": "integer"
2427210 },
2528211 "type": "array",
26 "writeOnly": true
2727221 },
2825828 "excluded_documents": {
2925817 "items": {
3035346 "type": "integer"
3125817 },
3227511 "type": "array",
33 "writeOnly": true
3425828 },
352599 "filters": {
36105n/a "additionalProperties": {},
372599 "type": "object",
38 "writeOnly": true
392599 },
4025316 "follow_formatting": {
4125316 "type": "boolean"
4225316 }
43316118 },
4450434 "type": "object"
45386152}
Referenced Components (2)6 of 6 keywords
CompressionEnum3 of 3 keywords
131230{
231230 "enum": [
387n/a "none",
441n/a "deflated",
530n/a "bzip2",
6154n/a "lzma"
731230 ],
831626 "type": "string"
931230}
ContentEnum3 of 3 keywords
128231{
228231 "enum": [
3117n/a "archive",
418n/a "originals",
5147n/a "both"
628231 ],
728726 "type": "string"
828231}
Responses1 of 2 documented received
codedescriptionhitsavg
2001646ms
403No response body0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3773ms
401Unauthorized576ms
41523ms
500Internal Server Error146ms
Examples4 / 4 used
Body: application/json
falseBulkDownloadRequest.all
"none"BulkDownloadRequest.compression
"archive"BulkDownloadRequest.content
falseBulkDownloadRequest.follow_formatting
Body17 of 17 keywords covered
application/json17 / 17
BulkEditRequest
#validinvalidschema
1490102{
249682 "properties": {
335012 "all": {
435012 "type": "boolean",
5 "writeOnly": true
635012 },
731114 "documents": {
83119 "items": {
9178030 "type": "integer"
103119 },
113205 "type": "array",
12 "writeOnly": true
1331114 },
1428124 "excluded_documents": {
1528110 "items": {
1686828 "type": "integer"
1728110 },
1829114 "type": "array",
19 "writeOnly": true
2028124 },
2130618 "filters": {
22208n/a "additionalProperties": {},
2330618 "type": "object",
24 "writeOnly": true
2530618 },
263027 "from_webui": {
273027 "type": "boolean"
283027 },
2954626 "method": {
301n/a "allOf": [
3154626 {
3254626 "$ref": "#/components/schemas/MethodEnum"
3354626 }
341n/a ],
35 "writeOnly": true
3654626 },
373079 "parameters": {
38200n/a "additionalProperties": {},
393079 "type": "object",
40 "writeOnly": true
413079 }
4249682 },
4357214 "required": [
4457214 "method"
4557214 ],
465866 "type": "object"
47490102}
Referenced Components (1)3 of 3 keywords
MethodEnum3 of 3 keywords
154626{
254626 "enum": [
387n/a "set_correspondent",
487n/a "set_document_type",
516n/a "set_storage_path",
621n/a "add_tag",
725n/a "remove_tag",
826n/a "modify_tags",
924n/a "modify_custom_fields",
1017n/a "set_permissions",
117n/a "delete",
1227n/a "reprocess",
1315n/a "rotate",
14105n/a "merge",
1514n/a "edit_pdf",
1627n/a "remove_password",
1731n/a "split",
1817n/a "delete_pages"
1954626 ],
2055220 "type": "string"
2154626}
Responses1 of 1 documented received
codedescriptionhitsavg
2001711ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4303ms
500Internal Server Error479ms
401Unauthorized1284ms
41523ms
Examples3 / 3 used
Body: application/json
falseBulkEditRequest.all
falseBulkEditRequest.from_webui
{}BulkEditRequest.parameters
Body24 of 24 keywords covered
application/json8 / 8
ChatStreamingRequest
#validinvalidschema
11245125{
21253105 "properties": {
363876 "document_id": {
4714n/a "nullable": true,
563876 "type": "integer"
663876 },
7128367 "q": {
8131720 "maxLength": 4000,
9130334 "minLength": 1,
10133713 "type": "string"
11128367 }
121253105 },
13135013 "required": [
14135013 "q"
15135013 ],
1613637 "type": "object"
171245125}
application/x-www-form-urlencoded8 / 8
ChatStreamingRequest
1799407{
2801399 "properties": {
3285347 "document_id": {
4632n/a "nullable": true,
5285347 "type": "integer"
6285347 },
7111971 "q": {
8116426 "maxLength": 4000,
9114545 "minLength": 1,
101190n/a "type": "string"
11111971 }
12801399 },
13119016 "required": [
14119016 "q"
15119016 ],
161206n/a "type": "object"
17799407}
multipart/form-data8 / 8
ChatStreamingRequest
1506237{
2507236 "properties": {
3156223 "document_id": {
4379n/a "nullable": true,
5156223 "type": "integer"
6156223 },
771821 "q": {
872811 "maxLength": 4000,
972910 "minLength": 1,
10739n/a "type": "string"
1171821 }
12507236 },
137394 "required": [
147394 "q"
157394 ],
16743n/a "type": "object"
17506237}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request37544ms
401Unauthorized1212ms
Body9 of 9 keywords covered
application/json9 / 9
DeleteDocumentsRequest
#validinvalidschema
144974{
236562 "properties": {
332827 "all": {
432827 "type": "boolean",
5 "writeOnly": true
632827 },
727022 "documents": {
82707 "items": {
962410 "type": "integer"
102707 },
1127715 "type": "array",
12 "writeOnly": true
1327022 },
1418428 "excluded_documents": {
1518422 "items": {
1665353 "type": "integer"
1718422 },
182066 "type": "array",
19 "writeOnly": true
2018428 },
2131312 "filters": {
22256n/a "additionalProperties": {},
2331312 "type": "object",
24 "writeOnly": true
2531312 }
2636562 },
2751112 "type": "object"
2844974}
Responses1 of 1 documented received
codedescriptionhitsavg
20017917ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3404ms
401Unauthorized397ms
41522ms
500Internal Server Error175ms
Examples1 / 1 used
Body: application/json
falseDeleteDocumentsRequest.all
Body21 of 21 keywords covered
application/json21 / 21
EditPdfDocumentsRequest
#validinvalidschema
1244155{
2259132 "properties": {
318422 "delete_original": {
418422 "type": "boolean"
518422 },
635720 "documents": {
73576 "items": {
813396 "type": "integer"
93576 },
1036314 "type": "array",
11 "writeOnly": true
1235720 },
131735 "from_webui": {
141735 "type": "boolean"
151735 },
161759 "include_metadata": {
171759 "type": "boolean"
181759 },
1930585 "operations": {
2030579 "items": {
21993136 "$ref": "#/components/schemas/PdfEditOperationRequest"
2230579 },
233846 "type": "array"
2430585 },
251797 "source_mode": {
261792 "minLength": 1,
271815 "type": "string"
281797 },
291617 "update_document": {
301617 "type": "boolean"
311617 }
32259132 },
3337618 "required": [
3437717 "documents",
353904 "operations"
3637618 ],
373945 "type": "object"
38244155}
Referenced Components (1)10 of 10 keywords
PdfEditOperationRequest10 of 10 keywords
1993136{
2997116 "properties": {
350210 "doc": {
45034 "minimum": 0,
55066 "type": "integer"
650210 },
7106445 "page": {
8106440 "minimum": 1,
911036 "type": "integer"
10106445 },
1147461 "rotate": {
1247461 "type": "integer"
1347461 }
14997116 },
15110915 "required": [
16110915 "page"
17110915 ],
1811245 "type": "object"
19993136}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5053ms
500Internal Server Error696ms
41523ms
401Unauthorized435ms
Examples5 / 5 used
Body: application/json
falseEditPdfDocumentsRequest.delete_original
falseEditPdfDocumentsRequest.from_webui
trueEditPdfDocumentsRequest.include_metadata
"latest_version"EditPdfDocumentsRequest.source_mode
falseEditPdfDocumentsRequest.update_document
Body34 of 36 keywords covered
application/json12 / 12
EmailRequest
#validinvalidschema
180114{
210183 "properties": {
314821 "addresses": {
41486 "minLength": 1,
515415 "type": "string"
614821 },
715124 "documents": {
815113 "items": {
915914 "type": "integer"
1015113 },
1116411 "type": "array",
12 "writeOnly": true
1315124 },
1416015 "message": {
151604 "minLength": 1,
1616411 "type": "string"
1716015 },
1815520 "subject": {
191554 "minLength": 1,
2015916 "type": "string"
2115520 },
2210312 "use_archive_version": {
2310312 "type": "boolean"
2410312 }
2510183 },
2616321 "required": [
2716915 "addresses",
281759 "documents",
291759 "message",
301759 "subject"
3116321 ],
3218410 "type": "object"
3380114}
application/x-www-form-urlencoded11 / 12
EmailRequest
140102{
29349 "properties": {
31336 "addresses": {
41336 "minLength": 1,
5139n/a "type": "string"
61336 },
74630 "documents": {
84630 "items": {
923537 "type": "integer"
104630 },
11760 "type": "array",
12 "writeOnly": true
134630 },
141355 "message": {
151355 "minLength": 1,
16140n/a "type": "string"
171355 },
181346 "subject": {
191346 "minLength": 1,
20140n/a "type": "string"
211346 },
22874 "use_archive_version": {
23874 "type": "boolean"
24874 }
259349 },
267567 "required": [
271393 "addresses",
287666 "documents",
291402 "message",
301402 "subject"
317567 ],
32142n/a "type": "object"
3340102}
multipart/form-data11 / 12
EmailRequest
11686{
24458 "properties": {
38812 "addresses": {
48812 "minLength": 1,
5100n/a "type": "string"
68812 },
71829 "documents": {
81829 "items": {
97229 "type": "integer"
101829 },
11470 "type": "array",
12 "writeOnly": true
131829 },
14937 "message": {
15937 "minLength": 1,
16100n/a "type": "string"
17937 },
18937 "subject": {
19937 "minLength": 1,
20100n/a "type": "string"
21937 },
226811 "use_archive_version": {
236811 "type": "boolean"
246811 }
254458 },
264755 "required": [
271002 "addresses",
284755 "documents",
291002 "message",
301002 "subject"
314755 ],
32102n/a "type": "object"
331686}
Responses2 of 5 documented received
codedescriptionhitsavg
2000never seen
400No response body6693ms
403No response body0never seen
404No response body0never seen
500No response body325ms
Undocumented - not in spec
codedescriptionhitsavg
41523ms
401Unauthorized382ms
Examples3 / 3 used
Body: application/json
trueEmailRequest.use_archive_version
Body: application/x-www-form-urlencoded
trueEmailRequest.use_archive_version
Body: multipart/form-data
trueEmailRequest.use_archive_version
Body12 of 12 keywords covered
application/json12 / 12
MergeDocumentsRequest
#validinvalidschema
150751{
250842 "properties": {
33186 "archive_fallback": {
43186 "type": "boolean"
53186 },
62835 "delete_originals": {
72835 "type": "boolean"
82835 },
953811 "documents": {
105386 "items": {
1131006 "type": "integer"
125386 },
135445 "type": "array",
14 "writeOnly": true
1553811 },
1627110 "from_webui": {
1727110 "type": "boolean"
1827110 },
194705 "metadata_document_id": {
20475n/a "nullable": true,
214705 "type": "integer"
224705 },
231796 "source_mode": {
241791 "minLength": 1,
251805 "type": "string"
261796 }
2750842 },
285494 "required": [
295494 "documents"
305494 ],
315535 "type": "object"
3250751}
Responses1 of 1 documented received
codedescriptionhitsavg
200904ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2923ms
401Unauthorized1683ms
41522ms
500Internal Server Error335ms
Examples4 / 4 used
Body: application/json
falseMergeDocumentsRequest.archive_fallback
falseMergeDocumentsRequest.delete_originals
falseMergeDocumentsRequest.from_webui
"latest_version"MergeDocumentsRequest.source_mode
Body9 of 9 keywords covered
application/json9 / 9
MergeDocumentsAsVersionsRequest
#validinvalidschema
134896{
238152 "properties": {
337435 "documents": {
437421 "items": {
5529136 "type": "integer"
637421 },
739514 "type": "array",
8 "writeOnly": true
937435 },
1040321 "root_document_id": {
1140321 "type": "integer"
1240321 },
1313821 "version_label": {
14769 "maxLength": 64,
15159n/a "nullable": true,
1614712 "type": "string"
1713821 }
1838152 },
1940039 "required": [
2040930 "documents",
2142415 "root_document_id"
2240039 ],
234395 "type": "object"
2434896}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5093ms
41522ms
500Internal Server Error125ms
401Unauthorized332ms
Responses1 of 1 documented received
codedescriptionhitsavg
2001894ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3522ms
Body22 of 23 keywords covered
multipart/form-data22 / 23
PostDocumentRequest
#validinvalidschema
1257320{
2260303 "properties": {
324725 "archive_serial_number": {
425814 "format": "int64",
52535 "maximum": 4294967295,
62526 "minimum": 0,
725814 "type": "integer",
8 "writeOnly": true
924725 },
1052203 "correspondent": {
11255n/a "nullable": true,
1252203 "type": "integer",
13 "writeOnly": true
1452203 },
1518854 "created": {
1618854 "format": "date-time",
17242n/a "nullable": true,
18242n/a "type": "string",
19 "writeOnly": true
2018854 },
21144n/a "custom_fields": {
22 "writeOnly": true
23144n/a },
24554n/a "document": {
25554n/a "format": "binary",
26554n/a "type": "string",
27 "writeOnly": true
28554n/a },
2932203 "document_type": {
30235n/a "nullable": true,
3132203 "type": "integer",
32 "writeOnly": true
3332203 },
3420059 "from_webui": {
3520059 "type": "boolean",
36 "writeOnly": true
3720059 },
3839191 "storage_path": {
39230n/a "nullable": true,
4039191 "type": "integer",
41 "writeOnly": true
4239191 },
435080 "tags": {
445080 "items": {
45247140 "type": "integer",
46 "writeOnly": true
475080 },
481300 "type": "array",
49 "writeOnly": true
505080 },
5120911 "title": {
5220911 "minLength": 1,
53220n/a "type": "string",
54 "writeOnly": true
5520911 }
56260303 },
5755423 "required": [
5855423 "document"
5955423 ],
60577n/a "type": "object"
61257320}
Responses1 of 1 documented received
codedescriptionhitsavg
20023022ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4095ms
401Unauthorized309ms
41523ms
Body13 of 13 keywords covered
application/json13 / 13
RemovePasswordDocumentsRequest
#validinvalidschema
147188{
247970 "properties": {
33157 "delete_original": {
43157 "type": "boolean"
53157 },
653012 "documents": {
75307 "items": {
819198 "type": "integer"
95307 },
105375 "type": "array",
11 "writeOnly": true
1253012 },
132239 "from_webui": {
142239 "type": "boolean"
152239 },
162385 "include_metadata": {
172385 "type": "boolean"
182385 },
1952424 "password": {
2052417 "minLength": 1,
215417 "type": "string"
2252424 },
2319610 "source_mode": {
241964 "minLength": 1,
252006 "type": "string"
2619610 },
271739 "update_document": {
281739 "type": "boolean"
291739 }
3047970 },
315418 "required": [
325427 "documents",
335481 "password"
345418 ],
3554910 "type": "object"
3647188}
Responses1 of 1 documented received
codedescriptionhitsavg
2001513ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2914ms
401Unauthorized1174ms
41523ms
500Internal Server Error305ms
Examples5 / 5 used
Body: application/json
falseRemovePasswordDocumentsRequest.delete_original
falseRemovePasswordDocumentsRequest.from_webui
trueRemovePasswordDocumentsRequest.include_metadata
"latest_version"RemovePasswordDocumentsRequest.source_mode
falseRemovePasswordDocumentsRequest.update_document
Body10 of 10 keywords covered
application/json10 / 10
ReprocessDocumentsRequest
#validinvalidschema
145778{
238160 "properties": {
335111 "all": {
435111 "type": "boolean",
5 "writeOnly": true
635111 },
733823 "documents": {
83388 "items": {
9128511 "type": "integer"
103388 },
1134615 "type": "array",
12 "writeOnly": true
1333823 },
1430719 "excluded_documents": {
1530711 "items": {
1651680 "type": "integer"
1730711 },
183188 "type": "array",
19 "writeOnly": true
2030719 },
2130413 "filters": {
22205n/a "additionalProperties": {},
2330413 "type": "object",
24 "writeOnly": true
2530413 },
2630312 "remote_ocr": {
2730312 "type": "boolean"
2830312 }
2938160 },
3051718 "type": "object"
3145778}
Responses1 of 1 documented received
codedescriptionhitsavg
2001064ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3523ms
401Unauthorized417ms
41522ms
500Internal Server Error866ms
Examples2 / 2 used
Body: application/json
falseReprocessDocumentsRequest.all
falseReprocessDocumentsRequest.remote_ocr
Body14 of 14 keywords covered
application/json14 / 14
RotateDocumentsRequest
#validinvalidschema
1476109{
249278 "properties": {
32339 "all": {
42339 "type": "boolean",
5 "writeOnly": true
62339 },
753717 "degrees": {
853717 "type": "integer"
953717 },
1021823 "documents": {
1121813 "items": {
1269033 "type": "integer"
1321813 },
1423110 "type": "array",
15 "writeOnly": true
1621823 },
1718916 "excluded_documents": {
181897 "items": {
196887 "type": "integer"
201897 },
211969 "type": "array",
22 "writeOnly": true
2318916 },
242087 "filters": {
25114n/a "additionalProperties": {},
262087 "type": "object",
27 "writeOnly": true
282087 },
2918410 "from_webui": {
3018410 "type": "boolean"
3118410 },
3217212 "source_mode": {
331725 "minLength": 1,
341777 "type": "string"
3517212 }
3649278 },
3755422 "required": [
3855422 "degrees"
3955422 ],
405769 "type": "object"
41476109}
Responses1 of 1 documented received
codedescriptionhitsavg
200384ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4993ms
401Unauthorized436ms
41522ms
500Internal Server Error265ms
Examples3 / 3 used
Body: application/json
falseRotateDocumentsRequest.all
falseRotateDocumentsRequest.from_webui
"latest_version"RotateDocumentsRequest.source_mode
Body16 of 18 keywords covered
application/json9 / 9
DocumentSelectionRequest
#validinvalidschema
114550{
212042 "properties": {
31119 "all": {
41119 "type": "boolean",
5 "writeOnly": true
61119 },
710816 "documents": {
810810 "items": {
952327 "type": "integer"
1010810 },
111186 "type": "array",
12 "writeOnly": true
1310816 },
1411816 "excluded_documents": {
151187 "items": {
165027 "type": "integer"
171187 },
181259 "type": "array",
19 "writeOnly": true
2011816 },
211317 "filters": {
2290n/a "additionalProperties": {},
231317 "type": "object",
24 "writeOnly": true
251317 }
2612042 },
271878 "type": "object"
2814550}
multipart/form-data7 / 9
DocumentSelectionRequest
118282{
211082 "properties": {
31639 "all": {
41639 "type": "boolean",
5 "writeOnly": true
61639 },
75651 "documents": {
85651 "items": {
9313173 "type": "integer"
105651 },
111070 "type": "array",
12 "writeOnly": true
135651 },
144553 "excluded_documents": {
154553 "items": {
1647673 "type": "integer"
174553 },
18980 "type": "array",
19 "writeOnly": true
204553 },
211135 "filters": {
2265n/a "additionalProperties": {},
231135 "type": "object",
24 "writeOnly": true
251135 }
2611082 },
27264n/a "type": "object"
2818282}
Responses1 of 1 documented received
codedescriptionhitsavg
2005621ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4453ms
401Unauthorized1174ms
41512ms
500Internal Server Error57ms
Examples2 / 2 used
Body: application/json
falseDocumentSelectionRequest.all
Body: multipart/form-data
falseDocumentSelectionRequest.all
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
153890{
253890 "type": "integer"
353890}
Responses0 of 1 documented received
codedescriptionhitsavg
204No response body0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5739ms
401Unauthorized552ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
155639{
255639 "type": "integer"
355639}
Query Parameters3 of 3 keywords covered
fields2 / 2
1123n/a{
2123n/a "items": {
3479n/a "type": "string"
4123n/a },
5123n/a "type": "array"
6123n/a}
full_perms1 / 1
111148{
211148 "type": "boolean"
311148}
Responses0 of 2 documented received
codedescriptionhitsavg
2000never seen
400No response body0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found56810ms
401Unauthorized272ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1108025{
2108025 "type": "integer"
3108025}
Body104 of 162 keywords covered
application/json54 / 54
PatchedDocumentRequest
1237173{
2121168 "properties": {
321914 "archive_serial_number": {
422112 "format": "int64",
52211 "maximum": 4294967295,
62211 "minimum": 0,
7233n/a "nullable": true,
82285 "type": "integer"
921914 },
102365 "content": {
112365 "type": "string"
122365 },
132215 "correspondent": {
14226n/a "nullable": true,
152215 "type": "integer"
162215 },
172216 "created": {
182211 "format": "date",
192225 "type": "string"
202216 },
212206 "created_date": {
222201 "format": "date",
232215 "type": "string"
242206 },
2518736 "custom_fields": {
2618731 "items": {
276942 "$ref": "#/components/schemas/CustomFieldInstanceRequest"
2818731 },
292185 "type": "array"
3018736 },
312245 "document_type": {
32229n/a "nullable": true,
332245 "type": "integer"
342245 },
352295 "owner": {
36234n/a "nullable": true,
372295 "type": "integer"
382295 },
392124 "remove_inbox_tags": {
40216n/a "nullable": true,
412124 "type": "boolean",
42 "writeOnly": true
432124 },
4417662 "set_permissions": {
451n/a "allOf": [
4617662 {
4717662 "$ref": "#/components/schemas/SetPermissionsRequest"
4817662 }
491n/a ],
50 "writeOnly": true
5117662 },
522105 "storage_path": {
53215n/a "nullable": true,
542105 "type": "integer"
552105 },
5620311 "tags": {
572036 "items": {
581046 "type": "integer"
592036 },
602095 "type": "array"
6120311 },
622097 "title": {
632092 "maxLength": 128,
642115 "type": "string"
652097 }
66121168 },
674055 "type": "object"
68237173}
Referenced Components (3)29 of 29 keywords
CustomFieldInstanceRequest15 of 15 keywords
16942{
27036 "properties": {
3986 "field": {
4986 "type": "integer"
5986 },
66936 "value": {
7105n/a "nullable": true,
86936 "oneOf": [
92778 {
102778 "type": "string"
112778 },
121104 {
131104 "type": "integer"
141104 },
151590 {
161590 "format": "double",
171590 "type": "number"
181590 },
192877 {
2026n/a "additionalProperties": {},
212877 "type": "object"
222877 }
236936 ]
246936 }
257036 },
261033 "required": [
271042 "field",
281051 "value"
291033 ],
301065 "type": "object"
316942}
PermissionSetRequest9 of 9 keywords
137060{
234550 "properties": {
336626 "groups": {
434718 "items": {
58859 "type": "integer"
634718 },
7392n/a "nullable": true,
83848 "type": "array"
936626 },
1036524 "users": {
1135714 "items": {
1215016 "type": "integer"
1335714 },
14389n/a "nullable": true,
1537910 "type": "array"
1636524 }
1734550 },
1842010 "type": "object"
1937060}
SetPermissionsRequest5 of 5 keywords
117662{
216357 "properties": {
318130 "change": {
418130 "$ref": "#/components/schemas/PermissionSetRequest"
518130 },
618930 "view": {
718930 "$ref": "#/components/schemas/PermissionSetRequest"
818930 }
916357 },
102335 "type": "object"
1117662}
application/x-www-form-urlencoded25 / 54
PatchedDocumentRequest
140175{
223175 "properties": {
312616 "archive_serial_number": {
412814 "format": "int64",
51271 "maximum": 4294967295,
61271 "minimum": 0,
7142n/a "nullable": true,
812814 "type": "integer"
912616 },
10139n/a "content": {
11139n/a "type": "string"
12139n/a },
1312137 "correspondent": {
14149n/a "nullable": true,
1512137 "type": "integer"
1612137 },
171272 "created": {
181272 "format": "date",
19129n/a "type": "string"
201272 },
211384 "created_date": {
221384 "format": "date",
23142n/a "type": "string"
241384 },
25037 "custom_fields": {
26037 "items": {
270236 "$ref": "#/components/schemas/CustomFieldInstanceRequest"
28037 },
29370 "type": "array"
30037 },
3114131 "document_type": {
32145n/a "nullable": true,
3314131 "type": "integer"
3414131 },
3531122 "owner": {
36153n/a "nullable": true,
3731122 "type": "integer"
3831122 },
3915120 "remove_inbox_tags": {
40135n/a "nullable": true,
4115120 "type": "boolean",
42 "writeOnly": true
4315120 },
4400 "set_permissions": {
450n/a "allOf": [
4600 {
4700 "$ref": "#/components/schemas/SetPermissionsRequest"
4800 }
490n/a ],
50 "writeOnly": true
5100 },
5212119 "storage_path": {
53131n/a "nullable": true,
5412119 "type": "integer"
5512119 },
56207 "tags": {
57207 "items": {
58987 "type": "integer"
59207 },
60270 "type": "array"
61207 },
621366 "title": {
631366 "maxLength": 128,
64142n/a "type": "string"
651366 }
6623175 },
67215n/a "type": "object"
6840175}
Referenced Components (3)0 of 29 keywords
CustomFieldInstanceRequest0 of 15 keywords
10236{
200 "properties": {
300 "field": {
400 "type": "integer"
500 },
600 "value": {
70n/a "nullable": true,
800 "oneOf": [
900 {
1000 "type": "string"
1100 },
1200 {
1300 "type": "integer"
1400 },
1500 {
1600 "format": "double",
1700 "type": "number"
1800 },
1900 {
200n/a "additionalProperties": {},
2100 "type": "object"
2200 }
2300 ]
2400 }
2500 },
2600 "required": [
2700 "field",
2800 "value"
2900 ],
300236 "type": "object"
310236}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data25 / 54
PatchedDocumentRequest
122210{
211210 "properties": {
317910 "archive_serial_number": {
41818 "format": "int64",
51801 "maximum": 4294967295,
61801 "minimum": 0,
7189n/a "nullable": true,
81818 "type": "integer"
917910 },
10202n/a "content": {
11202n/a "type": "string"
12202n/a },
135188 "correspondent": {
14193n/a "nullable": true,
155188 "type": "integer"
165188 },
171881 "created": {
181881 "format": "date",
19189n/a "type": "string"
201881 },
211901 "created_date": {
221901 "format": "date",
23191n/a "type": "string"
241901 },
25037 "custom_fields": {
26037 "items": {
27060 "$ref": "#/components/schemas/CustomFieldInstanceRequest"
28037 },
29370 "type": "array"
30037 },
3113167 "document_type": {
32180n/a "nullable": true,
3313167 "type": "integer"
3413167 },
3510171 "owner": {
36181n/a "nullable": true,
3710171 "type": "integer"
3810171 },
3915168 "remove_inbox_tags": {
40183n/a "nullable": true,
4115168 "type": "boolean",
42 "writeOnly": true
4315168 },
440187 "set_permissions": {
450n/a "allOf": [
460187 {
470187 "$ref": "#/components/schemas/SetPermissionsRequest"
480187 }
490n/a ],
50 "writeOnly": true
510187 },
5210170 "storage_path": {
53180n/a "nullable": true,
5410170 "type": "integer"
5510170 },
561614 "tags": {
571614 "items": {
5813215 "type": "integer"
591614 },
60300 "type": "array"
611614 },
621782 "title": {
631782 "maxLength": 128,
64180n/a "type": "string"
651782 }
6611210 },
67232n/a "type": "object"
6822210}
Referenced Components (3)0 of 29 keywords
CustomFieldInstanceRequest0 of 15 keywords
1060{
200 "properties": {
300 "field": {
400 "type": "integer"
500 },
600 "value": {
70n/a "nullable": true,
800 "oneOf": [
900 {
1000 "type": "string"
1100 },
1200 {
1300 "type": "integer"
1400 },
1500 {
1600 "format": "double",
1700 "type": "number"
1800 },
1900 {
200n/a "additionalProperties": {},
2100 "type": "object"
2200 }
2300 ]
2400 }
2500 },
2600 "required": [
2700 "field",
2800 "value"
2900 ],
30060 "type": "object"
31060}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10187{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100187 "type": "object"
110187}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found108310ms
401Unauthorized222ms
Examples3 / 3 used
Body: application/json
falsePatchedDocumentRequest.remove_inbox_tags
Body: application/x-www-form-urlencoded
falsePatchedDocumentRequest.remove_inbox_tags
Body: multipart/form-data
falsePatchedDocumentRequest.remove_inbox_tags
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1100430{
2100430 "type": "integer"
3100430}
Body107 of 165 keywords covered
application/json55 / 55
DocumentRequest
1257199{
2263187 "properties": {
322630 "archive_serial_number": {
422828 "format": "int64",
52281 "maximum": 4294967295,
62281 "minimum": 0,
7256n/a "nullable": true,
82515 "type": "integer"
922630 },
102385 "content": {
112385 "type": "string"
122385 },
134425 "correspondent": {
14447n/a "nullable": true,
154425 "type": "integer"
164425 },
172516 "created": {
182511 "format": "date",
192525 "type": "string"
202516 },
212506 "created_date": {
222501 "format": "date",
232515 "type": "string"
242506 },
2519844 "custom_fields": {
2619839 "items": {
276648 "$ref": "#/components/schemas/CustomFieldInstanceRequest"
2819839 },
292375 "type": "array"
3019844 },
314445 "document_type": {
32449n/a "nullable": true,
334445 "type": "integer"
344445 },
352345 "owner": {
36239n/a "nullable": true,
372345 "type": "integer"
382345 },
392434 "remove_inbox_tags": {
40247n/a "nullable": true,
412434 "type": "boolean",
42 "writeOnly": true
432434 },
4416959 "set_permissions": {
451n/a "allOf": [
4616959 {
4716959 "$ref": "#/components/schemas/SetPermissionsRequest"
4816959 }
491n/a ],
50 "writeOnly": true
5116959 },
524427 "storage_path": {
53449n/a "nullable": true,
544427 "type": "integer"
554427 },
5643613 "tags": {
574368 "items": {
5859626 "type": "integer"
594368 },
604445 "type": "array"
6143613 },
622427 "title": {
632422 "maxLength": 128,
642445 "type": "string"
652427 }
66263187 },
674446 "required": [
684473 "correspondent",
694491 "document_type",
704491 "storage_path",
714491 "tags"
724446 ],
734506 "type": "object"
74257199}
Referenced Components (3)29 of 29 keywords
CustomFieldInstanceRequest15 of 15 keywords
16648{
26742 "properties": {
31026 "field": {
41026 "type": "integer"
51026 },
66642 "value": {
7108n/a "nullable": true,
86642 "oneOf": [
92187 {
102187 "type": "string"
112187 },
121107 {
131107 "type": "integer"
141107 },
151791 {
161791 "format": "double",
171791 "type": "number"
181791 },
192979 {
2022n/a "additionalProperties": {},
212979 "type": "object"
222979 }
236642 ]
246642 }
256742 },
261072 "required": [
271081 "field",
281081 "value"
291072 ],
301095 "type": "object"
316648}
PermissionSetRequest9 of 9 keywords
134354{
233544 "properties": {
335322 "groups": {
434514 "items": {
5816 "type": "integer"
634514 },
7375n/a "nullable": true,
83678 "type": "array"
935322 },
1035422 "users": {
1134514 "items": {
122316 "type": "integer"
1334514 },
14376n/a "nullable": true,
153688 "type": "array"
1635422 }
1733544 },
1838710 "type": "object"
1934354}
SetPermissionsRequest5 of 5 keywords
116959{
214954 "properties": {
317027 "change": {
417027 "$ref": "#/components/schemas/PermissionSetRequest"
517027 },
617327 "view": {
717327 "$ref": "#/components/schemas/PermissionSetRequest"
817327 }
914954 },
102235 "type": "object"
1116959}
application/x-www-form-urlencoded26 / 55
DocumentRequest
13194{
23194 "properties": {
312512 "archive_serial_number": {
412710 "format": "int64",
51261 "maximum": 4294967295,
61261 "minimum": 0,
7137n/a "nullable": true,
812710 "type": "integer"
912512 },
10145n/a "content": {
11145n/a "type": "string"
12145n/a },
1332163 "correspondent": {
14195n/a "nullable": true,
1532163 "type": "integer"
1632163 },
171361 "created": {
181361 "format": "date",
19137n/a "type": "string"
201361 },
211361 "created_date": {
221361 "format": "date",
23137n/a "type": "string"
241361 },
25025 "custom_fields": {
26025 "items": {
270132 "$ref": "#/components/schemas/CustomFieldInstanceRequest"
28025 },
29250 "type": "array"
30025 },
3141155 "document_type": {
32196n/a "nullable": true,
3341155 "type": "integer"
3441155 },
357135 "owner": {
36142n/a "nullable": true,
377135 "type": "integer"
387135 },
3920117 "remove_inbox_tags": {
40137n/a "nullable": true,
4120117 "type": "boolean",
42 "writeOnly": true
4320117 },
4400 "set_permissions": {
450n/a "allOf": [
4600 {
4700 "$ref": "#/components/schemas/SetPermissionsRequest"
4800 }
490n/a ],
50 "writeOnly": true
5100 },
5242154 "storage_path": {
53196n/a "nullable": true,
5442154 "type": "integer"
5542154 },
563724 "tags": {
573724 "items": {
5827024 "type": "integer"
593724 },
60610 "type": "array"
613724 },
621301 "title": {
631301 "maxLength": 128,
64131n/a "type": "string"
651301 }
663194 },
6760137 "required": [
681952 "correspondent",
691961 "document_type",
701961 "storage_path",
7161136 "tags"
7260137 ],
73197n/a "type": "object"
743194}
Referenced Components (3)0 of 29 keywords
CustomFieldInstanceRequest0 of 15 keywords
10132{
200 "properties": {
300 "field": {
400 "type": "integer"
500 },
600 "value": {
70n/a "nullable": true,
800 "oneOf": [
900 {
1000 "type": "string"
1100 },
1200 {
1300 "type": "integer"
1400 },
1500 {
1600 "format": "double",
1700 "type": "number"
1800 },
1900 {
200n/a "additionalProperties": {},
2100 "type": "object"
2200 }
2300 ]
2400 }
2500 },
2600 "required": [
2700 "field",
2800 "value"
2900 ],
300132 "type": "object"
310132}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data26 / 55
DocumentRequest
10243{
21242 "properties": {
316922 "archive_serial_number": {
417120 "format": "int64",
51701 "maximum": 4294967295,
61701 "minimum": 0,
7191n/a "nullable": true,
817120 "type": "integer"
916922 },
10203n/a "content": {
11203n/a "type": "string"
12203n/a },
1329205 "correspondent": {
14234n/a "nullable": true,
1529205 "type": "integer"
1629205 },
171991 "created": {
181991 "format": "date",
19200n/a "type": "string"
201991 },
211891 "created_date": {
221891 "format": "date",
23190n/a "type": "string"
241891 },
25052 "custom_fields": {
26052 "items": {
270128 "$ref": "#/components/schemas/CustomFieldInstanceRequest"
28052 },
29520 "type": "array"
30052 },
3139203 "document_type": {
32242n/a "nullable": true,
3339203 "type": "integer"
3439203 },
3514168 "owner": {
36182n/a "nullable": true,
3714168 "type": "integer"
3814168 },
3934152 "remove_inbox_tags": {
40186n/a "nullable": true,
4134152 "type": "boolean",
42 "writeOnly": true
4334152 },
440181 "set_permissions": {
450n/a "allOf": [
460181 {
470181 "$ref": "#/components/schemas/SetPermissionsRequest"
480181 }
490n/a ],
50 "writeOnly": true
510181 },
5238204 "storage_path": {
53242n/a "nullable": true,
5438204 "type": "integer"
5538204 },
565123 "tags": {
575123 "items": {
5829324 "type": "integer"
595123 },
60740 "type": "array"
615123 },
621771 "title": {
631771 "maxLength": 128,
64178n/a "type": "string"
651771 }
661242 },
6771172 "required": [
682349 "correspondent",
692421 "document_type",
702421 "storage_path",
7174169 "tags"
7271172 ],
73243n/a "type": "object"
740243}
Referenced Components (3)0 of 29 keywords
CustomFieldInstanceRequest0 of 15 keywords
10128{
200 "properties": {
300 "field": {
400 "type": "integer"
500 },
600 "value": {
70n/a "nullable": true,
800 "oneOf": [
900 {
1000 "type": "string"
1100 },
1200 {
1300 "type": "integer"
1400 },
1500 {
1600 "format": "double",
1700 "type": "number"
1800 },
1900 {
200n/a "additionalProperties": {},
2100 "type": "object"
2200 }
2300 ]
2400 }
2500 },
2600 "required": [
2700 "field",
2800 "value"
2900 ],
300128 "type": "object"
310128}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10181{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100181 "type": "object"
110181}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found101710ms
401Unauthorized162ms
403Forbidden12ms
Examples3 / 3 used
Body: application/json
falseDocumentRequest.remove_inbox_tags
Body: application/x-www-form-urlencoded
falseDocumentRequest.remove_inbox_tags
Body: multipart/form-data
falseDocumentRequest.remove_inbox_tags
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
148491{
248491 "type": "integer"
348491}
Responses2 of 4 documented received
codedescriptionhitsavg
20014ms
400No response body0never seen
403No response body0never seen
404No response body4444ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error906ms
401Unauthorized412ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
156150{
256150 "type": "integer"
356150}
Query Parameters2 of 2 keywords covered
follow_formatting1 / 1
115046{
215046 "type": "boolean"
315046}
original1 / 1
111151{
211151 "type": "boolean"
311151}
Responses1 of 1 documented received
codedescriptionhitsavg
20014ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5355ms
500Internal Server Error496ms
401Unauthorized272ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
160136{
260136 "type": "integer"
360136}
Body30 of 30 keywords covered
application/json10 / 10
EmailDocumentRequestRequest
112550{
213335 "properties": {
314913 "addresses": {
41498 "minLength": 1,
51575 "type": "string"
614913 },
71589 "message": {
81584 "minLength": 1,
91625 "type": "string"
101589 },
111598 "subject": {
121593 "minLength": 1,
131625 "type": "string"
141598 },
15785 "use_archive_version": {
16785 "type": "boolean"
17785 }
1813335 },
191608 "required": [
201626 "addresses",
211671 "message",
221671 "subject"
231608 ],
241687 "type": "object"
2512550}
application/x-www-form-urlencoded10 / 10
EmailDocumentRequestRequest
18242{
29034 "properties": {
310711 "addresses": {
410711 "minLength": 1,
5118n/a "type": "string"
610711 },
710518 "message": {
810518 "minLength": 1,
9123n/a "type": "string"
1010518 },
1111211 "subject": {
1211211 "minLength": 1,
13123n/a "type": "string"
1411211 },
15592 "use_archive_version": {
16592 "type": "boolean"
17592 }
189034 },
191168 "required": [
201186 "addresses",
211231 "message",
221231 "subject"
231168 ],
24124n/a "type": "object"
258242}
multipart/form-data10 / 10
EmailDocumentRequestRequest
16715{
27012 "properties": {
3801 "addresses": {
4801 "minLength": 1,
581n/a "type": "string"
6801 },
7792 "message": {
8792 "minLength": 1,
981n/a "type": "string"
10792 },
11792 "subject": {
12792 "minLength": 1,
1381n/a "type": "string"
14792 },
15547 "use_archive_version": {
16547 "type": "boolean"
17547 }
187012 },
19793 "required": [
20811 "addresses",
21811 "message",
22811 "subject"
23793 ],
2482n/a "type": "object"
256715}
Responses3 of 5 documented received
codedescriptionhitsavg
2000never seen
400No response body4404ms
403No response body111ms
404No response body0never seen
500No response body1765ms
Undocumented - not in spec
codedescriptionhitsavg
41513ms
401Unauthorized192ms
Examples3 / 3 used
Body: application/json
trueEmailDocumentRequestRequest.use_archive_version
Body: application/x-www-form-urlencoded
trueEmailDocumentRequestRequest.use_archive_version
Body: multipart/form-data
trueEmailDocumentRequestRequest.use_archive_version
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
155553{
255553 "type": "integer"
355553}
Query Parameters2 of 2 keywords covered
page1 / 1
112790{
212790 "type": "integer"
312790}
page_size1 / 1
111868{
211868 "type": "integer"
311868}
Responses2 of 4 documented received
codedescriptionhitsavg
20014ms
400No response body0never seen
403No response body0never seen
404No response body5284ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error536ms
401Unauthorized272ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1284143{
2284143 "type": "integer"
3284143}
Responses2 of 4 documented received
codedescriptionhitsavg
2001484ms
400No response body0never seen
403No response body0never seen
404No response body2385ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1436ms
401Unauthorized462ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
152147{
252147 "type": "integer"
352147}
Query Parameters1 of 1 keywords covered
id1 / 1
112628{
212628 "type": "integer"
312628}
Responses2 of 4 documented received
codedescriptionhitsavg
2000never seen
400No response body0never seen
403No response body12ms
404No response body5003ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error455ms
401Unauthorized222ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
154973{
254973 "type": "integer"
354973}
Query Parameters1 of 1 keywords covered
id1 / 1
112275{
212275 "type": "integer"
312275}
Responses2 of 4 documented received
codedescriptionhitsavg
20015ms
400No response body0never seen
403No response body0never seen
404No response body5443ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error675ms
401Unauthorized112ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
157730{
257730 "type": "integer"
357730}
Query Parameters1 of 1 keywords covered
id1 / 1
116940{
216940 "type": "integer"
316940}
Body15 of 15 keywords covered
application/json5 / 5
NoteCreateRequestRequest
128523{
228514 "properties": {
328514 "note": {
42859 "minLength": 1,
52945 "type": "string"
628514 }
728514 },
82991 "required": [
92991 "note"
102991 ],
113008 "type": "object"
1228523}
application/x-www-form-urlencoded5 / 5
NoteCreateRequestRequest
117918{
21794 "properties": {
31794 "note": {
41794 "minLength": 1,
5183n/a "type": "string"
61794 }
71794 },
818314 "required": [
918314 "note"
1018314 ],
11197n/a "type": "object"
1217918}
multipart/form-data5 / 5
NoteCreateRequestRequest
1375{
2371 "properties": {
3371 "note": {
4371 "minLength": 1,
538n/a "type": "string"
6371 }
7371 },
8384 "required": [
9384 "note"
10384 ],
1142n/a "type": "object"
12375}
Responses2 of 4 documented received
codedescriptionhitsavg
2000never seen
400No response body0never seen
403No response body12ms
404No response body5784ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error245ms
401Unauthorized42ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
149772{
249772 "type": "integer"
349772}
Responses1 of 1 documented received
codedescriptionhitsavg
20016ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error716ms
404Not Found4465ms
401Unauthorized522ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
152474{
252474 "type": "integer"
352474}
Responses1 of 1 documented received
codedescriptionhitsavg
20015ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error746ms
404Not Found4924ms
401Unauthorized322ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1260n/a{
2260n/a "type": "string"
3260n/a}
Responses2 of 4 documented received
codedescriptionhitsavg
2004264ms
400No response body0never seen
403No response body0never seen
404No response body354ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1342ms
500Internal Server Error915ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
147994{
247994 "type": "integer"
347994}
Responses2 of 4 documented received
codedescriptionhitsavg
20015ms
400No response body0never seen
403No response body0never seen
404No response body4244ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error936ms
401Unauthorized562ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
149182{
249182 "type": "integer"
349182}
Responses1 of 1 documented received
codedescriptionhitsavg
20014ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error826ms
404Not Found4155ms
401Unauthorized762ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
152082{
252082 "type": "integer"
352082}
Body8 of 8 keywords covered
multipart/form-data8 / 8
DocumentVersionRequest
144433{
24523 "properties": {
3447n/a "document": {
4447n/a "format": "binary",
5447n/a "type": "string",
6 "writeOnly": true
7447n/a },
8903 "version_label": {
9903 "maxLength": 64,
1093n/a "nullable": true,
1193n/a "type": "string"
12903 }
134523 },
1444730 "required": [
1544730 "document"
1644730 ],
17477n/a "type": "object"
1844433}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1434ms
500Internal Server Error317ms
403Forbidden12ms
404Not Found3975ms
41513ms
401Unauthorized292ms
Path Parameters2 of 2 keywords covered
id1 / 1
#validinvalidschema
149764{
249764 "type": "integer"
349764}
version_id1 / 1
150160{
250160 "type": "integer"
350160}
Responses0 of 1 documented received
codedescriptionhitsavg
204No response body0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden672ms
404Not Found4434ms
500Internal Server Error186ms
401Unauthorized332ms
Path Parameters2 of 2 keywords covered
id1 / 1
#validinvalidschema
159556{
259556 "type": "integer"
359556}
version_id1 / 1
159061{
259061 "type": "integer"
359061}
Body15 of 15 keywords covered
application/json5 / 5
PatchedDocumentVersionLabelRequest
121632{
221422 "properties": {
321422 "version_label": {
41499 "maxLength": 64,
5236n/a "nullable": true,
622313 "type": "string"
721422 }
821422 },
923810 "type": "object"
1021632}
application/x-www-form-urlencoded5 / 5
PatchedDocumentVersionLabelRequest
12896{
22896 "properties": {
32896 "version_label": {
42896 "maxLength": 64,
5295n/a "nullable": true,
6295n/a "type": "string"
72896 }
82896 },
9295n/a "type": "object"
102896}
multipart/form-data5 / 5
PatchedDocumentVersionLabelRequest
1702{
2682 "properties": {
3682 "version_label": {
4682 "maxLength": 64,
570n/a "nullable": true,
670n/a "type": "string"
7682 }
8682 },
972n/a "type": "object"
10702}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden2772ms
404Not Found2915ms
500Internal Server Error186ms
400Bad Request555ms
41524ms
401Unauthorized82ms
groups 6 operations 3 covered 3 partial 0 uncovered 0 not measured 93% #
Query Parameters7 of 7 keywords covered
name__icontains1 / 1
#validinvalidschema
11872n/a{
21872n/a "type": "string"
31872n/a}
name__iendswith1 / 1
11912n/a{
21912n/a "type": "string"
31912n/a}
name__iexact1 / 1
11873n/a{
21873n/a "type": "string"
31873n/a}
name__istartswith1 / 1
11857n/a{
21857n/a "type": "string"
31857n/a}
ordering1 / 1
11852n/a{
21852n/a "type": "string"
31852n/a}
page1 / 1
11531385{
21531385 "type": "integer"
31531385}
page_size1 / 1
11689169{
21689169 "type": "integer"
31689169}
Responses1 of 1 documented received
codedescriptionhitsavg
20018558ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found17184ms
401Unauthorized1903ms
400Bad Request774ms
Body25 of 27 keywords covered
application/json9 / 9
GroupRequest
#validinvalidschema
11293107{
2130186 "properties": {
3133351 "name": {
413498 "maxLength": 150,
5134116 "minLength": 1,
6135727 "type": "string"
7133351 },
8133844 "permissions": {
9133828 "items": {
10586828 "minLength": 1,
11589626 "type": "string"
12133828 },
13136616 "type": "array"
14133844 }
15130186 },
16137911 "required": [
1713846 "name",
1813828 "permissions"
19137911 ],
20139010 "type": "object"
211293107}
application/x-www-form-urlencoded8 / 9
GroupRequest
1830245{
2100466 "properties": {
3100754 "name": {
4103031 "maxLength": 150,
5103823 "minLength": 1,
61061n/a "type": "string"
7100754 },
886233 "permissions": {
986233 "items": {
104989166 "minLength": 1,
115155n/a "type": "string"
1286233 },
138950 "type": "array"
1486233 }
15100466 },
16886189 "required": [
17106114 "name",
18895180 "permissions"
19886189 ],
201075n/a "type": "object"
21830245}
multipart/form-data8 / 9
GroupRequest
1545199{
267661 "properties": {
369336 "name": {
470920 "maxLength": 150,
571316 "minLength": 1,
6729n/a "type": "string"
769336 },
857730 "permissions": {
957730 "items": {
103559121 "minLength": 1,
113680n/a "type": "string"
1257730 },
136070 "type": "array"
1457730 }
1567661 },
16599145 "required": [
1772915 "name",
18607137 "permissions"
19599145 ],
20744n/a "type": "object"
21545199}
Responses1 of 1 documented received
codedescriptionhitsavg
20135114ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request32314ms
401Unauthorized1673ms
41522ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
12407{
22407 "type": "integer"
32407}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body9714ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1244ms
401Unauthorized2610ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
165116{
265116 "type": "integer"
365116}
Responses1 of 1 documented received
codedescriptionhitsavg
2003384ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2534ms
401Unauthorized765ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
173910{
273910 "type": "integer"
373910}
Body22 of 24 keywords covered
application/json8 / 8
PatchedGroupRequest
131142{
27736 "properties": {
38912 "name": {
4923 "maxLength": 150,
5923 "minLength": 1,
6956 "type": "string"
78912 },
86328 "permissions": {
96312 "items": {
102028 "minLength": 1,
112105 "type": "string"
126312 },
137516 "type": "array"
146328 }
157736 },
163476 "type": "object"
1731142}
application/x-www-form-urlencoded7 / 8
PatchedGroupRequest
110523{
26323 "properties": {
35022 "name": {
46012 "maxLength": 150,
56210 "minLength": 1,
672n/a "type": "string"
75022 },
8485 "permissions": {
9485 "items": {
103139 "minLength": 1,
11322n/a "type": "string"
12485 },
13530 "type": "array"
14485 }
156323 },
16128n/a "type": "object"
1710523}
multipart/form-data7 / 8
PatchedGroupRequest
1684{
2554 "properties": {
3363 "name": {
4381 "maxLength": 150,
5372 "minLength": 1,
639n/a "type": "string"
7363 },
8361 "permissions": {
9361 "items": {
101421 "minLength": 1,
11143n/a "type": "string"
12361 },
13370 "type": "array"
14361 }
15554 },
1672n/a "type": "object"
17684}
Responses1 of 1 documented received
codedescriptionhitsavg
20033913ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2294ms
400Bad Request1415ms
401Unauthorized388ms
41514ms
403Forbidden12ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
171719{
271719 "type": "integer"
371719}
Body25 of 27 keywords covered
application/json9 / 9
GroupRequest
137427{
237620 "properties": {
33869 "name": {
43891 "maxLength": 150,
53873 "minLength": 1,
63905 "type": "string"
73869 },
838411 "permissions": {
93846 "items": {
101211 "minLength": 1,
111225 "type": "string"
123846 },
133905 "type": "array"
1438411 }
1537620 },
163942 "required": [
173951 "name",
183951 "permissions"
193942 ],
203965 "type": "object"
2137427}
application/x-www-form-urlencoded8 / 9
GroupRequest
11484{
2934 "properties": {
3952 "name": {
4961 "maxLength": 150,
5961 "minLength": 1,
697n/a "type": "string"
7952 },
8142 "permissions": {
9142 "items": {
10692 "minLength": 1,
1171n/a "type": "string"
12142 },
13160 "type": "array"
14142 }
15934 },
161682 "required": [
17971 "name",
181682 "permissions"
191682 ],
2098n/a "type": "object"
211484}
multipart/form-data8 / 9
GroupRequest
112123{
21313 "properties": {
31312 "name": {
41321 "maxLength": 150,
51321 "minLength": 1,
6133n/a "type": "string"
71312 },
8131 "permissions": {
9131 "items": {
10381 "minLength": 1,
1139n/a "type": "string"
12131 },
13140 "type": "array"
14131 }
151313 },
1613122 "required": [
171332 "name",
1814121 "permissions"
1913122 ],
20135n/a "type": "object"
2112123}
Responses1 of 1 documented received
codedescriptionhitsavg
2006518ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1935ms
404Not Found4524ms
401Unauthorized2510ms
415112ms
logs 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Responses1 of 1 documented received
codedescriptionhitsavg
20033333ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized6342ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1343n/a{
2343n/a "type": "string"
3343n/a}
Query Parameters1 of 1 keywords covered
limit1 / 1
112381{
212381 "type": "integer"
312381}
Responses2 of 2 documented received
codedescriptionhitsavg
2002884ms
404No response body1393ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request773ms
401Unauthorized2610ms
500Internal Server Error24ms
mail_accounts 8 operations 3 covered 5 partial 0 uncovered 0 not measured 81% #
Query Parameters2 of 2 keywords covered
page1 / 1
#validinvalidschema
11717449{
21717449 "type": "integer"
31717449}
page_size1 / 1
11694428{
21694428 "type": "integer"
31694428}
Responses1 of 1 documented received
codedescriptionhitsavg
200167611ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1524ms
404Not Found20493ms
Body122 of 150 keywords covered
application/json50 / 50
MailAccountRequest
#validinvalidschema
11274465{
21289433 "properties": {
3103924 "account_type": {
41n/a "allOf": [
5103924 {
6103924 "$ref": "#/components/schemas/AccountTypeEnum"
7103924 }
81n/a ],
910453 "maximum": 9223372036854775807,
1010453 "minimum": 0
11103924 },
12146036 "character_set": {
1314756 "maxLength": 256,
14146615 "minLength": 1,
15148115 "type": "string"
16146036 },
17104618 "expiration": {
189436 "format": "date-time",
191064n/a "nullable": true,
20105212 "type": "string"
21104618 },
22169623 "imap_port": {
23169623 "type": "integer"
24169623 },
25101826 "imap_security": {
261n/a "allOf": [
27101826 {
28101826 "$ref": "#/components/schemas/ImapSecurityEnum"
29101826 }
301n/a ],
3110245 "maximum": 9223372036854775807,
3210263 "minimum": 0
33101826 },
34169425 "imap_server": {
3516985 "maxLength": 256,
3616994 "minLength": 1,
37170316 "type": "string"
38169425 },
39101715 "is_token": {
40101715 "type": "boolean"
41101715 },
42169227 "name": {
4316994 "maxLength": 256,
4416967 "minLength": 1,
45170316 "type": "string"
46169227 },
4799015 "owner": {
481005n/a "nullable": true,
4999015 "type": "integer"
5099015 },
51169623 "password": {
5216964 "minLength": 1,
53170019 "type": "string"
54169623 },
55853205 "set_permissions": {
561n/a "allOf": [
57853205 {
58853205 "$ref": "#/components/schemas/SetPermissionsRequest"
59853205 }
601n/a ],
61 "writeOnly": true
62853205 },
63169326 "username": {
6416968 "maxLength": 256,
6517013 "minLength": 1,
66170415 "type": "string"
67169326 }
681289433 },
69170717 "required": [
7017195 "imap_port",
7117195 "imap_server",
7217195 "name",
7317195 "password",
7417195 "username"
75170717 ],
76172415 "type": "object"
771274465}
Referenced Components (4)20 of 20 keywords
AccountTypeEnum3 of 3 keywords
1103924{
2103924 "enum": [
3716n/a 1,
4176n/a 2,
5147n/a 3
6103924 ],
7104518 "type": "integer"
8103924}
ImapSecurityEnum3 of 3 keywords
1101826{
2101826 "enum": [
3680n/a 1,
4168n/a 2,
5170n/a 3
6101826 ],
7102618 "type": "integer"
8101826}
PermissionSetRequest9 of 9 keywords
11371205{
21145155 "properties": {
3116387 "groups": {
4103142 "items": {
568348 "type": "integer"
6103142 },
71250n/a "nullable": true,
8120545 "type": "array"
9116387 },
10115068 "users": {
11102642 "items": {
1256348 "type": "integer"
13102642 },
141218n/a "nullable": true,
15119226 "type": "array"
16115068 }
171145155 },
18152650 "type": "object"
191371205}
SetPermissionsRequest5 of 5 keywords
1853205{
2687190 "properties": {
3697102 "change": {
4697102 "$ref": "#/components/schemas/PermissionSetRequest"
5697102 },
6674103 "view": {
7674103 "$ref": "#/components/schemas/PermissionSetRequest"
8674103 }
9687190 },
10104315 "type": "object"
11853205}
application/x-www-form-urlencoded36 / 50
MailAccountRequest
1756746{
2756746 "properties": {
387320 "account_type": {
41n/a "allOf": [
587320 {
687320 "$ref": "#/components/schemas/AccountTypeEnum"
787320 }
81n/a ],
98775 "maximum": 9223372036854775807,
108784 "minimum": 0
1187320 },
12130214 "character_set": {
1313088 "maxLength": 256,
1413106 "minLength": 1,
151316n/a "type": "string"
16130214 },
17764139 "expiration": {
18764139 "format": "date-time",
19903n/a "nullable": true,
20903n/a "type": "string"
21764139 },
22143855 "imap_port": {
23143855 "type": "integer"
24143855 },
2582026 "imap_security": {
261n/a "allOf": [
2782026 {
2882026 "$ref": "#/components/schemas/ImapSecurityEnum"
2982026 }
301n/a ],
318316 "maximum": 9223372036854775807,
328343 "minimum": 0
3382026 },
34147920 "imap_server": {
3514936 "maxLength": 256,
36148514 "minLength": 1,
371499n/a "type": "string"
38147920 },
398806 "is_token": {
408806 "type": "boolean"
418806 },
42147821 "name": {
43148712 "maxLength": 256,
4414909 "minLength": 1,
451499n/a "type": "string"
46147821 },
47254587 "owner": {
48841n/a "nullable": true,
49254587 "type": "integer"
50254587 },
5114945 "password": {
5214945 "minLength": 1,
531499n/a "type": "string"
5414945 },
5500 "set_permissions": {
560n/a "allOf": [
5700 {
5800 "$ref": "#/components/schemas/SetPermissionsRequest"
5900 }
600n/a ],
61 "writeOnly": true
6200 },
6314927 "username": {
6414954 "maxLength": 256,
6514963 "minLength": 1,
661499n/a "type": "string"
6714927 }
68756746 },
69148121 "required": [
7014939 "imap_port",
7114993 "imap_server",
7214993 "name",
7314993 "password",
7414993 "username"
75148121 ],
761502n/a "type": "object"
77756746}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
187320{
287320 "enum": [
3499n/a 1,
4151n/a 2,
5223n/a 3
687320 ],
788211 "type": "integer"
887320}
ImapSecurityEnum3 of 3 keywords
182026{
282026 "enum": [
3516n/a 1,
4143n/a 2,
5161n/a 3
682026 ],
78379 "type": "integer"
882026}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data36 / 50
MailAccountRequest
1369929{
2371927 "properties": {
386025 "account_type": {
41n/a "allOf": [
586025 {
686025 "$ref": "#/components/schemas/AccountTypeEnum"
786025 }
81n/a ],
98634 "maximum": 9223372036854775807,
108643 "minimum": 0
1186025 },
12117512 "character_set": {
1311798 "maxLength": 256,
1411834 "minLength": 1,
151187n/a "type": "string"
16117512 },
1779894 "expiration": {
1879894 "format": "date-time",
19892n/a "nullable": true,
20892n/a "type": "string"
2179894 },
22125835 "imap_port": {
23125835 "type": "integer"
24125835 },
2584331 "imap_security": {
261n/a "allOf": [
2784331 {
2884331 "$ref": "#/components/schemas/ImapSecurityEnum"
2984331 }
301n/a ],
318473 "maximum": 9223372036854775807,
328473 "minimum": 0
3384331 },
34128311 "imap_server": {
3512895 "maxLength": 256,
3612886 "minLength": 1,
371294n/a "type": "string"
38128311 },
3983715 "is_token": {
4083715 "type": "boolean"
4183715 },
4212877 "name": {
4312904 "maxLength": 256,
4412913 "minLength": 1,
451294n/a "type": "string"
4612877 },
47172672 "owner": {
48844n/a "nullable": true,
49172672 "type": "integer"
50172672 },
5112913 "password": {
5212913 "minLength": 1,
531294n/a "type": "string"
5412913 },
550854 "set_permissions": {
560n/a "allOf": [
570854 {
580854 "$ref": "#/components/schemas/SetPermissionsRequest"
590854 }
600n/a ],
61 "writeOnly": true
620854 },
63128212 "username": {
6412868 "maxLength": 256,
6512904 "minLength": 1,
661294n/a "type": "string"
67128212 }
68371927 },
69128117 "required": [
7012935 "imap_port",
7112944 "imap_server",
7212944 "name",
7312944 "password",
7412944 "username"
75128117 ],
761298n/a "type": "object"
77369929}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
186025{
286025 "enum": [
3548n/a 1,
4193n/a 2,
5119n/a 3
686025 ],
786718 "type": "integer"
886025}
ImapSecurityEnum3 of 3 keywords
184331{
284331 "enum": [
3521n/a 1,
4129n/a 2,
5193n/a 3
684331 ],
785024 "type": "integer"
884331}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10854{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100854 "type": "object"
110854}
Responses1 of 1 documented received
codedescriptionhitsavg
20140113ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request39744ms
401Unauthorized1464ms
41533ms
500Internal Server Error5807ms
Body122 of 150 keywords covered
application/json50 / 50
MailAccountRequest
#validinvalidschema
1138177{
2143167 "properties": {
32278 "account_type": {
41n/a "allOf": [
52278 {
62278 "$ref": "#/components/schemas/AccountTypeEnum"
72278 }
81n/a ],
92291 "maximum": 9223372036854775807,
102291 "minimum": 0
112278 },
122149 "character_set": {
132153 "maxLength": 256,
142171 "minLength": 1,
152185 "type": "string"
162149 },
172267 "expiration": {
182042 "format": "date-time",
19233n/a "nullable": true,
202285 "type": "string"
212267 },
223036 "imap_port": {
233036 "type": "integer"
243036 },
252118 "imap_security": {
261n/a "allOf": [
272118 {
282118 "$ref": "#/components/schemas/ImapSecurityEnum"
292118 }
301n/a ],
312131 "maximum": 9223372036854775807,
322131 "minimum": 0
332118 },
3429712 "imap_server": {
352995 "maxLength": 256,
363022 "minLength": 1,
373045 "type": "string"
3829712 },
3921812 "is_token": {
4021812 "type": "boolean"
4121812 },
4229613 "name": {
432995 "maxLength": 256,
443013 "minLength": 1,
453045 "type": "string"
4629613 },
472105 "owner": {
48215n/a "nullable": true,
492105 "type": "integer"
502105 },
513036 "password": {
523031 "minLength": 1,
533045 "type": "string"
543036 },
5513883 "set_permissions": {
561n/a "allOf": [
5713883 {
5813883 "$ref": "#/components/schemas/SetPermissionsRequest"
5913883 }
601n/a ],
61 "writeOnly": true
6213883 },
633027 "username": {
643031 "maxLength": 256,
653031 "minLength": 1,
663045 "type": "string"
673027 }
68143167 },
693055 "required": [
703091 "imap_port",
713091 "imap_server",
723091 "name",
733091 "password",
743091 "username"
753055 ],
763105 "type": "object"
77138177}
Referenced Components (4)20 of 20 keywords
AccountTypeEnum3 of 3 keywords
12278{
22278 "enum": [
3204n/a 1,
413n/a 2,
510n/a 3
62278 ],
72296 "type": "integer"
82278}
ImapSecurityEnum3 of 3 keywords
12118{
22118 "enum": [
3177n/a 1,
416n/a 2,
518n/a 3
62118 ],
72136 "type": "integer"
82118}
PermissionSetRequest9 of 9 keywords
131386{
229976 "properties": {
332437 "groups": {
431919 "items": {
53051 "type": "integer"
631919 },
7361n/a "nullable": true,
834318 "type": "array"
932437 },
1032239 "users": {
1131317 "items": {
121129 "type": "integer"
1331317 },
14361n/a "nullable": true,
1533922 "type": "array"
1632239 }
1729976 },
1838910 "type": "object"
1931386}
SetPermissionsRequest5 of 5 keywords
113883{
213478 "properties": {
316040 "change": {
416040 "$ref": "#/components/schemas/PermissionSetRequest"
516040 },
615346 "view": {
715346 "$ref": "#/components/schemas/PermissionSetRequest"
815346 }
913478 },
102165 "type": "object"
1113883}
application/x-www-form-urlencoded36 / 50
MailAccountRequest
130154{
232151 "properties": {
31337 "account_type": {
41n/a "allOf": [
51337 {
61337 "$ref": "#/components/schemas/AccountTypeEnum"
71337 }
81n/a ],
91342 "maximum": 9223372036854775807,
101351 "minimum": 0
111337 },
121435 "character_set": {
131471 "maxLength": 256,
141444 "minLength": 1,
15148n/a "type": "string"
161435 },
1712624 "expiration": {
1812624 "format": "date-time",
19150n/a "nullable": true,
20150n/a "type": "string"
2112624 },
221764 "imap_port": {
231764 "type": "integer"
241764 },
2513115 "imap_security": {
261n/a "allOf": [
2713115 {
2813115 "$ref": "#/components/schemas/ImapSecurityEnum"
2913115 }
301n/a ],
311341 "maximum": 9223372036854775807,
321341 "minimum": 0
3313115 },
3416616 "imap_server": {
3516715 "maxLength": 256,
361811 "minLength": 1,
37182n/a "type": "string"
3816616 },
391432 "is_token": {
401432 "type": "boolean"
411432 },
4215329 "name": {
4316814 "maxLength": 256,
4416715 "minLength": 1,
45182n/a "type": "string"
4615329 },
4712120 "owner": {
48132n/a "nullable": true,
4912120 "type": "integer"
5012120 },
511811 "password": {
521811 "minLength": 1,
53182n/a "type": "string"
541811 },
5500 "set_permissions": {
560n/a "allOf": [
5700 {
5800 "$ref": "#/components/schemas/SetPermissionsRequest"
5900 }
600n/a ],
61 "writeOnly": true
6200 },
631802 "username": {
641811 "maxLength": 256,
651811 "minLength": 1,
66182n/a "type": "string"
671802 }
6832151 },
691768 "required": [
701804 "imap_port",
711822 "imap_server",
721822 "name",
731822 "password",
741822 "username"
751768 ],
76184n/a "type": "object"
7730154}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
11337{
21337 "enum": [
3115n/a 1,
413n/a 2,
55n/a 3
61337 ],
71364 "type": "integer"
81337}
ImapSecurityEnum3 of 3 keywords
113115{
213115 "enum": [
3111n/a 1,
412n/a 2,
58n/a 3
613115 ],
713511 "type": "integer"
813115}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data36 / 50
MailAccountRequest
126176{
226176 "properties": {
31658 "account_type": {
41n/a "allOf": [
51658 {
61658 "$ref": "#/components/schemas/AccountTypeEnum"
71658 }
81n/a ],
91661 "maximum": 9223372036854775807,
101661 "minimum": 0
111658 },
121682 "character_set": {
131691 "maxLength": 256,
141691 "minLength": 1,
15170n/a "type": "string"
161682 },
1716313 "expiration": {
1816313 "format": "date-time",
19176n/a "nullable": true,
20176n/a "type": "string"
2116313 },
221929 "imap_port": {
231929 "type": "integer"
241929 },
251618 "imap_security": {
261n/a "allOf": [
271618 {
281618 "$ref": "#/components/schemas/ImapSecurityEnum"
291618 }
301n/a ],
311621 "maximum": 9223372036854775807,
321621 "minimum": 0
331618 },
341992 "imap_server": {
352001 "maxLength": 256,
362001 "minLength": 1,
37201n/a "type": "string"
381992 },
391545 "is_token": {
401545 "type": "boolean"
411545 },
421992 "name": {
432001 "maxLength": 256,
442001 "minLength": 1,
45201n/a "type": "string"
461992 },
478159 "owner": {
48167n/a "nullable": true,
498159 "type": "integer"
508159 },
512001 "password": {
522001 "minLength": 1,
53201n/a "type": "string"
542001 },
550172 "set_permissions": {
560n/a "allOf": [
570172 {
580172 "$ref": "#/components/schemas/SetPermissionsRequest"
590172 }
600n/a ],
61 "writeOnly": true
620172 },
631974 "username": {
641992 "maxLength": 256,
651992 "minLength": 1,
66201n/a "type": "string"
671974 }
6826176 },
691975 "required": [
702011 "imap_port",
712011 "imap_server",
722011 "name",
732011 "password",
742011 "username"
751975 ],
76202n/a "type": "object"
7726176}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
11658{
21658 "enum": [
3153n/a 1,
49n/a 2,
53n/a 3
61658 ],
71676 "type": "integer"
81658}
ImapSecurityEnum3 of 3 keywords
11618{
21618 "enum": [
3133n/a 1,
420n/a 2,
58n/a 3
61618 ],
71636 "type": "integer"
81618}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10172{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100172 "type": "object"
110172}
Responses1 of 2 documented received
codedescriptionhitsavg
2000never seen
4003864ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5455ms
41512ms
401Unauthorized272ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
12235{
22235 "type": "integer"
32235}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body13613ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found663ms
401Unauthorized2610ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
161333{
261333 "type": "integer"
361333}
Responses1 of 1 documented received
codedescriptionhitsavg
2003584ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2023ms
401Unauthorized864ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1159019{
2159019 "type": "integer"
3159019}
Body119 of 147 keywords covered
application/json49 / 49
PatchedMailAccountRequest
1376282{
2218270 "properties": {
341316 "account_type": {
41n/a "allOf": [
541316 {
641316 "$ref": "#/components/schemas/AccountTypeEnum"
741316 }
81n/a ],
94172 "maximum": 9223372036854775807,
104172 "minimum": 0
1141316 },
1240714 "character_set": {
134092 "maxLength": 256,
144092 "minLength": 1,
1541110 "type": "string"
1640714 },
1740612 "expiration": {
183964 "format": "date-time",
19418n/a "nullable": true,
204108 "type": "string"
2140612 },
2239512 "imap_port": {
2339512 "type": "integer"
2439512 },
2538417 "imap_security": {
261n/a "allOf": [
2738417 {
2838417 "$ref": "#/components/schemas/ImapSecurityEnum"
2938417 }
301n/a ],
313892 "maximum": 9223372036854775807,
323883 "minimum": 0
3338417 },
3438314 "imap_server": {
353852 "maxLength": 256,
363852 "minLength": 1,
3738710 "type": "string"
3838314 },
3939413 "is_token": {
4039413 "type": "boolean"
4139413 },
4237915 "name": {
433822 "maxLength": 256,
443813 "minLength": 1,
4538410 "type": "string"
4637915 },
4737614 "owner": {
48390n/a "nullable": true,
4937614 "type": "integer"
5037614 },
5137812 "password": {
523782 "minLength": 1,
5338010 "type": "string"
5437812 },
55277120 "set_permissions": {
561n/a "allOf": [
57277120 {
58277120 "$ref": "#/components/schemas/SetPermissionsRequest"
59277120 }
601n/a ],
61 "writeOnly": true
62277120 },
6337214 "username": {
643742 "maxLength": 256,
653742 "minLength": 1,
6637610 "type": "string"
6737214 }
68218270 },
6964612 "type": "object"
70376282}
Referenced Components (4)20 of 20 keywords
AccountTypeEnum3 of 3 keywords
141316{
241316 "enum": [
3372n/a 1,
419n/a 2,
522n/a 3
641316 ],
741712 "type": "integer"
841316}
ImapSecurityEnum3 of 3 keywords
138417{
238417 "enum": [
3352n/a 1,
416n/a 2,
516n/a 3
638417 ],
738912 "type": "integer"
838417}
PermissionSetRequest9 of 9 keywords
1619111{
259989 "properties": {
362845 "groups": {
461928 "items": {
54632 "type": "integer"
661928 },
7673n/a "nullable": true,
865617 "type": "array"
962845 },
1062245 "users": {
1161028 "items": {
125332 "type": "integer"
1361028 },
14667n/a "nullable": true,
1565017 "type": "array"
1662245 }
1759989 },
1870822 "type": "object"
19619111}
SetPermissionsRequest5 of 5 keywords
1277120{
2263110 "properties": {
331056 "change": {
431056 "$ref": "#/components/schemas/PermissionSetRequest"
531056 },
630955 "view": {
730955 "$ref": "#/components/schemas/PermissionSetRequest"
830955 }
9263110 },
1038710 "type": "object"
11277120}
application/x-www-form-urlencoded35 / 49
PatchedMailAccountRequest
191242{
283242 "properties": {
324113 "account_type": {
41n/a "allOf": [
524113 {
624113 "$ref": "#/components/schemas/AccountTypeEnum"
724113 }
81n/a ],
92434 "maximum": 9223372036854775807,
102452 "minimum": 0
1124113 },
122536 "character_set": {
132572 "maxLength": 256,
142554 "minLength": 1,
15259n/a "type": "string"
162536 },
1724219 "expiration": {
1824219 "format": "date-time",
19261n/a "nullable": true,
20261n/a "type": "string"
2124219 },
222478 "imap_port": {
232478 "type": "integer"
242478 },
2523911 "imap_security": {
261n/a "allOf": [
2723911 {
2823911 "$ref": "#/components/schemas/ImapSecurityEnum"
2923911 }
301n/a ],
312422 "maximum": 9223372036854775807,
322422 "minimum": 0
3323911 },
342436 "imap_server": {
352454 "maxLength": 256,
362472 "minLength": 1,
37249n/a "type": "string"
382436 },
392424 "is_token": {
402424 "type": "boolean"
412424 },
422415 "name": {
432442 "maxLength": 256,
442433 "minLength": 1,
45246n/a "type": "string"
462415 },
4737221 "owner": {
48258n/a "nullable": true,
4937221 "type": "integer"
5037221 },
512353 "password": {
522353 "minLength": 1,
53238n/a "type": "string"
542353 },
5500 "set_permissions": {
560n/a "allOf": [
5700 {
5800 "$ref": "#/components/schemas/SetPermissionsRequest"
5900 }
600n/a ],
61 "writeOnly": true
6200 },
6323912 "username": {
6424110 "maxLength": 256,
652492 "minLength": 1,
66251n/a "type": "string"
6723912 }
6883242 },
69333n/a "type": "object"
7091242}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
124113{
224113 "enum": [
3210n/a 1,
413n/a 2,
518n/a 3
624113 ],
72477 "type": "integer"
824113}
ImapSecurityEnum3 of 3 keywords
123911{
223911 "enum": [
3209n/a 1,
422n/a 2,
58n/a 3
623911 ],
72446 "type": "integer"
823911}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data35 / 49
PatchedMailAccountRequest
1124314{
293314 "properties": {
330316 "account_type": {
41n/a "allOf": [
530316 {
630316 "$ref": "#/components/schemas/AccountTypeEnum"
730316 }
81n/a ],
93052 "maximum": 9223372036854775807,
103052 "minimum": 0
1130316 },
123165 "character_set": {
133192 "maxLength": 256,
143183 "minLength": 1,
15321n/a "type": "string"
163165 },
1729719 "expiration": {
1829719 "format": "date-time",
19316n/a "nullable": true,
20316n/a "type": "string"
2129719 },
2230413 "imap_port": {
2330413 "type": "integer"
2430413 },
2534616 "imap_security": {
261n/a "allOf": [
2734616 {
2834616 "$ref": "#/components/schemas/ImapSecurityEnum"
2934616 }
301n/a ],
313482 "maximum": 9223372036854775807,
323482 "minimum": 0
3334616 },
343044 "imap_server": {
353062 "maxLength": 256,
363062 "minLength": 1,
37308n/a "type": "string"
383044 },
3930210 "is_token": {
4030210 "type": "boolean"
4130210 },
423017 "name": {
433062 "maxLength": 256,
443035 "minLength": 1,
45308n/a "type": "string"
463017 },
477298 "owner": {
48305n/a "nullable": true,
497298 "type": "integer"
507298 },
512992 "password": {
522992 "minLength": 1,
53301n/a "type": "string"
542992 },
550301 "set_permissions": {
560n/a "allOf": [
570301 {
580301 "$ref": "#/components/schemas/SetPermissionsRequest"
590301 }
600n/a ],
61 "writeOnly": true
620301 },
632956 "username": {
642992 "maxLength": 256,
652974 "minLength": 1,
66301n/a "type": "string"
672956 }
6893314 },
69438n/a "type": "object"
70124314}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
130316{
230316 "enum": [
3284n/a 1,
413n/a 2,
56n/a 3
630316 ],
730712 "type": "integer"
830316}
ImapSecurityEnum3 of 3 keywords
134616{
234616 "enum": [
3322n/a 1,
412n/a 2,
512n/a 3
634616 ],
735012 "type": "integer"
834616}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10301{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100301 "type": "object"
110301}
Responses1 of 1 documented received
codedescriptionhitsavg
20037413ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found7134ms
400Bad Request4895ms
401Unauthorized2411ms
41513ms
403Forbidden12ms
500Internal Server Error77ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1157627{
2157627 "type": "integer"
3157627}
Body122 of 150 keywords covered
application/json50 / 50
MailAccountRequest
1469297{
2479277 "properties": {
342317 "account_type": {
41n/a "allOf": [
542317 {
642317 "$ref": "#/components/schemas/AccountTypeEnum"
742317 }
81n/a ],
94273 "maximum": 9223372036854775807,
104282 "minimum": 0
1142317 },
1241614 "character_set": {
134182 "maxLength": 256,
144182 "minLength": 1,
1542010 "type": "string"
1641614 },
1741312 "expiration": {
184054 "format": "date-time",
19425n/a "nullable": true,
204178 "type": "string"
2141312 },
2274212 "imap_port": {
2374212 "type": "integer"
2474212 },
2542017 "imap_security": {
261n/a "allOf": [
2742017 {
2842017 "$ref": "#/components/schemas/ImapSecurityEnum"
2942017 }
301n/a ],
314243 "maximum": 9223372036854775807,
324252 "minimum": 0
3342017 },
3473915 "imap_server": {
357422 "maxLength": 256,
367413 "minLength": 1,
3774410 "type": "string"
3873915 },
3941210 "is_token": {
4041210 "type": "boolean"
4141210 },
4273816 "name": {
437422 "maxLength": 256,
447404 "minLength": 1,
4574410 "type": "string"
4673816 },
4741810 "owner": {
48428n/a "nullable": true,
4941810 "type": "integer"
5041810 },
5174212 "password": {
527422 "minLength": 1,
5374410 "type": "string"
5474212 },
55309126 "set_permissions": {
561n/a "allOf": [
57309126 {
58309126 "$ref": "#/components/schemas/SetPermissionsRequest"
59309126 }
601n/a ],
61 "writeOnly": true
62309126 },
6373816 "username": {
647422 "maxLength": 256,
657404 "minLength": 1,
6674410 "type": "string"
6773816 }
68479277 },
6974610 "required": [
707542 "imap_port",
717542 "imap_server",
727542 "name",
737542 "password",
747542 "username"
7574610 ],
7675610 "type": "object"
77469297}
Referenced Components (4)20 of 20 keywords
AccountTypeEnum3 of 3 keywords
142317{
242317 "enum": [
3367n/a 1,
424n/a 2,
532n/a 3
642317 ],
742812 "type": "integer"
842317}
ImapSecurityEnum3 of 3 keywords
142017{
242017 "enum": [
3378n/a 1,
426n/a 2,
516n/a 3
642017 ],
742512 "type": "integer"
842017}
PermissionSetRequest9 of 9 keywords
1669117{
263595 "properties": {
366651 "groups": {
465128 "items": {
56632 "type": "integer"
665128 },
7717n/a "nullable": true,
869423 "type": "array"
966651 },
1066744 "users": {
1164928 "items": {
126432 "type": "integer"
1364928 },
14711n/a "nullable": true,
1569516 "type": "array"
1666744 }
1763595 },
1876422 "type": "object"
19669117}
SetPermissionsRequest5 of 5 keywords
1309126{
2295116 "properties": {
332755 "change": {
432755 "$ref": "#/components/schemas/PermissionSetRequest"
532755 },
634262 "view": {
734262 "$ref": "#/components/schemas/PermissionSetRequest"
834262 }
9295116 },
1042510 "type": "object"
11309126}
application/x-www-form-urlencoded36 / 50
MailAccountRequest
1143247{
2144246 "properties": {
326910 "account_type": {
41n/a "allOf": [
526910 {
626910 "$ref": "#/components/schemas/AccountTypeEnum"
726910 }
81n/a ],
92712 "maximum": 9223372036854775807,
102712 "minimum": 0
1126910 },
122735 "character_set": {
132753 "maxLength": 256,
142762 "minLength": 1,
15278n/a "type": "string"
162735 },
1724919 "expiration": {
1824919 "format": "date-time",
19268n/a "nullable": true,
20268n/a "type": "string"
2124919 },
223789 "imap_port": {
233789 "type": "integer"
243789 },
2525410 "imap_security": {
261n/a "allOf": [
2725410 {
2825410 "$ref": "#/components/schemas/ImapSecurityEnum"
2925410 }
301n/a ],
312562 "maximum": 9223372036854775807,
322562 "minimum": 0
3325410 },
343844 "imap_server": {
353862 "maxLength": 256,
363862 "minLength": 1,
37388n/a "type": "string"
383844 },
392974 "is_token": {
402974 "type": "boolean"
412974 },
423826 "name": {
433844 "maxLength": 256,
443862 "minLength": 1,
45388n/a "type": "string"
463826 },
4730238 "owner": {
48268n/a "nullable": true,
4930238 "type": "integer"
5030238 },
513853 "password": {
523853 "minLength": 1,
53388n/a "type": "string"
543853 },
5500 "set_permissions": {
560n/a "allOf": [
5700 {
5800 "$ref": "#/components/schemas/SetPermissionsRequest"
5900 }
600n/a ],
61 "writeOnly": true
6200 },
633835 "username": {
643853 "maxLength": 256,
653862 "minLength": 1,
66388n/a "type": "string"
673835 }
68144246 },
6937911 "required": [
703873 "imap_port",
713882 "imap_server",
723882 "name",
733882 "password",
743882 "username"
7537911 ],
76390n/a "type": "object"
77143247}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
126910{
226910 "enum": [
3227n/a 1,
428n/a 2,
514n/a 3
626910 ],
72736 "type": "integer"
826910}
ImapSecurityEnum3 of 3 keywords
125410{
225410 "enum": [
3212n/a 1,
420n/a 2,
522n/a 3
625410 ],
72586 "type": "integer"
825410}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data36 / 50
MailAccountRequest
137338{
237338 "properties": {
331317 "account_type": {
41n/a "allOf": [
531317 {
631317 "$ref": "#/components/schemas/AccountTypeEnum"
731317 }
81n/a ],
93152 "maximum": 9223372036854775807,
103152 "minimum": 0
1131317 },
123064 "character_set": {
133082 "maxLength": 256,
143082 "minLength": 1,
15310n/a "type": "string"
163064 },
1729722 "expiration": {
1829722 "format": "date-time",
19319n/a "nullable": true,
20319n/a "type": "string"
2129722 },
2235914 "imap_port": {
2335914 "type": "integer"
2435914 },
2528416 "imap_security": {
261n/a "allOf": [
2728416 {
2828416 "$ref": "#/components/schemas/ImapSecurityEnum"
2928416 }
301n/a ],
312862 "maximum": 9223372036854775807,
322862 "minimum": 0
3328416 },
343694 "imap_server": {
353712 "maxLength": 256,
363712 "minLength": 1,
37373n/a "type": "string"
383694 },
3931610 "is_token": {
4031610 "type": "boolean"
4131610 },
423685 "name": {
433703 "maxLength": 256,
443712 "minLength": 1,
45373n/a "type": "string"
463685 },
4719282 "owner": {
48301n/a "nullable": true,
4919282 "type": "integer"
5019282 },
513712 "password": {
523712 "minLength": 1,
53373n/a "type": "string"
543712 },
550332 "set_permissions": {
560n/a "allOf": [
570332 {
580332 "$ref": "#/components/schemas/SetPermissionsRequest"
590332 }
600n/a ],
61 "writeOnly": true
620332 },
633694 "username": {
643712 "maxLength": 256,
653712 "minLength": 1,
66373n/a "type": "string"
673694 }
6837338 },
6936510 "required": [
703732 "imap_port",
713732 "imap_server",
723732 "name",
733732 "password",
743732 "username"
7536510 ],
76375n/a "type": "object"
7737338}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
131317{
231317 "enum": [
3276n/a 1,
411n/a 2,
526n/a 3
631317 ],
731713 "type": "integer"
831317}
ImapSecurityEnum3 of 3 keywords
128416{
228416 "enum": [
3268n/a 1,
411n/a 2,
55n/a 3
628416 ],
728812 "type": "integer"
828416}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10332{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100332 "type": "object"
110332}
Responses1 of 1 documented received
codedescriptionhitsavg
20012612ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5575ms
404Not Found8863ms
401Unauthorized2510ms
41513ms
500Internal Server Error87ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1109316{
2109316 "type": "integer"
3109316}
Body122 of 150 keywords covered
application/json50 / 50
MailAccountRequest
1259155{
2266143 "properties": {
32388 "account_type": {
41n/a "allOf": [
52388 {
62388 "$ref": "#/components/schemas/AccountTypeEnum"
72388 }
81n/a ],
92401 "maximum": 9223372036854775807,
102401 "minimum": 0
112388 },
122207 "character_set": {
132211 "maxLength": 256,
142211 "minLength": 1,
152225 "type": "string"
162207 },
1721412 "expiration": {
182043 "format": "date-time",
19226n/a "nullable": true,
202179 "type": "string"
2121412 },
224026 "imap_port": {
234026 "type": "integer"
244026 },
252169 "imap_security": {
261n/a "allOf": [
272169 {
282169 "$ref": "#/components/schemas/ImapSecurityEnum"
292169 }
301n/a ],
312182 "maximum": 9223372036854775807,
322191 "minimum": 0
332169 },
344008 "imap_server": {
354021 "maxLength": 256,
364012 "minLength": 1,
374035 "type": "string"
384008 },
392306 "is_token": {
402306 "type": "boolean"
412306 },
423997 "name": {
434001 "maxLength": 256,
444001 "minLength": 1,
454015 "type": "string"
463997 },
4721310 "owner": {
48223n/a "nullable": true,
4921310 "type": "integer"
5021310 },
514008 "password": {
524002 "minLength": 1,
534026 "type": "string"
544008 },
5516465 "set_permissions": {
561n/a "allOf": [
5716465 {
5816465 "$ref": "#/components/schemas/SetPermissionsRequest"
5916465 }
601n/a ],
61 "writeOnly": true
6216465 },
633979 "username": {
643983 "maxLength": 256,
654001 "minLength": 1,
664015 "type": "string"
673979 }
68266143 },
694027 "required": [
704081 "imap_port",
714081 "imap_server",
724063 "name",
734081 "password",
744063 "username"
754027 ],
764095 "type": "object"
77259155}
Referenced Components (4)20 of 20 keywords
AccountTypeEnum3 of 3 keywords
12388{
22388 "enum": [
3215n/a 1,
414n/a 2,
59n/a 3
62388 ],
72406 "type": "integer"
82388}
ImapSecurityEnum3 of 3 keywords
12169{
22169 "enum": [
3189n/a 1,
46n/a 2,
521n/a 3
62169 ],
72196 "type": "integer"
82169}
PermissionSetRequest9 of 9 keywords
133063{
231353 "properties": {
332529 "groups": {
430814 "items": {
52016 "type": "integer"
630814 },
7354n/a "nullable": true,
833915 "type": "array"
932529 },
1032524 "users": {
1131614 "items": {
122516 "type": "integer"
1331614 },
14349n/a "nullable": true,
1533910 "type": "array"
1632524 }
1731353 },
1838310 "type": "object"
1933063}
SetPermissionsRequest5 of 5 keywords
116465{
214960 "properties": {
316933 "change": {
416933 "$ref": "#/components/schemas/PermissionSetRequest"
516933 },
616130 "view": {
716130 "$ref": "#/components/schemas/PermissionSetRequest"
816130 }
914960 },
102245 "type": "object"
1116465}
application/x-www-form-urlencoded36 / 50
MailAccountRequest
1109189{
2109189 "properties": {
31715 "account_type": {
41n/a "allOf": [
51715 {
61715 "$ref": "#/components/schemas/AccountTypeEnum"
71715 }
81n/a ],
91721 "maximum": 9223372036854775807,
101721 "minimum": 0
111715 },
121562 "character_set": {
131571 "maxLength": 256,
141571 "minLength": 1,
15158n/a "type": "string"
161562 },
1715417 "expiration": {
1815417 "format": "date-time",
19171n/a "nullable": true,
20171n/a "type": "string"
2115417 },
2224354 "imap_port": {
2324354 "type": "integer"
2424354 },
251535 "imap_security": {
261n/a "allOf": [
271535 {
281535 "$ref": "#/components/schemas/ImapSecurityEnum"
291535 }
301n/a ],
311541 "maximum": 9223372036854775807,
321541 "minimum": 0
331535 },
342943 "imap_server": {
352952 "maxLength": 256,
362961 "minLength": 1,
37297n/a "type": "string"
382943 },
391692 "is_token": {
401692 "type": "boolean"
411692 },
4224948 "name": {
432934 "maxLength": 256,
4425344 "minLength": 1,
45297n/a "type": "string"
4624948 },
4722134 "owner": {
48156n/a "nullable": true,
4922134 "type": "integer"
5022134 },
512952 "password": {
522952 "minLength": 1,
53297n/a "type": "string"
542952 },
5500 "set_permissions": {
560n/a "allOf": [
5700 {
5800 "$ref": "#/components/schemas/SetPermissionsRequest"
5900 }
600n/a ],
61 "writeOnly": true
6200 },
632925 "username": {
642943 "maxLength": 256,
652952 "minLength": 1,
66297n/a "type": "string"
672925 }
68109189 },
692935 "required": [
702971 "imap_port",
712971 "imap_server",
722971 "name",
732971 "password",
742971 "username"
752935 ],
76298n/a "type": "object"
77109189}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
11715{
21715 "enum": [
3121n/a 1,
419n/a 2,
531n/a 3
61715 ],
71733 "type": "integer"
81715}
ImapSecurityEnum3 of 3 keywords
11535{
21535 "enum": [
3123n/a 1,
419n/a 2,
511n/a 3
61535 ],
71553 "type": "integer"
81535}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data36 / 50
MailAccountRequest
143185{
243185 "properties": {
317710 "account_type": {
41n/a "allOf": [
517710 {
617710 "$ref": "#/components/schemas/AccountTypeEnum"
717710 }
81n/a ],
91791 "maximum": 9223372036854775807,
101791 "minimum": 0
1117710 },
121893 "character_set": {
131902 "maxLength": 256,
141911 "minLength": 1,
15192n/a "type": "string"
161893 },
1716221 "expiration": {
1816221 "format": "date-time",
19183n/a "nullable": true,
20183n/a "type": "string"
2116221 },
2221611 "imap_port": {
2321611 "type": "integer"
2421611 },
2517910 "imap_security": {
261n/a "allOf": [
2717910 {
2817910 "$ref": "#/components/schemas/ImapSecurityEnum"
2917910 }
301n/a ],
311811 "maximum": 9223372036854775807,
321802 "minimum": 0
3317910 },
342252 "imap_server": {
352261 "maxLength": 256,
362261 "minLength": 1,
37227n/a "type": "string"
382252 },
391805 "is_token": {
401805 "type": "boolean"
411805 },
422243 "name": {
432252 "maxLength": 256,
442261 "minLength": 1,
45227n/a "type": "string"
462243 },
4727151 "owner": {
48178n/a "nullable": true,
4927151 "type": "integer"
5027151 },
512252 "password": {
522252 "minLength": 1,
53227n/a "type": "string"
542252 },
550176 "set_permissions": {
560n/a "allOf": [
570176 {
580176 "$ref": "#/components/schemas/SetPermissionsRequest"
590176 }
600n/a ],
61 "writeOnly": true
620176 },
632252 "username": {
642261 "maxLength": 256,
652261 "minLength": 1,
66227n/a "type": "string"
672252 }
6843185 },
692235 "required": [
702271 "imap_port",
712271 "imap_server",
722271 "name",
732271 "password",
742271 "username"
752235 ],
76228n/a "type": "object"
7743185}
Referenced Components (4)6 of 20 keywords
AccountTypeEnum3 of 3 keywords
117710{
217710 "enum": [
3138n/a 1,
49n/a 2,
530n/a 3
617710 ],
71807 "type": "integer"
817710}
ImapSecurityEnum3 of 3 keywords
117910{
217910 "enum": [
3149n/a 1,
426n/a 2,
54n/a 3
617910 ],
71827 "type": "integer"
817910}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10176{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100176 "type": "object"
110176}
Responses2 of 2 documented received
codedescriptionhitsavg
20082723ms
404No response body2414ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized407ms
403Forbidden11ms
mail_rules 6 operations 3 covered 3 partial 0 uncovered 0 not measured 89% #
Query Parameters2 of 2 keywords covered
page1 / 1
#validinvalidschema
11587515{
21587515 "type": "integer"
31587515}
page_size1 / 1
11541485{
21541485 "type": "integer"
31541485}
Responses1 of 1 documented received
codedescriptionhitsavg
20016597ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1863ms
404Not Found19874ms
Body264 of 294 keywords covered
application/json98 / 98
MailRuleRequest
#validinvalidschema
11488495{
21501472 "properties": {
3195012 "account": {
4195012 "type": "integer"
5195012 },
687817 "action": {
71n/a "allOf": [
887817 {
987817 "$ref": "#/components/schemas/MailRuleActionEnum"
1087817 }
111n/a ],
128822 "maximum": 9223372036854775807,
138822 "minimum": 0
1487817 },
1588614 "action_parameter": {
168106 "minLength": 1,
17900n/a "nullable": true,
188928 "type": "string"
1988614 },
2083510 "assign_correspondent": {
21845n/a "nullable": true,
2283510 "type": "integer"
2383510 },
2489816 "assign_correspondent_from": {
251n/a "allOf": [
2689816 {
2789816 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
2889816 }
291n/a ],
309022 "maximum": 9223372036854775807,
319022 "minimum": 0
3289816 },
3384610 "assign_document_type": {
34856n/a "nullable": true,
3584610 "type": "integer"
3684610 },
3789710 "assign_owner_from_rule": {
3889710 "type": "boolean"
3989710 },
4084321 "assign_tags": {
4184311 "items": {
421090n/a "nullable": true,
43107416 "type": "integer"
4484311 },
4585410 "type": "array"
4684321 },
4783417 "assign_title_from": {
481n/a "allOf": [
4983417 {
5083417 "$ref": "#/components/schemas/AssignTitleFromEnum"
5183417 }
521n/a ],
538383 "maximum": 9223372036854775807,
548392 "minimum": 0
5583417 },
5681123 "attachment_type": {
571n/a "allOf": [
5881123 {
5981123 "$ref": "#/components/schemas/AttachmentTypeEnum"
6081123 }
611n/a ],
628159 "maximum": 9223372036854775807,
638222 "minimum": 0
6481123 },
6583718 "consumption_scope": {
661n/a "allOf": [
6783718 {
6883718 "$ref": "#/components/schemas/ConsumptionScopeEnum"
6983718 }
701n/a ],
718423 "maximum": 9223372036854775807,
728423 "minimum": 0
7383718 },
7482611 "enabled": {
7582611 "type": "boolean"
7682611 },
7788111 "filter_attachment_filename_exclude": {
788522 "maxLength": 256,
79892n/a "nullable": true,
808839 "type": "string"
8188111 },
8286316 "filter_attachment_filename_include": {
837912 "maxLength": 256,
84879n/a "nullable": true,
8586514 "type": "string"
8686316 },
8784411 "filter_body": {
887853 "maxLength": 256,
89855n/a "nullable": true,
908478 "type": "string"
9184411 },
9283010 "filter_from": {
937942 "maxLength": 256,
94840n/a "nullable": true,
958328 "type": "string"
9683010 },
9781618 "filter_subject": {
987582 "maxLength": 256,
99834n/a "nullable": true,
10081816 "type": "string"
10181618 },
10284312 "filter_to": {
1037232 "maxLength": 256,
104855n/a "nullable": true,
10584510 "type": "string"
10684312 },
10779714 "folder": {
1087992 "maxLength": 256,
1097992 "minLength": 1,
11080110 "type": "string"
11179714 },
11282816 "maximum_age": {
11383014 "format": "int64",
1148322 "maximum": 9223372036854775807,
1158322 "minimum": 0,
11683212 "type": "integer"
11782816 },
118194625 "name": {
11919574 "maxLength": 256,
120195011 "minLength": 1,
121196110 "type": "string"
122194625 },
12383712 "order": {
12483712 "type": "integer"
12583712 },
12685410 "owner": {
127864n/a "nullable": true,
12885410 "type": "integer"
12985410 },
13078217 "pdf_layout": {
1311n/a "allOf": [
13278217 {
13378217 "$ref": "#/components/schemas/PdfLayoutEnum"
13478217 }
1351n/a ],
1367872 "maximum": 9223372036854775807,
1377863 "minimum": 0
13878217 },
139716122 "set_permissions": {
1401n/a "allOf": [
141716122 {
142716122 "$ref": "#/components/schemas/SetPermissionsRequest"
143716122 }
1441n/a ],
145 "writeOnly": true
146716122 },
14784411 "stop_processing": {
14884411 "type": "boolean"
14984411 }
1501501472 },
151196013 "required": [
152196211 "account",
15319712 "name"
154196013 ],
155197310 "type": "object"
1561488495}
Referenced Components (8)32 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
189816{
289816 "enum": [
3700n/a 1,
469n/a 2,
564n/a 3,
665n/a 4
789816 ],
890212 "type": "integer"
989816}
AssignTitleFromEnum3 of 3 keywords
183417{
283417 "enum": [
3677n/a 1,
466n/a 2,
591n/a 3
683417 ],
783912 "type": "integer"
883417}
AttachmentTypeEnum3 of 3 keywords
181123{
281123 "enum": [
3733n/a 1,
478n/a 2
581123 ],
682212 "type": "integer"
781123}
ConsumptionScopeEnum3 of 3 keywords
183718{
283718 "enum": [
3672n/a 1,
483n/a 2,
582n/a 3
683718 ],
784213 "type": "integer"
883718}
MailRuleActionEnum3 of 3 keywords
187817{
287817 "enum": [
3696n/a 1,
448n/a 2,
560n/a 3,
631n/a 4,
743n/a 5
887817 ],
988213 "type": "integer"
1087817}
PdfLayoutEnum3 of 3 keywords
178217{
278217 "enum": [
3602n/a 0,
434n/a 1,
542n/a 2,
643n/a 3,
761n/a 4
878217 ],
978712 "type": "integer"
1078217}
PermissionSetRequest9 of 9 keywords
11284114{
2121294 "properties": {
3123949 "groups": {
4117928 "items": {
552232 "type": "integer"
6117928 },
71288n/a "nullable": true,
8126721 "type": "array"
9123949 },
10120845 "users": {
11113129 "items": {
1231736 "type": "integer"
13113129 },
141253n/a "nullable": true,
15123716 "type": "array"
16120845 }
17121294 },
18137820 "type": "object"
191284114}
SetPermissionsRequest5 of 5 keywords
1716122{
2618112 "properties": {
365157 "change": {
465157 "$ref": "#/components/schemas/PermissionSetRequest"
565157 },
663357 "view": {
763357 "$ref": "#/components/schemas/PermissionSetRequest"
863357 }
9618112 },
1082810 "type": "object"
11716122}
application/x-www-form-urlencoded83 / 98
MailRuleRequest
1849883{
2858874 "properties": {
3164371 "account": {
4164371 "type": "integer"
5164371 },
665018 "action": {
71n/a "allOf": [
865018 {
965018 "$ref": "#/components/schemas/MailRuleActionEnum"
1065018 }
111n/a ],
126602 "maximum": 9223372036854775807,
136593 "minimum": 0
1465018 },
157573 "action_parameter": {
167573 "minLength": 1,
17760n/a "nullable": true,
18760n/a "type": "string"
197573 },
20122540 "assign_correspondent": {
21662n/a "nullable": true,
22122540 "type": "integer"
23122540 },
2470118 "assign_correspondent_from": {
251n/a "allOf": [
2670118 {
2770118 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
2870118 }
291n/a ],
307082 "maximum": 9223372036854775807,
317073 "minimum": 0
3270118 },
33141492 "assign_document_type": {
34633n/a "nullable": true,
35141492 "type": "integer"
36141492 },
376674 "assign_owner_from_rule": {
386674 "type": "boolean"
396674 },
4038196 "assign_tags": {
4138196 "items": {
421177n/a "nullable": true,
43513664 "type": "integer"
4438196 },
452340 "type": "array"
4638196 },
4760211 "assign_title_from": {
481n/a "allOf": [
4960211 {
5060211 "$ref": "#/components/schemas/AssignTitleFromEnum"
5160211 }
521n/a ],
536052 "maximum": 9223372036854775807,
546052 "minimum": 0
5560211 },
5662110 "attachment_type": {
571n/a "allOf": [
5862110 {
5962110 "$ref": "#/components/schemas/AttachmentTypeEnum"
6062110 }
611n/a ],
626232 "maximum": 9223372036854775807,
636232 "minimum": 0
6462110 },
6560812 "consumption_scope": {
661n/a "allOf": [
6760812 {
6860812 "$ref": "#/components/schemas/ConsumptionScopeEnum"
6960812 }
701n/a ],
716112 "maximum": 9223372036854775807,
726112 "minimum": 0
7360812 },
746504 "enabled": {
756504 "type": "boolean"
766504 },
776443 "filter_attachment_filename_exclude": {
786443 "maxLength": 256,
79647n/a "nullable": true,
80647n/a "type": "string"
816443 },
826012 "filter_attachment_filename_include": {
836012 "maxLength": 256,
84603n/a "nullable": true,
85603n/a "type": "string"
866012 },
875822 "filter_body": {
885822 "maxLength": 256,
89584n/a "nullable": true,
90584n/a "type": "string"
915822 },
926336 "filter_from": {
936336 "maxLength": 256,
94639n/a "nullable": true,
95639n/a "type": "string"
966336 },
976093 "filter_subject": {
986093 "maxLength": 256,
99612n/a "nullable": true,
100612n/a "type": "string"
1016093 },
1025994 "filter_to": {
1035994 "maxLength": 256,
104603n/a "nullable": true,
105603n/a "type": "string"
1065994 },
1076004 "folder": {
1086022 "maxLength": 256,
1096022 "minLength": 1,
110604n/a "type": "string"
1116004 },
11267616 "maximum_age": {
11367913 "format": "int64",
1146793 "maximum": 9223372036854775807,
1156793 "minimum": 0,
11668210 "type": "integer"
11767616 },
118169931 "name": {
119171218 "maxLength": 256,
120171713 "minLength": 1,
1211730n/a "type": "string"
122169931 },
12361612 "order": {
12461612 "type": "integer"
12561612 },
126104469 "owner": {
127573n/a "nullable": true,
128104469 "type": "integer"
129104469 },
13056412 "pdf_layout": {
1311n/a "allOf": [
13256412 {
13356412 "$ref": "#/components/schemas/PdfLayoutEnum"
13456412 }
1351n/a ],
1365664 "maximum": 9223372036854775807,
1375682 "minimum": 0
13856412 },
13901 "set_permissions": {
1400n/a "allOf": [
14101 {
14201 "$ref": "#/components/schemas/SetPermissionsRequest"
14301 }
1440n/a ],
145 "writeOnly": true
14601 },
1475904 "stop_processing": {
1485904 "type": "boolean"
1495904 }
150858874 },
151171220 "required": [
152171418 "account",
15317302 "name"
154171220 ],
1551732n/a "type": "object"
156849883}
Referenced Components (8)18 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
170118{
270118 "enum": [
3446n/a 1,
460n/a 2,
574n/a 3,
6121n/a 4
770118 ],
87109 "type": "integer"
970118}
AssignTitleFromEnum3 of 3 keywords
160211{
260211 "enum": [
3443n/a 1,
473n/a 2,
586n/a 3
660211 ],
76076 "type": "integer"
860211}
AttachmentTypeEnum3 of 3 keywords
162110{
262110 "enum": [
3481n/a 1,
4140n/a 2
562110 ],
66256 "type": "integer"
762110}
ConsumptionScopeEnum3 of 3 keywords
160812{
260812 "enum": [
3444n/a 1,
468n/a 2,
596n/a 3
660812 ],
76137 "type": "integer"
860812}
MailRuleActionEnum3 of 3 keywords
165018{
265018 "enum": [
3460n/a 1,
445n/a 2,
532n/a 3,
658n/a 4,
755n/a 5
865018 ],
96626 "type": "integer"
1065018}
PdfLayoutEnum3 of 3 keywords
156412{
256412 "enum": [
3405n/a 0,
434n/a 1,
550n/a 2,
635n/a 3,
740n/a 4
856412 ],
95706 "type": "integer"
1056412}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
101{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1001 "type": "object"
1101}
multipart/form-data83 / 98
MailRuleRequest
1417877{
2422870 "properties": {
3124141 "account": {
4124141 "type": "integer"
5124141 },
666618 "action": {
71n/a "allOf": [
866618 {
966618 "$ref": "#/components/schemas/MailRuleActionEnum"
1066618 }
111n/a ],
126683 "maximum": 9223372036854775807,
136692 "minimum": 0
1466618 },
156512 "action_parameter": {
166512 "minLength": 1,
17653n/a "nullable": true,
18653n/a "type": "string"
196512 },
2043594 "assign_correspondent": {
21637n/a "nullable": true,
2243594 "type": "integer"
2343594 },
2462516 "assign_correspondent_from": {
251n/a "allOf": [
2662516 {
2762516 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
2862516 }
291n/a ],
306272 "maximum": 9223372036854775807,
316272 "minimum": 0
3262516 },
3362600 "assign_document_type": {
34662n/a "nullable": true,
3562600 "type": "integer"
3662600 },
3766310 "assign_owner_from_rule": {
3866310 "type": "boolean"
3966310 },
4031120 "assign_tags": {
4131120 "items": {
42721n/a "nullable": true,
43365356 "type": "integer"
4431120 },
451510 "type": "array"
4631120 },
4765018 "assign_title_from": {
481n/a "allOf": [
4965018 {
5065018 "$ref": "#/components/schemas/AssignTitleFromEnum"
5165018 }
521n/a ],
536533 "maximum": 9223372036854775807,
546533 "minimum": 0
5565018 },
5661317 "attachment_type": {
571n/a "allOf": [
5861317 {
5961317 "$ref": "#/components/schemas/AttachmentTypeEnum"
6061317 }
611n/a ],
626162 "maximum": 9223372036854775807,
636162 "minimum": 0
6461317 },
6561017 "consumption_scope": {
661n/a "allOf": [
6761017 {
6861017 "$ref": "#/components/schemas/ConsumptionScopeEnum"
6961017 }
701n/a ],
716123 "maximum": 9223372036854775807,
726132 "minimum": 0
7361017 },
7461512 "enabled": {
7561512 "type": "boolean"
7661512 },
776562 "filter_attachment_filename_exclude": {
786562 "maxLength": 256,
79658n/a "nullable": true,
80658n/a "type": "string"
816562 },
826463 "filter_attachment_filename_include": {
836463 "maxLength": 256,
84649n/a "nullable": true,
85649n/a "type": "string"
866463 },
876442 "filter_body": {
886442 "maxLength": 256,
89646n/a "nullable": true,
90646n/a "type": "string"
916442 },
926345 "filter_from": {
936345 "maxLength": 256,
94639n/a "nullable": true,
95639n/a "type": "string"
966345 },
976013 "filter_subject": {
986013 "maxLength": 256,
99604n/a "nullable": true,
100604n/a "type": "string"
1016013 },
1026192 "filter_to": {
1036192 "maxLength": 256,
104621n/a "nullable": true,
105621n/a "type": "string"
1066192 },
1076155 "folder": {
1086182 "maxLength": 256,
1096173 "minLength": 1,
110620n/a "type": "string"
1116155 },
11260616 "maximum_age": {
11360814 "format": "int64",
1146082 "maximum": 9223372036854775807,
1156082 "minimum": 0,
11661012 "type": "integer"
11760616 },
118123456 "name": {
11912828 "maxLength": 256,
120124248 "minLength": 1,
1211290n/a "type": "string"
122123456 },
12358919 "order": {
12458919 "type": "integer"
12558919 },
12638557 "owner": {
127595n/a "nullable": true,
12838557 "type": "integer"
12938557 },
13060616 "pdf_layout": {
1311n/a "allOf": [
13260616 {
13360616 "$ref": "#/components/schemas/PdfLayoutEnum"
13460616 }
1351n/a ],
1366082 "maximum": 9223372036854775807,
1376082 "minimum": 0
13860616 },
1390632 "set_permissions": {
1400n/a "allOf": [
1410632 {
1420632 "$ref": "#/components/schemas/SetPermissionsRequest"
1430632 }
1440n/a ],
145 "writeOnly": true
1460632 },
14759311 "stop_processing": {
14859311 "type": "boolean"
14959311 }
150422870 },
151128014 "required": [
152128212 "account",
15312904 "name"
154128014 ],
1551294n/a "type": "object"
156417877}
Referenced Components (8)18 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
162516{
262516 "enum": [
3539n/a 1,
427n/a 2,
526n/a 3,
633n/a 4
762516 ],
862912 "type": "integer"
962516}
AssignTitleFromEnum3 of 3 keywords
165018{
265018 "enum": [
3532n/a 1,
456n/a 2,
562n/a 3
665018 ],
765612 "type": "integer"
865018}
AttachmentTypeEnum3 of 3 keywords
161317{
261317 "enum": [
3559n/a 1,
454n/a 2
561317 ],
661812 "type": "integer"
761317}
ConsumptionScopeEnum3 of 3 keywords
161017{
261017 "enum": [
3522n/a 1,
440n/a 2,
548n/a 3
661017 ],
761512 "type": "integer"
861017}
MailRuleActionEnum3 of 3 keywords
166618{
266618 "enum": [
3540n/a 1,
433n/a 2,
521n/a 3,
637n/a 4,
735n/a 5
866618 ],
967113 "type": "integer"
1066618}
PdfLayoutEnum3 of 3 keywords
160616{
260616 "enum": [
3491n/a 0,
436n/a 1,
542n/a 2,
622n/a 3,
715n/a 4
860616 ],
961012 "type": "integer"
1060616}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10632{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100632 "type": "object"
110632}
Responses1 of 1 documented received
codedescriptionhitsavg
2018314ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request53885ms
41523ms
401Unauthorized875ms
500Internal Server Error48ms
Examples3 / 3 used
Body: application/json
""MailRuleRequest.action_parameter
Body: application/x-www-form-urlencoded
""MailRuleRequest.action_parameter
Body: multipart/form-data
""MailRuleRequest.action_parameter
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
128524{
228524 "type": "integer"
328524}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body5212ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2123ms
401Unauthorized457ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
161539{
261539 "type": "integer"
361539}
Responses1 of 1 documented received
codedescriptionhitsavg
2002935ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2923ms
401Unauthorized695ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1153216{
2153216 "type": "integer"
3153216}
Body261 of 291 keywords covered
application/json97 / 97
PatchedMailRuleRequest
1383228{
2216222 "properties": {
33416 "account": {
43416 "type": "integer"
53416 },
63288 "action": {
71n/a "allOf": [
83288 {
93288 "$ref": "#/components/schemas/MailRuleActionEnum"
103288 }
111n/a ],
123301 "maximum": 9223372036854775807,
133301 "minimum": 0
143288 },
153426 "action_parameter": {
163312 "minLength": 1,
17348n/a "nullable": true,
183444 "type": "string"
193426 },
203345 "assign_correspondent": {
21339n/a "nullable": true,
223345 "type": "integer"
233345 },
243358 "assign_correspondent_from": {
251n/a "allOf": [
263358 {
273358 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
283358 }
291n/a ],
303371 "maximum": 9223372036854775807,
313371 "minimum": 0
323358 },
333275 "assign_document_type": {
34332n/a "nullable": true,
353275 "type": "integer"
363275 },
373305 "assign_owner_from_rule": {
383305 "type": "boolean"
393305 },
4033510 "assign_tags": {
413355 "items": {
42257n/a "nullable": true,
432525 "type": "integer"
443355 },
453405 "type": "array"
4633510 },
473268 "assign_title_from": {
481n/a "allOf": [
493268 {
503268 "$ref": "#/components/schemas/AssignTitleFromEnum"
513268 }
521n/a ],
533281 "maximum": 9223372036854775807,
543281 "minimum": 0
553268 },
563358 "attachment_type": {
571n/a "allOf": [
583358 {
593358 "$ref": "#/components/schemas/AttachmentTypeEnum"
603358 }
611n/a ],
623371 "maximum": 9223372036854775807,
633371 "minimum": 0
643358 },
653308 "consumption_scope": {
661n/a "allOf": [
673308 {
683308 "$ref": "#/components/schemas/ConsumptionScopeEnum"
693308 }
701n/a ],
713321 "maximum": 9223372036854775807,
723321 "minimum": 0
733308 },
743235 "enabled": {
753235 "type": "boolean"
763235 },
773275 "filter_attachment_filename_exclude": {
783181 "maxLength": 256,
79332n/a "nullable": true,
803284 "type": "string"
813275 },
823315 "filter_attachment_filename_include": {
833231 "maxLength": 256,
84336n/a "nullable": true,
853324 "type": "string"
863315 },
873305 "filter_body": {
883251 "maxLength": 256,
89335n/a "nullable": true,
903314 "type": "string"
913305 },
923145 "filter_from": {
933081 "maxLength": 256,
94319n/a "nullable": true,
953154 "type": "string"
963145 },
973225 "filter_subject": {
983091 "maxLength": 256,
99327n/a "nullable": true,
1003234 "type": "string"
1013225 },
1023196 "filter_to": {
1033041 "maxLength": 256,
104325n/a "nullable": true,
1053205 "type": "string"
1063196 },
1073137 "folder": {
1083141 "maxLength": 256,
1093141 "minLength": 1,
1103155 "type": "string"
1113137 },
11230611 "maximum_age": {
11330710 "format": "int64",
1143084 "maximum": 9223372036854775807,
1153111 "minimum": 0,
1163116 "type": "integer"
11730611 },
1183127 "name": {
1193131 "maxLength": 256,
1203131 "minLength": 1,
1213145 "type": "string"
1223127 },
1233226 "order": {
1243226 "type": "integer"
1253226 },
1263095 "owner": {
127314n/a "nullable": true,
1283095 "type": "integer"
1293095 },
1303168 "pdf_layout": {
1311n/a "allOf": [
1323168 {
1333168 "$ref": "#/components/schemas/PdfLayoutEnum"
1343168 }
1351n/a ],
1363181 "maximum": 9223372036854775807,
1373181 "minimum": 0
1383168 },
13926261 "set_permissions": {
1401n/a "allOf": [
14126261 {
14226261 "$ref": "#/components/schemas/SetPermissionsRequest"
14326261 }
1441n/a ],
145 "writeOnly": true
14626261 },
1473125 "stop_processing": {
1483125 "type": "boolean"
1493125 }
150216222 },
1516056 "type": "object"
152383228}
Referenced Components (8)32 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
13358{
23358 "enum": [
3322n/a 1,
47n/a 2,
55n/a 3,
61n/a 4
73358 ],
83376 "type": "integer"
93358}
AssignTitleFromEnum3 of 3 keywords
13268{
23268 "enum": [
3303n/a 1,
43n/a 2,
520n/a 3
63268 ],
73286 "type": "integer"
83268}
AttachmentTypeEnum3 of 3 keywords
13358{
23358 "enum": [
3324n/a 1,
411n/a 2
53358 ],
63376 "type": "integer"
73358}
ConsumptionScopeEnum3 of 3 keywords
13308{
23308 "enum": [
3300n/a 1,
419n/a 2,
511n/a 3
63308 ],
73326 "type": "integer"
83308}
MailRuleActionEnum3 of 3 keywords
13288{
23288 "enum": [
3312n/a 1,
49n/a 2,
53n/a 3,
62n/a 4,
72n/a 5
83288 ],
93306 "type": "integer"
103288}
PdfLayoutEnum3 of 3 keywords
13168{
23168 "enum": [
3291n/a 0,
43n/a 1,
52n/a 2,
69n/a 3,
711n/a 4
83168 ],
93186 "type": "integer"
103168}
PermissionSetRequest9 of 9 keywords
154757{
253347 "properties": {
355322 "groups": {
454614 "items": {
51916 "type": "integer"
654614 },
7575n/a "nullable": true,
85678 "type": "array"
955322 },
1055225 "users": {
1154715 "items": {
12317 "type": "integer"
1354715 },
14577n/a "nullable": true,
1556710 "type": "array"
1655225 }
1753347 },
1859410 "type": "object"
1954757}
SetPermissionsRequest5 of 5 keywords
126261{
225156 "properties": {
327728 "change": {
427728 "$ref": "#/components/schemas/PermissionSetRequest"
527728 },
627029 "view": {
727029 "$ref": "#/components/schemas/PermissionSetRequest"
827029 }
925156 },
103185 "type": "object"
1126261}
application/x-www-form-urlencoded82 / 97
PatchedMailRuleRequest
179234{
262234 "properties": {
32103 "account": {
42103 "type": "integer"
52103 },
62177 "action": {
71n/a "allOf": [
82177 {
92177 "$ref": "#/components/schemas/MailRuleActionEnum"
102177 }
111n/a ],
122181 "maximum": 9223372036854775807,
132181 "minimum": 0
142177 },
152131 "action_parameter": {
162131 "minLength": 1,
17214n/a "nullable": true,
18214n/a "type": "string"
192131 },
2018205 "assign_correspondent": {
21223n/a "nullable": true,
2218205 "type": "integer"
2318205 },
242085 "assign_correspondent_from": {
251n/a "allOf": [
262085 {
272085 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
282085 }
291n/a ],
302091 "maximum": 9223372036854775807,
312091 "minimum": 0
322085 },
3313200 "assign_document_type": {
34213n/a "nullable": true,
3513200 "type": "integer"
3613200 },
372122 "assign_owner_from_rule": {
382122 "type": "boolean"
392122 },
40218 "assign_tags": {
41218 "items": {
4287n/a "nullable": true,
433750 "type": "integer"
44218 },
45200 "type": "array"
46218 },
472056 "assign_title_from": {
481n/a "allOf": [
492056 {
502056 "$ref": "#/components/schemas/AssignTitleFromEnum"
512056 }
521n/a ],
532071 "maximum": 9223372036854775807,
542071 "minimum": 0
552056 },
562105 "attachment_type": {
571n/a "allOf": [
582105 {
592105 "$ref": "#/components/schemas/AttachmentTypeEnum"
602105 }
611n/a ],
622111 "maximum": 9223372036854775807,
632111 "minimum": 0
642105 },
652116 "consumption_scope": {
661n/a "allOf": [
672116 {
682116 "$ref": "#/components/schemas/ConsumptionScopeEnum"
692116 }
701n/a ],
712122 "maximum": 9223372036854775807,
722131 "minimum": 0
732116 },
742152 "enabled": {
752152 "type": "boolean"
762152 },
772061 "filter_attachment_filename_exclude": {
782061 "maxLength": 256,
79207n/a "nullable": true,
80207n/a "type": "string"
812061 },
822171 "filter_attachment_filename_include": {
832171 "maxLength": 256,
84218n/a "nullable": true,
85218n/a "type": "string"
862171 },
872151 "filter_body": {
882151 "maxLength": 256,
89216n/a "nullable": true,
90216n/a "type": "string"
912151 },
922062 "filter_from": {
932062 "maxLength": 256,
94208n/a "nullable": true,
95208n/a "type": "string"
962062 },
972001 "filter_subject": {
982001 "maxLength": 256,
99201n/a "nullable": true,
100201n/a "type": "string"
1012001 },
1021981 "filter_to": {
1031981 "maxLength": 256,
104199n/a "nullable": true,
105199n/a "type": "string"
1061981 },
1071933 "folder": {
1081942 "maxLength": 256,
1091951 "minLength": 1,
110196n/a "type": "string"
1111933 },
1121905 "maximum_age": {
1131914 "format": "int64",
1141911 "maximum": 9223372036854775807,
1151911 "minimum": 0,
1161923 "type": "integer"
1171905 },
1182079 "name": {
1192088 "maxLength": 256,
1202151 "minLength": 1,
121216n/a "type": "string"
1222079 },
1231874 "order": {
1241874 "type": "integer"
1251874 },
12611186 "owner": {
127197n/a "nullable": true,
12811186 "type": "integer"
12911186 },
1301875 "pdf_layout": {
1311n/a "allOf": [
1321875 {
1331875 "$ref": "#/components/schemas/PdfLayoutEnum"
1341875 }
1351n/a ],
1361881 "maximum": 9223372036854775807,
1371881 "minimum": 0
1381875 },
13900 "set_permissions": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/SetPermissionsRequest"
14300 }
1440n/a ],
145 "writeOnly": true
14600 },
1471942 "stop_processing": {
1481942 "type": "boolean"
1491942 }
15062234 },
151313n/a "type": "object"
15279234}
Referenced Components (8)18 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
12085{
22085 "enum": [
3195n/a 1,
46n/a 2,
55n/a 3,
62n/a 4
72085 ],
82103 "type": "integer"
92085}
AssignTitleFromEnum3 of 3 keywords
12056{
22056 "enum": [
3192n/a 1,
48n/a 2,
55n/a 3
62056 ],
72083 "type": "integer"
82056}
AttachmentTypeEnum3 of 3 keywords
12105{
22105 "enum": [
3198n/a 1,
412n/a 2
52105 ],
62123 "type": "integer"
72105}
ConsumptionScopeEnum3 of 3 keywords
12116{
22116 "enum": [
3195n/a 1,
410n/a 2,
56n/a 3
62116 ],
72143 "type": "integer"
82116}
MailRuleActionEnum3 of 3 keywords
12177{
22177 "enum": [
3194n/a 1,
46n/a 2,
55n/a 3,
68n/a 4,
74n/a 5
82177 ],
92195 "type": "integer"
102177}
PdfLayoutEnum3 of 3 keywords
11875{
21875 "enum": [
3175n/a 0,
43n/a 1,
53n/a 2,
62n/a 3,
74n/a 4
81875 ],
91893 "type": "integer"
101875}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data82 / 97
PatchedMailRuleRequest
190300{
248300 "properties": {
32746 "account": {
42746 "type": "integer"
52746 },
62668 "action": {
71n/a "allOf": [
82668 {
92668 "$ref": "#/components/schemas/MailRuleActionEnum"
102668 }
111n/a ],
122671 "maximum": 9223372036854775807,
132671 "minimum": 0
142668 },
152761 "action_parameter": {
162761 "minLength": 1,
17277n/a "nullable": true,
18277n/a "type": "string"
192761 },
203270 "assign_correspondent": {
21273n/a "nullable": true,
223270 "type": "integer"
233270 },
242628 "assign_correspondent_from": {
251n/a "allOf": [
262628 {
272628 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
282628 }
291n/a ],
302631 "maximum": 9223372036854775807,
312631 "minimum": 0
322628 },
331263 "assign_document_type": {
34264n/a "nullable": true,
351263 "type": "integer"
361263 },
372605 "assign_owner_from_rule": {
382605 "type": "boolean"
392605 },
40317 "assign_tags": {
41317 "items": {
4233n/a "nullable": true,
431419 "type": "integer"
44317 },
45200 "type": "array"
46317 },
472648 "assign_title_from": {
481n/a "allOf": [
492648 {
502648 "$ref": "#/components/schemas/AssignTitleFromEnum"
512648 }
521n/a ],
532651 "maximum": 9223372036854775807,
542651 "minimum": 0
552648 },
562678 "attachment_type": {
571n/a "allOf": [
582678 {
592678 "$ref": "#/components/schemas/AttachmentTypeEnum"
602678 }
611n/a ],
622681 "maximum": 9223372036854775807,
632681 "minimum": 0
642678 },
652578 "consumption_scope": {
661n/a "allOf": [
672578 {
682578 "$ref": "#/components/schemas/ConsumptionScopeEnum"
692578 }
701n/a ],
712581 "maximum": 9223372036854775807,
722581 "minimum": 0
732578 },
742565 "enabled": {
752565 "type": "boolean"
762565 },
772611 "filter_attachment_filename_exclude": {
782611 "maxLength": 256,
79262n/a "nullable": true,
80262n/a "type": "string"
812611 },
822551 "filter_attachment_filename_include": {
832551 "maxLength": 256,
84256n/a "nullable": true,
85256n/a "type": "string"
862551 },
872621 "filter_body": {
882621 "maxLength": 256,
89263n/a "nullable": true,
90263n/a "type": "string"
912621 },
922771 "filter_from": {
932771 "maxLength": 256,
94278n/a "nullable": true,
95278n/a "type": "string"
962771 },
972631 "filter_subject": {
982631 "maxLength": 256,
99264n/a "nullable": true,
100264n/a "type": "string"
1012631 },
1022591 "filter_to": {
1032591 "maxLength": 256,
104260n/a "nullable": true,
105260n/a "type": "string"
1062591 },
1072532 "folder": {
1082541 "maxLength": 256,
1092541 "minLength": 1,
110255n/a "type": "string"
1112532 },
1122498 "maximum_age": {
1132507 "format": "int64",
1142501 "maximum": 9223372036854775807,
1152501 "minimum": 0,
1162516 "type": "integer"
1172498 },
1182522 "name": {
1192531 "maxLength": 256,
1202531 "minLength": 1,
121254n/a "type": "string"
1222522 },
1232547 "order": {
1242547 "type": "integer"
1252547 },
1262256 "owner": {
127258n/a "nullable": true,
1282256 "type": "integer"
1292256 },
1302438 "pdf_layout": {
1311n/a "allOf": [
1322438 {
1332438 "$ref": "#/components/schemas/PdfLayoutEnum"
1342438 }
1351n/a ],
1362441 "maximum": 9223372036854775807,
1372441 "minimum": 0
1382438 },
1390272 "set_permissions": {
1400n/a "allOf": [
1410272 {
1420272 "$ref": "#/components/schemas/SetPermissionsRequest"
1430272 }
1440n/a ],
145 "writeOnly": true
1460272 },
1472415 "stop_processing": {
1482415 "type": "boolean"
1492415 }
15048300 },
151390n/a "type": "object"
15290300}
Referenced Components (8)18 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
12628{
22628 "enum": [
3254n/a 1,
45n/a 2,
51n/a 3,
62n/a 4
72628 ],
82646 "type": "integer"
92628}
AssignTitleFromEnum3 of 3 keywords
12648{
22648 "enum": [
3253n/a 1,
44n/a 2,
57n/a 3
62648 ],
72666 "type": "integer"
82648}
AttachmentTypeEnum3 of 3 keywords
12678{
22678 "enum": [
3256n/a 1,
411n/a 2
52678 ],
62696 "type": "integer"
72678}
ConsumptionScopeEnum3 of 3 keywords
12578{
22578 "enum": [
3249n/a 1,
43n/a 2,
55n/a 3
62578 ],
72596 "type": "integer"
82578}
MailRuleActionEnum3 of 3 keywords
12668{
22668 "enum": [
3256n/a 1,
42n/a 2,
56n/a 3,
61n/a 4,
71n/a 5
82668 ],
92686 "type": "integer"
102668}
PdfLayoutEnum3 of 3 keywords
12438{
22438 "enum": [
3237n/a 0,
42n/a 1,
52n/a 2,
61n/a 3,
71n/a 4
82438 ],
92456 "type": "integer"
102438}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10272{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100272 "type": "object"
110272}
Responses1 of 1 documented received
codedescriptionhitsavg
20025114ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found12214ms
400Bad Request516ms
401Unauthorized2510ms
Examples3 / 3 used
Body: application/json
""PatchedMailRuleRequest.action_parameter
Body: application/x-www-form-urlencoded
""PatchedMailRuleRequest.action_parameter
Body: multipart/form-data
""PatchedMailRuleRequest.action_parameter
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1147919{
2147919 "type": "integer"
3147919}
Body264 of 294 keywords covered
application/json98 / 98
MailRuleRequest
1453231{
2456223 "properties": {
36716 "account": {
46716 "type": "integer"
56716 },
63328 "action": {
71n/a "allOf": [
83328 {
93328 "$ref": "#/components/schemas/MailRuleActionEnum"
103328 }
111n/a ],
123341 "maximum": 9223372036854775807,
133341 "minimum": 0
143328 },
153355 "action_parameter": {
163221 "minLength": 1,
17340n/a "nullable": true,
183364 "type": "string"
193355 },
203355 "assign_correspondent": {
21340n/a "nullable": true,
223355 "type": "integer"
233355 },
243278 "assign_correspondent_from": {
251n/a "allOf": [
263278 {
273278 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
283278 }
291n/a ],
303291 "maximum": 9223372036854775807,
313291 "minimum": 0
323278 },
333305 "assign_document_type": {
34335n/a "nullable": true,
353305 "type": "integer"
363305 },
373265 "assign_owner_from_rule": {
383265 "type": "boolean"
393265 },
4033310 "assign_tags": {
413335 "items": {
42144n/a "nullable": true,
431395 "type": "integer"
443335 },
453385 "type": "array"
4633310 },
473188 "assign_title_from": {
481n/a "allOf": [
493188 {
503188 "$ref": "#/components/schemas/AssignTitleFromEnum"
513188 }
521n/a ],
533201 "maximum": 9223372036854775807,
543201 "minimum": 0
553188 },
563288 "attachment_type": {
571n/a "allOf": [
583288 {
593288 "$ref": "#/components/schemas/AttachmentTypeEnum"
603288 }
611n/a ],
623301 "maximum": 9223372036854775807,
633301 "minimum": 0
643288 },
653238 "consumption_scope": {
661n/a "allOf": [
673238 {
683238 "$ref": "#/components/schemas/ConsumptionScopeEnum"
693238 }
701n/a ],
713251 "maximum": 9223372036854775807,
723251 "minimum": 0
733238 },
743295 "enabled": {
753295 "type": "boolean"
763295 },
773325 "filter_attachment_filename_exclude": {
783181 "maxLength": 256,
79337n/a "nullable": true,
803334 "type": "string"
813325 },
823225 "filter_attachment_filename_include": {
833111 "maxLength": 256,
84327n/a "nullable": true,
853234 "type": "string"
863225 },
873265 "filter_body": {
883151 "maxLength": 256,
89331n/a "nullable": true,
903274 "type": "string"
913265 },
923135 "filter_from": {
933111 "maxLength": 256,
94318n/a "nullable": true,
953144 "type": "string"
963135 },
973145 "filter_subject": {
983081 "maxLength": 256,
99319n/a "nullable": true,
1003154 "type": "string"
1013145 },
1023165 "filter_to": {
1033071 "maxLength": 256,
104321n/a "nullable": true,
1053174 "type": "string"
1063165 },
1073078 "folder": {
1083091 "maxLength": 256,
1093082 "minLength": 1,
1103105 "type": "string"
1113078 },
1123238 "maximum_age": {
1133247 "format": "int64",
1143251 "maximum": 9223372036854775807,
1153251 "minimum": 0,
1163256 "type": "integer"
1173238 },
11866612 "name": {
1196712 "maxLength": 256,
1206685 "minLength": 1,
1216735 "type": "string"
12266612 },
1233116 "order": {
1243116 "type": "integer"
1253116 },
1263175 "owner": {
127322n/a "nullable": true,
1283175 "type": "integer"
1293175 },
1303068 "pdf_layout": {
1311n/a "allOf": [
1323068 {
1333068 "$ref": "#/components/schemas/PdfLayoutEnum"
1343068 }
1351n/a ],
1363081 "maximum": 9223372036854775807,
1373081 "minimum": 0
1383068 },
13926260 "set_permissions": {
1401n/a "allOf": [
14126260 {
14226260 "$ref": "#/components/schemas/SetPermissionsRequest"
14326260 }
1441n/a ],
145 "writeOnly": true
14626260 },
1473115 "stop_processing": {
1483115 "type": "boolean"
1493115 }
150456223 },
1516763 "required": [
1526772 "account",
1536781 "name"
1546763 ],
1556795 "type": "object"
156453231}
Referenced Components (8)32 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
13278{
23278 "enum": [
3309n/a 1,
410n/a 2,
56n/a 3,
62n/a 4
73278 ],
83296 "type": "integer"
93278}
AssignTitleFromEnum3 of 3 keywords
13188{
23188 "enum": [
3305n/a 1,
45n/a 2,
58n/a 3
63188 ],
73206 "type": "integer"
83188}
AttachmentTypeEnum3 of 3 keywords
13288{
23288 "enum": [
3320n/a 1,
48n/a 2
53288 ],
63306 "type": "integer"
73288}
ConsumptionScopeEnum3 of 3 keywords
13238{
23238 "enum": [
3305n/a 1,
48n/a 2,
510n/a 3
63238 ],
73256 "type": "integer"
83238}
MailRuleActionEnum3 of 3 keywords
13328{
23328 "enum": [
3314n/a 1,
44n/a 2,
52n/a 3,
65n/a 4,
77n/a 5
83328 ],
93346 "type": "integer"
103328}
PdfLayoutEnum3 of 3 keywords
13068{
23068 "enum": [
3290n/a 0,
46n/a 1,
55n/a 2,
61n/a 3,
74n/a 4
83068 ],
93086 "type": "integer"
103068}
PermissionSetRequest9 of 9 keywords
154456{
253446 "properties": {
354624 "groups": {
454314 "items": {
5316 "type": "integer"
654314 },
7570n/a "nullable": true,
856010 "type": "array"
954624 },
1055422 "users": {
1154314 "items": {
121516 "type": "integer"
1354314 },
14576n/a "nullable": true,
155688 "type": "array"
1655422 }
1753446 },
1859010 "type": "object"
1954456}
SetPermissionsRequest5 of 5 keywords
126260{
224655 "properties": {
327228 "change": {
427228 "$ref": "#/components/schemas/PermissionSetRequest"
527228 },
627228 "view": {
727228 "$ref": "#/components/schemas/PermissionSetRequest"
827228 }
924655 },
103175 "type": "object"
1126260}
application/x-www-form-urlencoded83 / 98
MailRuleRequest
194243{
294243 "properties": {
33306 "account": {
43306 "type": "integer"
53306 },
62175 "action": {
71n/a "allOf": [
82175 {
92175 "$ref": "#/components/schemas/MailRuleActionEnum"
102175 }
111n/a ],
122181 "maximum": 9223372036854775807,
132181 "minimum": 0
142175 },
152271 "action_parameter": {
162271 "minLength": 1,
17228n/a "nullable": true,
18228n/a "type": "string"
192271 },
206211 "assign_correspondent": {
21217n/a "nullable": true,
226211 "type": "integer"
236211 },
242225 "assign_correspondent_from": {
251n/a "allOf": [
262225 {
272225 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
282225 }
291n/a ],
302231 "maximum": 9223372036854775807,
312231 "minimum": 0
322225 },
3320216 "assign_document_type": {
34236n/a "nullable": true,
3520216 "type": "integer"
3620216 },
372002 "assign_owner_from_rule": {
382002 "type": "boolean"
392002 },
40225 "assign_tags": {
41225 "items": {
42155n/a "nullable": true,
437679 "type": "integer"
44225 },
45270 "type": "array"
46225 },
472196 "assign_title_from": {
481n/a "allOf": [
492196 {
502196 "$ref": "#/components/schemas/AssignTitleFromEnum"
512196 }
521n/a ],
532211 "maximum": 9223372036854775807,
542202 "minimum": 0
552196 },
562035 "attachment_type": {
571n/a "allOf": [
582035 {
592035 "$ref": "#/components/schemas/AttachmentTypeEnum"
602035 }
611n/a ],
622041 "maximum": 9223372036854775807,
632041 "minimum": 0
642035 },
652045 "consumption_scope": {
661n/a "allOf": [
672045 {
682045 "$ref": "#/components/schemas/ConsumptionScopeEnum"
692045 }
701n/a ],
712051 "maximum": 9223372036854775807,
722051 "minimum": 0
732045 },
742102 "enabled": {
752102 "type": "boolean"
762102 },
772021 "filter_attachment_filename_exclude": {
782021 "maxLength": 256,
79203n/a "nullable": true,
80203n/a "type": "string"
812021 },
822211 "filter_attachment_filename_include": {
832211 "maxLength": 256,
84222n/a "nullable": true,
85222n/a "type": "string"
862211 },
872211 "filter_body": {
882211 "maxLength": 256,
89222n/a "nullable": true,
90222n/a "type": "string"
912211 },
921991 "filter_from": {
931991 "maxLength": 256,
94200n/a "nullable": true,
95200n/a "type": "string"
961991 },
971984 "filter_subject": {
981984 "maxLength": 256,
99202n/a "nullable": true,
100202n/a "type": "string"
1011984 },
1022101 "filter_to": {
1032101 "maxLength": 256,
104211n/a "nullable": true,
105211n/a "type": "string"
1062101 },
1071873 "folder": {
1081891 "maxLength": 256,
1091882 "minLength": 1,
110190n/a "type": "string"
1111873 },
1122035 "maximum_age": {
1132044 "format": "int64",
1142041 "maximum": 9223372036854775807,
1152041 "minimum": 0,
1162053 "type": "integer"
1172035 },
1183315 "name": {
1193324 "maxLength": 256,
1203351 "minLength": 1,
121336n/a "type": "string"
1223315 },
1231964 "order": {
1241964 "type": "integer"
1251964 },
1264193 "owner": {
127197n/a "nullable": true,
1284193 "type": "integer"
1294193 },
1301885 "pdf_layout": {
1311n/a "allOf": [
1321885 {
1331885 "$ref": "#/components/schemas/PdfLayoutEnum"
1341885 }
1351n/a ],
1361891 "maximum": 9223372036854775807,
1371891 "minimum": 0
1381885 },
13900 "set_permissions": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/SetPermissionsRequest"
14300 }
1440n/a ],
145 "writeOnly": true
14600 },
1472002 "stop_processing": {
1482002 "type": "boolean"
1492002 }
15094243 },
1513352 "required": [
1523361 "account",
1533361 "name"
1543352 ],
155337n/a "type": "object"
15694243}
Referenced Components (8)18 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
12225{
22225 "enum": [
3195n/a 1,
410n/a 2,
57n/a 3,
610n/a 4
72225 ],
82243 "type": "integer"
92225}
AssignTitleFromEnum3 of 3 keywords
12196{
22196 "enum": [
3206n/a 1,
49n/a 2,
54n/a 3
62196 ],
72223 "type": "integer"
82196}
AttachmentTypeEnum3 of 3 keywords
12035{
22035 "enum": [
3199n/a 1,
44n/a 2
52035 ],
62053 "type": "integer"
72035}
ConsumptionScopeEnum3 of 3 keywords
12045{
22045 "enum": [
3186n/a 1,
412n/a 2,
56n/a 3
62045 ],
72063 "type": "integer"
82045}
MailRuleActionEnum3 of 3 keywords
12175{
22175 "enum": [
3194n/a 1,
48n/a 2,
56n/a 3,
63n/a 4,
76n/a 5
82175 ],
92193 "type": "integer"
102175}
PdfLayoutEnum3 of 3 keywords
11885{
21885 "enum": [
3172n/a 0,
47n/a 1,
56n/a 2,
62n/a 3,
71n/a 4
81885 ],
91903 "type": "integer"
101885}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data83 / 98
MailRuleRequest
189299{
289299 "properties": {
33816 "account": {
43816 "type": "integer"
53816 },
62709 "action": {
71n/a "allOf": [
82709 {
92709 "$ref": "#/components/schemas/MailRuleActionEnum"
102709 }
111n/a ],
122711 "maximum": 9223372036854775807,
132711 "minimum": 0
142709 },
152821 "action_parameter": {
162821 "minLength": 1,
17283n/a "nullable": true,
18283n/a "type": "string"
192821 },
2011270 "assign_correspondent": {
21281n/a "nullable": true,
2211270 "type": "integer"
2311270 },
242648 "assign_correspondent_from": {
251n/a "allOf": [
262648 {
272648 "$ref": "#/components/schemas/AssignCorrespondentFromEnum"
282648 }
291n/a ],
302651 "maximum": 9223372036854775807,
312651 "minimum": 0
322648 },
333271 "assign_document_type": {
34274n/a "nullable": true,
353271 "type": "integer"
363271 },
372735 "assign_owner_from_rule": {
382735 "type": "boolean"
392735 },
40330 "assign_tags": {
41330 "items": {
4297n/a "nullable": true,
434255 "type": "integer"
44330 },
45330 "type": "array"
46330 },
472708 "assign_title_from": {
481n/a "allOf": [
492708 {
502708 "$ref": "#/components/schemas/AssignTitleFromEnum"
512708 }
521n/a ],
532711 "maximum": 9223372036854775807,
542711 "minimum": 0
552708 },
562578 "attachment_type": {
571n/a "allOf": [
582578 {
592578 "$ref": "#/components/schemas/AttachmentTypeEnum"
602578 }
611n/a ],
622581 "maximum": 9223372036854775807,
632581 "minimum": 0
642578 },
652668 "consumption_scope": {
661n/a "allOf": [
672668 {
682668 "$ref": "#/components/schemas/ConsumptionScopeEnum"
692668 }
701n/a ],
712671 "maximum": 9223372036854775807,
722671 "minimum": 0
732668 },
742645 "enabled": {
752645 "type": "boolean"
762645 },
772771 "filter_attachment_filename_exclude": {
782771 "maxLength": 256,
79278n/a "nullable": true,
80278n/a "type": "string"
812771 },
822662 "filter_attachment_filename_include": {
832662 "maxLength": 256,
84268n/a "nullable": true,
85268n/a "type": "string"
862662 },
872711 "filter_body": {
882711 "maxLength": 256,
89272n/a "nullable": true,
90272n/a "type": "string"
912711 },
922711 "filter_from": {
932711 "maxLength": 256,
94272n/a "nullable": true,
95272n/a "type": "string"
962711 },
972691 "filter_subject": {
982691 "maxLength": 256,
99270n/a "nullable": true,
100270n/a "type": "string"
1012691 },
1022641 "filter_to": {
1032641 "maxLength": 256,
104265n/a "nullable": true,
105265n/a "type": "string"
1062641 },
1072622 "folder": {
1082631 "maxLength": 256,
1092631 "minLength": 1,
110264n/a "type": "string"
1112622 },
11226410 "maximum_age": {
1132677 "format": "int64",
1142671 "maximum": 9223372036854775807,
1152653 "minimum": 0,
1162686 "type": "integer"
11726410 },
1183852 "name": {
1193861 "maxLength": 256,
1203861 "minLength": 1,
121387n/a "type": "string"
1223852 },
1232516 "order": {
1242516 "type": "integer"
1252516 },
12610247 "owner": {
127257n/a "nullable": true,
12810247 "type": "integer"
12910247 },
1302508 "pdf_layout": {
1311n/a "allOf": [
1322508 {
1332508 "$ref": "#/components/schemas/PdfLayoutEnum"
1342508 }
1351n/a ],
1362511 "maximum": 9223372036854775807,
1372511 "minimum": 0
1382508 },
1390266 "set_permissions": {
1400n/a "allOf": [
1410266 {
1420266 "$ref": "#/components/schemas/SetPermissionsRequest"
1430266 }
1440n/a ],
145 "writeOnly": true
1460266 },
1472515 "stop_processing": {
1482515 "type": "boolean"
1492515 }
15089299 },
1513862 "required": [
1523871 "account",
1533871 "name"
1543862 ],
155388n/a "type": "object"
15689299}
Referenced Components (8)18 of 32 keywords
AssignCorrespondentFromEnum3 of 3 keywords
12648{
22648 "enum": [
3251n/a 1,
43n/a 2,
59n/a 3,
61n/a 4
72648 ],
82666 "type": "integer"
92648}
AssignTitleFromEnum3 of 3 keywords
12708{
22708 "enum": [
3265n/a 1,
41n/a 2,
54n/a 3
62708 ],
72726 "type": "integer"
82708}
AttachmentTypeEnum3 of 3 keywords
12578{
22578 "enum": [
3252n/a 1,
45n/a 2
52578 ],
62596 "type": "integer"
72578}
ConsumptionScopeEnum3 of 3 keywords
12668{
22668 "enum": [
3253n/a 1,
49n/a 2,
54n/a 3
62668 ],
72686 "type": "integer"
82668}
MailRuleActionEnum3 of 3 keywords
12709{
22709 "enum": [
3258n/a 1,
48n/a 2,
52n/a 3,
61n/a 4,
71n/a 5
82709 ],
92727 "type": "integer"
102709}
PdfLayoutEnum3 of 3 keywords
12508{
22508 "enum": [
3232n/a 0,
48n/a 1,
58n/a 2,
61n/a 3,
71n/a 4
82508 ],
92526 "type": "integer"
102508}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10266{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100266 "type": "object"
110266}
Responses1 of 1 documented received
codedescriptionhitsavg
2006716ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found12703ms
400Bad Request1146ms
401Unauthorized407ms
403Forbidden72ms
Examples3 / 3 used
Body: application/json
""MailRuleRequest.action_parameter
Body: application/x-www-form-urlencoded
""MailRuleRequest.action_parameter
Body: multipart/form-data
""MailRuleRequest.action_parameter
oauth 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses0 of 1 documented received
codedescriptionhitsavg
200No response body0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2093ms
401Unauthorized3342ms
processed_mail 3 operations 2 covered 1 partial 0 uncovered 0 not measured 90% #
Query Parameters5 of 5 keywords covered
ordering1 / 1
#validinvalidschema
11962n/a{
21962n/a "type": "string"
31962n/a}
page1 / 1
11667293{
21667293 "type": "integer"
31667293}
page_size1 / 1
11685319{
21685319 "type": "integer"
31685319}
rule1 / 1
11657316{
21657316 "type": "integer"
31657316}
status1 / 1
11791n/a{
21791n/a "type": "string"
31791n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
20013074ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request18714ms
404Not Found4534ms
401Unauthorized1833ms
Body13 of 15 keywords covered
application/json5 / 5
BulkDeleteMailRequestRequest
#validinvalidschema
129626{
229611 "properties": {
329611 "mail_ids": {
42966 "items": {
51976 "type": "integer"
62966 },
73025 "type": "array"
829611 }
929611 },
1030710 "required": [
1130710 "mail_ids"
1230710 ],
133175 "type": "object"
1429626}
application/x-www-form-urlencoded4 / 5
BulkDeleteMailRequestRequest
14445{
2447 "properties": {
3447 "mail_ids": {
4447 "items": {
513110 "type": "integer"
6447 },
7510 "type": "array"
8447 }
9447 },
105138 "required": [
115138 "mail_ids"
125138 ],
1389n/a "type": "object"
144445}
multipart/form-data4 / 5
BulkDeleteMailRequestRequest
15142{
25111 "properties": {
35111 "mail_ids": {
45111 "items": {
56911 "type": "integer"
65111 },
7620 "type": "array"
85111 }
95111 },
106231 "required": [
116231 "mail_ids"
126231 ],
1393n/a "type": "object"
145142}
Responses2 of 3 documented received
codedescriptionhitsavg
2002944ms
400No response body1393ms
403No response body0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1304ms
500Internal Server Error64ms
41513ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
155458{
255458 "type": "integer"
355458}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5594ms
401Unauthorized532ms
profile 8 operations 7 covered 0 partial 1 uncovered 0 not measured 100% #
Responses1 of 1 documented received
codedescriptionhitsavg
2001863ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3602ms
Body39 of 39 keywords covered
application/json13 / 13
PatchedProfileRequest
#validinvalidschema
115164{
27155 "properties": {
37425 "email": {
47425 "oneOf": [
56138 {
68118 "format": "email",
77920 "type": "string"
86138 },
91386 {
101366 "maxLength": 0,
117920 "type": "string"
121386 }
137425 ]
147425 },
158511 "first_name": {
16854 "maxLength": 150,
17897 "type": "string"
188511 },
196220 "last_name": {
206212 "maxLength": 150,
21748 "type": "string"
226220 },
237020 "password": {
24709 "minLength": 1,
257911 "type": "string"
267020 }
277155 },
282069 "type": "object"
2915164}
application/x-www-form-urlencoded13 / 13
PatchedProfileRequest
111332{
28532 "properties": {
36714 "email": {
46714 "oneOf": [
55427 {
65427 "format": "email",
781n/a "type": "string"
85427 },
91368 {
101368 "maxLength": 0,
1181n/a "type": "string"
121368 }
136714 ]
146714 },
157113 "first_name": {
167113 "maxLength": 150,
1784n/a "type": "string"
187113 },
196812 "last_name": {
206812 "maxLength": 150,
2180n/a "type": "string"
226812 },
236013 "password": {
246013 "minLength": 1,
2573n/a "type": "string"
266013 }
278532 },
28145n/a "type": "object"
2911332}
multipart/form-data13 / 13
PatchedProfileRequest
16810{
24410 "properties": {
3411 "email": {
4411 "oneOf": [
5339 {
6339 "format": "email",
742n/a "type": "string"
8339 },
9834 {
10834 "maxLength": 0,
1142n/a "type": "string"
12834 }
13411 ]
14411 },
15391 "first_name": {
16391 "maxLength": 150,
1740n/a "type": "string"
18391 },
19361 "last_name": {
20361 "maxLength": 150,
2137n/a "type": "string"
22361 },
23337 "password": {
24337 "minLength": 1,
2540n/a "type": "string"
26337 }
274410 },
2878n/a "type": "object"
296810}
Responses1 of 1 documented received
codedescriptionhitsavg
20037618ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1544ms
401Unauthorized437ms
500Internal Server Error38ms
41513ms
Body4 of 4 keywords covered
application/json4 / 4
#validinvalidschema
133599{
233543 "properties": {
333543 "id": {
433543 "type": "integer"
533543 }
633543 },
737847 "required": [
837847 "id"
937847 ],
104259 "type": "object"
1133599}
Responses1 of 2 documented received
codedescriptionhitsavg
2000never seen
4003433ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1244ms
41513ms
401Unauthorized652ms
Expected Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Responses1 of 1 documented received
codedescriptionhitsavg
2002113ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3352ms
Responses1 of 2 documented received
codedescriptionhitsavg
2000never seen
4041643ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3432ms
Responses1 of 1 documented received
codedescriptionhitsavg
20019121ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3253ms
Body5 of 5 keywords covered
application/json5 / 5
#validinvalidschema
1270201{
242433 "properties": {
342827 "code": {
442827 "type": "string"
542827 },
628322 "secret": {
728322 "type": "string"
828322 }
942433 },
10303156 "required": [
11305154 "secret",
124554 "code"
13303156 ],
1445912 "type": "object"
15270201}
Responses1 of 1 documented received
codedescriptionhitsavg
2001373ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3264ms
401Unauthorized436ms
41513ms
400Bad Request263ms
remote_version 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses1 of 1 documented received
codedescriptionhitsavg
200866ms
saved_views 6 operations 3 covered 3 partial 0 uncovered 0 not measured 68% #
Query Parameters4 of 4 keywords covered
full_perms1 / 1
#validinvalidschema
11735201{
21735201 "type": "boolean"
31735201}
ordering1 / 1
11835n/a{
21835n/a "type": "string"
31835n/a}
page1 / 1
11576350{
21576350 "type": "integer"
31576350}
page_size1 / 1
11565316{
21565316 "type": "integer"
31565316}
Responses1 of 1 documented received
codedescriptionhitsavg
20017968ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found18393ms
401Unauthorized1603ms
Body118 of 174 keywords covered
application/json58 / 58
SavedViewRequest
#validinvalidschema
11616527{
21622504 "properties": {
3861n/a "display_fields": {
4861n/a "nullable": true,
5861n/a },
6140329 "display_mode": {
71432n/a "nullable": true,
8140329 "oneOf": [
91611271 {
101611271 "$ref": "#/components/schemas/DisplayModeEnum"
111611271 },
121431289 {
131431289 "$ref": "#/components/schemas/BlankEnum"
141431289 },
151099333 {
161099333 "$ref": "#/components/schemas/NullEnum"
171099333 }
18140329 ],
19140329 },
20203389 "filter_rules": {
21203372 "items": {
22482296 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
23203372 },
24210517 "type": "array"
25203389 },
26135919 "icon": {
27135919 "$ref": "#/components/schemas/IconEnum"
28135919 },
29209726 "name": {
3021026 "maxLength": 128,
3121035 "minLength": 1,
32210815 "type": "string"
33209726 },
34134116 "owner": {
351357n/a "nullable": true,
36134116 "type": "integer"
37134116 },
381248126 "page_size": {
391255119 "format": "int64",
4012583 "maximum": 9223372036854775807,
41125110 "minimum": 1,
421374n/a "nullable": true,
43135618 "type": "integer"
441248126 },
451177192 "set_permissions": {
461n/a "allOf": [
471177192 {
481177192 "$ref": "#/components/schemas/SetPermissionsRequest"
491177192 }
501n/a ],
51 "writeOnly": true
521177192 },
53132919 "sort_field": {
5412393 "maxLength": 128,
551348n/a "nullable": true,
56133216 "type": "string"
57132919 },
58131416 "sort_reverse": {
59131416 "type": "boolean"
60131416 }
611622504 },
6221199 "required": [
6321226 "filter_rules",
6421235 "name"
6521199 ],
66212815 "type": "object"
671616527}
Referenced Components (8)40 of 40 keywords
BlankEnum2 of 2 keywords
11431289{
21431289 "enum": [
3143n/a ""
41431289 ]
51431289}
DisplayModeEnum3 of 3 keywords
11611271{
21611271 "enum": [
350n/a "table",
453n/a "smallCards",
558n/a "largeCards"
61611271 ],
73081124 "type": "string"
81611271}
IconEnum3 of 3 keywords
1135919{
2135919 "enum": [
3676n/a "archive",
435n/a "bank",
525n/a "basket",
611n/a "bell",
78n/a "bookmark",
816n/a "boxes",
98n/a "briefcase",
1014n/a "building",
1110n/a "calculator",
126n/a "calendar",
1311n/a "camera",
1414n/a "card-checklist",
1515n/a "cash",
167n/a "chat-left-text",
1717n/a "check-circle",
1821n/a "clipboard",
198n/a "clock-history",
204n/a "credit-card",
216n/a "download",
2211n/a "envelope",
236n/a "exclamation-triangle",
248n/a "file-earmark",
259n/a "file-earmark-check",
268n/a "file-earmark-lock",
2710n/a "file-earmark-medical",
2816n/a "file-earmark-person",
2920n/a "file-earmark-spreadsheet",
308n/a "file-text",
3114n/a "files",
3212n/a "folder",
335n/a "funnel",
3412n/a "gear",
358n/a "globe2",
3622n/a "hash",
3717n/a "heart",
386n/a "house",
3912n/a "inbox",
4016n/a "journals",
418n/a "list-task",
425n/a "newspaper",
438n/a "paperclip",
4414n/a "people",
4512n/a "person",
467n/a "printer",
4710n/a "receipt",
4821n/a "safe",
4912n/a "search",
5013n/a "send",
519n/a "shop",
526n/a "stack",
536n/a "stars",
5452n/a "tag",
5510n/a "tags",
564n/a "telephone",
578n/a "truck",
5812n/a "upc-scan",
5910n/a "wallet2"
60135919 ],
61136315 "type": "string"
62135919}
NullEnum2 of 2 keywords
11099333{
21099333 "enum": [
31099n/a null
41099333 ]
51099333}
PermissionSetRequest9 of 9 keywords
11966184{
21802152 "properties": {
3178181 "groups": {
4167247 "items": {
545283 "type": "integer"
6167247 },
71862n/a "nullable": true,
8182834 "type": "array"
9178181 },
10181373 "users": {
11168146 "items": {
1258876 "type": "integer"
13168146 },
141886n/a "nullable": true,
15185927 "type": "array"
16181373 }
171802152 },
18211832 "type": "object"
191966184}
RuleTypeEnum3 of 3 keywords
1486532{
2486532 "enum": [
3228n/a 0,
489n/a 1,
597n/a 2,
6128n/a 3,
7117n/a 4,
892n/a 5,
9100n/a 6,
1064n/a 7,
1192n/a 8,
1288n/a 9,
1391n/a 10,
1493n/a 11,
1585n/a 12,
16103n/a 13,
1780n/a 14,
18109n/a 15,
1995n/a 16,
20102n/a 17,
2186n/a 18,
2281n/a 19,
2378n/a 20,
24100n/a 21,
25101n/a 22,
2680n/a 23,
2787n/a 24,
2898n/a 25,
29107n/a 26,
3094n/a 27,
3191n/a 28,
32118n/a 29,
3397n/a 30,
3485n/a 31,
3577n/a 32,
36100n/a 33,
3788n/a 34,
3894n/a 35,
3987n/a 36,
4067n/a 37,
41104n/a 38,
4299n/a 39,
4390n/a 40,
4472n/a 41,
4587n/a 42,
4691n/a 43,
47116n/a 44,
48124n/a 45,
4982n/a 46,
5096n/a 47,
5183n/a 48,
5272n/a 49,
5380n/a 50
54486532 ],
55487918 "type": "integer"
56486532}
SavedViewFilterRuleRequest13 of 13 keywords
1482296{
2482675 "properties": {
3486532 "rule_type": {
41n/a "allOf": [
5486532 {
6486532 "$ref": "#/components/schemas/RuleTypeEnum"
7486532 }
81n/a ],
948766 "maximum": 9223372036854775807,
1048775 "minimum": 0
11486532 },
12250543 "value": {
1313857 "maxLength": 255,
142548n/a "nullable": true,
15251236 "type": "string"
16250543 }
17482675 },
1848976 "required": [
1948976 "rule_type"
2048976 ],
21490315 "type": "object"
22482296}
SetPermissionsRequest5 of 5 keywords
11177192{
2964177 "properties": {
399394 "change": {
499394 "$ref": "#/components/schemas/PermissionSetRequest"
599394 },
697390 "view": {
797390 "$ref": "#/components/schemas/PermissionSetRequest"
897390 }
9964177 },
10135415 "type": "object"
111177192}
application/x-www-form-urlencoded30 / 58
SavedViewRequest
101670{
21341536 "properties": {
3648n/a "display_fields": {
4648n/a "nullable": true,
5648n/a },
6113726 "display_mode": {
71163n/a "nullable": true,
8113726 "oneOf": [
9193970 {
10193970 "$ref": "#/components/schemas/DisplayModeEnum"
11193970 },
121521011 {
131521011 "$ref": "#/components/schemas/BlankEnum"
141521011 },
15792371 {
16792371 "$ref": "#/components/schemas/NullEnum"
17792371 }
18113726 ],
19113726 },
2001041 "filter_rules": {
2101041 "items": {
22018525 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
2301041 },
2410410 "type": "array"
2501041 },
2611224 "icon": {
2711224 "$ref": "#/components/schemas/IconEnum"
2811224 },
29164621 "name": {
30165611 "maxLength": 128,
31165710 "minLength": 1,
321667n/a "type": "string"
33164621 },
34205899 "owner": {
351104n/a "nullable": true,
36205899 "type": "integer"
37205899 },
38992123 "page_size": {
39996119 "format": "int64",
409963 "maximum": 9223372036854775807,
419954 "minimum": 1,
421115n/a "nullable": true,
43999116 "type": "integer"
44992123 },
4502 "set_permissions": {
460n/a "allOf": [
4702 {
4802 "$ref": "#/components/schemas/SetPermissionsRequest"
4902 }
500n/a ],
51 "writeOnly": true
5202 },
5310864 "sort_field": {
5410864 "maxLength": 128,
551090n/a "nullable": true,
561090n/a "type": "string"
5710864 },
5810926 "sort_reverse": {
5910926 "type": "boolean"
6010926 }
611341536 },
621041629 "required": [
631041629 "filter_rules",
6416673 "name"
651041629 ],
661670n/a "type": "object"
6701670}
Referenced Components (8)10 of 40 keywords
BlankEnum2 of 2 keywords
11521011{
21521011 "enum": [
3152n/a ""
41521011 ]
51521011}
DisplayModeEnum3 of 3 keywords
1193970{
2193970 "enum": [
355n/a "table",
474n/a "smallCards",
564n/a "largeCards"
6193970 ],
7371n/a "type": "string"
8193970}
IconEnum3 of 3 keywords
111224{
211224 "enum": [
3478n/a "archive",
416n/a "bank",
516n/a "basket",
615n/a "bell",
714n/a "bookmark",
816n/a "boxes",
97n/a "briefcase",
108n/a "building",
1115n/a "calculator",
127n/a "calendar",
136n/a "camera",
149n/a "card-checklist",
1520n/a "cash",
168n/a "chat-left-text",
1711n/a "check-circle",
188n/a "clipboard",
1918n/a "clock-history",
2017n/a "credit-card",
2118n/a "download",
2213n/a "envelope",
236n/a "exclamation-triangle",
247n/a "file-earmark",
2515n/a "file-earmark-check",
2611n/a "file-earmark-lock",
2712n/a "file-earmark-medical",
2813n/a "file-earmark-person",
297n/a "file-earmark-spreadsheet",
3018n/a "file-text",
3111n/a "files",
3211n/a "folder",
337n/a "funnel",
3412n/a "gear",
358n/a "globe2",
369n/a "hash",
376n/a "heart",
389n/a "house",
3916n/a "inbox",
4011n/a "journals",
417n/a "list-task",
4213n/a "newspaper",
438n/a "paperclip",
446n/a "people",
456n/a "person",
469n/a "printer",
477n/a "receipt",
486n/a "safe",
4913n/a "search",
5015n/a "send",
518n/a "shop",
5213n/a "stack",
5315n/a "stars",
5431n/a "tag",
559n/a "tags",
567n/a "telephone",
5720n/a "truck",
588n/a "upc-scan",
5912n/a "wallet2"
6011224 ],
611126n/a "type": "string"
6211224}
NullEnum2 of 2 keywords
1792371{
2792371 "enum": [
3792n/a null
4792371 ]
5792371}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
RuleTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5,
90n/a 6,
100n/a 7,
110n/a 8,
120n/a 9,
130n/a 10,
140n/a 11,
150n/a 12,
160n/a 13,
170n/a 14,
180n/a 15,
190n/a 16,
200n/a 17,
210n/a 18,
220n/a 19,
230n/a 20,
240n/a 21,
250n/a 22,
260n/a 23,
270n/a 24,
280n/a 25,
290n/a 26,
300n/a 27,
310n/a 28,
320n/a 29,
330n/a 30,
340n/a 31,
350n/a 32,
360n/a 33,
370n/a 34,
380n/a 35,
390n/a 36,
400n/a 37,
410n/a 38,
420n/a 39,
430n/a 40,
440n/a 41,
450n/a 42,
460n/a 43,
470n/a 44,
480n/a 45,
490n/a 46,
500n/a 47,
510n/a 48,
520n/a 49,
530n/a 50
5400 ],
5500 "type": "integer"
5600}
SavedViewFilterRuleRequest0 of 13 keywords
1018525{
200 "properties": {
300 "rule_type": {
40n/a "allOf": [
500 {
600 "$ref": "#/components/schemas/RuleTypeEnum"
700 }
80n/a ],
900 "maximum": 9223372036854775807,
1000 "minimum": 0
1100 },
1200 "value": {
1300 "maxLength": 255,
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "rule_type"
2000 ],
21018525 "type": "object"
22018525}
SetPermissionsRequest0 of 5 keywords
102{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1002 "type": "object"
1102}
multipart/form-data30 / 58
SavedViewRequest
101418{
2641352 "properties": {
3770n/a "display_fields": {
4770n/a "nullable": true,
5770n/a },
6103826 "display_mode": {
71064n/a "nullable": true,
8103826 "oneOf": [
981983 {
1081983 "$ref": "#/components/schemas/DisplayModeEnum"
1181983 },
12116948 {
13116948 "$ref": "#/components/schemas/BlankEnum"
14116948 },
15841223 {
16841223 "$ref": "#/components/schemas/NullEnum"
17841223 }
18103826 ],
19103826 },
200738 "filter_rules": {
210738 "items": {
2203446 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
230738 },
247380 "type": "array"
250738 },
2610634 "icon": {
2710634 "$ref": "#/components/schemas/IconEnum"
2810634 },
29139611 "name": {
3014025 "maxLength": 128,
3114016 "minLength": 1,
321407n/a "type": "string"
33139611 },
34120905 "owner": {
351025n/a "nullable": true,
36120905 "type": "integer"
37120905 },
38951100 "page_size": {
3995497 "format": "int64",
409543 "maximum": 9223372036854775807,
419543 "minimum": 1,
421051n/a "nullable": true,
4395794 "type": "integer"
44951100 },
4501068 "set_permissions": {
460n/a "allOf": [
4701068 {
4801068 "$ref": "#/components/schemas/SetPermissionsRequest"
4901068 }
500n/a ],
51 "writeOnly": true
5201068 },
5310633 "sort_field": {
5410633 "maxLength": 128,
551066n/a "nullable": true,
561066n/a "type": "string"
5710633 },
58102015 "sort_reverse": {
59102015 "type": "boolean"
60102015 }
61641352 },
62737681 "required": [
63738680 "filter_rules",
64140711 "name"
65737681 ],
661418n/a "type": "object"
6701418}
Referenced Components (8)10 of 40 keywords
BlankEnum2 of 2 keywords
1116948{
2116948 "enum": [
3116n/a ""
4116948 ]
5116948}
DisplayModeEnum3 of 3 keywords
181983{
281983 "enum": [
329n/a "table",
425n/a "smallCards",
527n/a "largeCards"
681983 ],
7223n/a "type": "string"
881983}
IconEnum3 of 3 keywords
110634{
210634 "enum": [
3578n/a "archive",
415n/a "bank",
56n/a "basket",
66n/a "bell",
77n/a "bookmark",
87n/a "boxes",
96n/a "briefcase",
109n/a "building",
1110n/a "calculator",
1210n/a "calendar",
1311n/a "camera",
146n/a "card-checklist",
156n/a "cash",
1611n/a "chat-left-text",
1719n/a "check-circle",
185n/a "clipboard",
194n/a "clock-history",
205n/a "credit-card",
214n/a "download",
2220n/a "envelope",
237n/a "exclamation-triangle",
247n/a "file-earmark",
258n/a "file-earmark-check",
266n/a "file-earmark-lock",
2711n/a "file-earmark-medical",
284n/a "file-earmark-person",
295n/a "file-earmark-spreadsheet",
305n/a "file-text",
314n/a "files",
326n/a "folder",
337n/a "funnel",
3412n/a "gear",
357n/a "globe2",
366n/a "hash",
378n/a "heart",
389n/a "house",
394n/a "inbox",
4010n/a "journals",
415n/a "list-task",
4213n/a "newspaper",
435n/a "paperclip",
4410n/a "people",
458n/a "person",
468n/a "printer",
4710n/a "receipt",
488n/a "safe",
497n/a "search",
505n/a "send",
517n/a "shop",
5211n/a "stack",
533n/a "stars",
5439n/a "tag",
559n/a "tags",
5610n/a "telephone",
5722n/a "truck",
588n/a "upc-scan",
594n/a "wallet2"
6010634 ],
611067n/a "type": "string"
6210634}
NullEnum2 of 2 keywords
1841223{
2841223 "enum": [
3841n/a null
4841223 ]
5841223}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
RuleTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5,
90n/a 6,
100n/a 7,
110n/a 8,
120n/a 9,
130n/a 10,
140n/a 11,
150n/a 12,
160n/a 13,
170n/a 14,
180n/a 15,
190n/a 16,
200n/a 17,
210n/a 18,
220n/a 19,
230n/a 20,
240n/a 21,
250n/a 22,
260n/a 23,
270n/a 24,
280n/a 25,
290n/a 26,
300n/a 27,
310n/a 28,
320n/a 29,
330n/a 30,
340n/a 31,
350n/a 32,
360n/a 33,
370n/a 34,
380n/a 35,
390n/a 36,
400n/a 37,
410n/a 38,
420n/a 39,
430n/a 40,
440n/a 41,
450n/a 42,
460n/a 43,
470n/a 44,
480n/a 45,
490n/a 46,
500n/a 47,
510n/a 48,
520n/a 49,
530n/a 50
5400 ],
5500 "type": "integer"
5600}
SavedViewFilterRuleRequest0 of 13 keywords
103446{
200 "properties": {
300 "rule_type": {
40n/a "allOf": [
500 {
600 "$ref": "#/components/schemas/RuleTypeEnum"
700 }
80n/a ],
900 "maximum": 9223372036854775807,
1000 "minimum": 0
1100 },
1200 "value": {
1300 "maxLength": 255,
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "rule_type"
2000 ],
2103446 "type": "object"
2203446}
SetPermissionsRequest0 of 5 keywords
101068{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1001068 "type": "object"
1101068}
Responses1 of 1 documented received
codedescriptionhitsavg
20133814ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request52024ms
401Unauthorized1584ms
500Internal Server Error206ms
41533ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
12038{
22038 "type": "integer"
32038}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body10713ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found674ms
401Unauthorized377ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
16447{
26447 "type": "integer"
36447}
Query Parameters1 of 1 keywords covered
full_perms1 / 1
116627{
216627 "type": "boolean"
316627}
Responses1 of 1 documented received
codedescriptionhitsavg
2003914ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3514ms
404Not Found2254ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1224435{
2224435 "type": "integer"
3224435}
Body115 of 171 keywords covered
application/json57 / 57
PatchedSavedViewRequest
1631294{
2483284 "properties": {
3584n/a "display_fields": {
4584n/a "nullable": true,
5584n/a },
671114 "display_mode": {
7725n/a "nullable": true,
871114 "oneOf": [
930695 {
1030695 "$ref": "#/components/schemas/DisplayModeEnum"
1130695 },
1222703 {
1322703 "$ref": "#/components/schemas/BlankEnum"
1422703 },
1565966 {
1665966 "$ref": "#/components/schemas/NullEnum"
1765966 }
1871114 ],
1971114 },
2060658 "filter_rules": {
2160648 "items": {
2245763 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
2360648 },
2465410 "type": "array"
2560658 },
2663812 "icon": {
2763812 "$ref": "#/components/schemas/IconEnum"
2863812 },
2963614 "name": {
306382 "maxLength": 128,
316382 "minLength": 1,
3264010 "type": "string"
3363614 },
3462511 "owner": {
35636n/a "nullable": true,
3662511 "type": "integer"
3762511 },
3860132 "page_size": {
3960330 "format": "int64",
406052 "maximum": 9223372036854775807,
416034 "minimum": 1,
42633n/a "nullable": true,
4362013 "type": "integer"
4460132 },
45527126 "set_permissions": {
461n/a "allOf": [
47527126 {
48527126 "$ref": "#/components/schemas/SetPermissionsRequest"
49527126 }
501n/a ],
51 "writeOnly": true
52527126 },
5362114 "sort_field": {
546135 "maxLength": 128,
55635n/a "nullable": true,
566269 "type": "string"
5762114 },
5863110 "sort_reverse": {
5963110 "type": "boolean"
6063110 }
61483284 },
6291510 "type": "object"
63631294}
Referenced Components (8)40 of 40 keywords
BlankEnum2 of 2 keywords
122703{
222703 "enum": [
322n/a ""
422703 ]
522703}
DisplayModeEnum3 of 3 keywords
130695{
230695 "enum": [
313n/a "table",
410n/a "smallCards",
57n/a "largeCards"
630695 ],
754671 "type": "string"
830695}
IconEnum3 of 3 keywords
163812{
263812 "enum": [
3452n/a "archive",
42n/a "bank",
52n/a "basket",
62n/a "bell",
72n/a "bookmark",
85n/a "boxes",
94n/a "briefcase",
105n/a "building",
113n/a "calculator",
123n/a "calendar",
132n/a "camera",
143n/a "card-checklist",
153n/a "cash",
163n/a "chat-left-text",
173n/a "check-circle",
187n/a "clipboard",
192n/a "clock-history",
202n/a "credit-card",
212n/a "download",
222n/a "envelope",
233n/a "exclamation-triangle",
242n/a "file-earmark",
2515n/a "file-earmark-check",
2613n/a "file-earmark-lock",
272n/a "file-earmark-medical",
283n/a "file-earmark-person",
292n/a "file-earmark-spreadsheet",
302n/a "file-text",
312n/a "files",
322n/a "folder",
3310n/a "funnel",
342n/a "gear",
352n/a "globe2",
362n/a "hash",
372n/a "heart",
382n/a "house",
392n/a "inbox",
402n/a "journals",
413n/a "list-task",
424n/a "newspaper",
432n/a "paperclip",
442n/a "people",
454n/a "person",
462n/a "printer",
472n/a "receipt",
484n/a "safe",
492n/a "search",
502n/a "send",
512n/a "shop",
522n/a "stack",
532n/a "stars",
5416n/a "tag",
552n/a "tags",
562n/a "telephone",
572n/a "truck",
582n/a "upc-scan",
592n/a "wallet2"
6063812 ],
6164010 "type": "string"
6263812}
NullEnum2 of 2 keywords
165966{
265966 "enum": [
3659n/a null
465966 ]
565966}
PermissionSetRequest9 of 9 keywords
11040113{
2102593 "properties": {
3105649 "groups": {
4104433 "items": {
54139 "type": "integer"
6104433 },
71105n/a "nullable": true,
8108916 "type": "array"
9105649 },
10106147 "users": {
11104128 "items": {
122132 "type": "integer"
13104128 },
141108n/a "nullable": true,
15108919 "type": "array"
16106147 }
17102593 },
18113320 "type": "object"
191040113}
RuleTypeEnum3 of 3 keywords
149117{
249117 "enum": [
345n/a 0,
49n/a 1,
514n/a 2,
631n/a 3,
713n/a 4,
86n/a 5,
912n/a 6,
1013n/a 7,
1110n/a 8,
129n/a 9,
135n/a 10,
147n/a 11,
155n/a 12,
167n/a 13,
172n/a 14,
183n/a 15,
195n/a 16,
206n/a 17,
213n/a 18,
2213n/a 19,
232n/a 20,
2412n/a 21,
258n/a 22,
264n/a 23,
277n/a 24,
2812n/a 25,
292n/a 26,
308n/a 27,
3122n/a 28,
3210n/a 29,
339n/a 30,
344n/a 31,
357n/a 32,
3613n/a 33,
374n/a 34,
387n/a 35,
398n/a 36,
4020n/a 37,
4119n/a 38,
424n/a 39,
4310n/a 40,
4414n/a 41,
4510n/a 42,
465n/a 43,
476n/a 44,
4811n/a 45,
493n/a 46,
508n/a 47,
514n/a 48,
5216n/a 49,
534n/a 50
5449117 ],
5549612 "type": "integer"
5649117}
SavedViewFilterRuleRequest13 of 13 keywords
145763{
245951 "properties": {
349117 "rule_type": {
41n/a "allOf": [
549117 {
649117 "$ref": "#/components/schemas/RuleTypeEnum"
749117 }
81n/a ],
94962 "maximum": 9223372036854775807,
104953 "minimum": 0
1149117 },
1230234 "value": {
132202 "maxLength": 255,
14336n/a "nullable": true,
1530432 "type": "string"
1630234 }
1745951 },
185082 "required": [
195082 "rule_type"
205082 ],
2151010 "type": "object"
2245763}
SetPermissionsRequest5 of 5 keywords
1527126{
2475112 "properties": {
352458 "change": {
452458 "$ref": "#/components/schemas/PermissionSetRequest"
552458 },
651655 "view": {
751655 "$ref": "#/components/schemas/PermissionSetRequest"
851655 }
9475112 },
1063914 "type": "object"
11527126}
application/x-www-form-urlencoded29 / 57
PatchedSavedViewRequest
168553{
244553 "properties": {
3438n/a "display_fields": {
4438n/a "nullable": true,
5438n/a },
648119 "display_mode": {
7500n/a "nullable": true,
848119 "oneOf": [
929471 {
1029471 "$ref": "#/components/schemas/DisplayModeEnum"
1129471 },
1218482 {
1318482 "$ref": "#/components/schemas/BlankEnum"
1418482 },
1543466 {
1643466 "$ref": "#/components/schemas/NullEnum"
1743466 }
1848119 ],
1948119 },
200219 "filter_rules": {
210219 "items": {
2201695 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
230219 },
242190 "type": "array"
250219 },
265339 "icon": {
275339 "$ref": "#/components/schemas/IconEnum"
285339 },
2951815 "name": {
305267 "maxLength": 128,
315258 "minLength": 1,
32533n/a "type": "string"
3351815 },
3429464 "owner": {
35493n/a "nullable": true,
3629464 "type": "integer"
3729464 },
3845327 "page_size": {
3945525 "format": "int64",
404552 "maximum": 9223372036854775807,
414552 "minimum": 1,
42480n/a "nullable": true,
4345723 "type": "integer"
4445327 },
4501 "set_permissions": {
460n/a "allOf": [
4701 {
4801 "$ref": "#/components/schemas/SetPermissionsRequest"
4901 }
500n/a ],
51 "writeOnly": true
5201 },
534726 "sort_field": {
544726 "maxLength": 128,
55478n/a "nullable": true,
56478n/a "type": "string"
574726 },
584774 "sort_reverse": {
594774 "type": "boolean"
604774 }
6144553 },
62621n/a "type": "object"
6368553}
Referenced Components (8)10 of 40 keywords
BlankEnum2 of 2 keywords
118482{
218482 "enum": [
318n/a ""
418482 ]
518482}
DisplayModeEnum3 of 3 keywords
129471{
229471 "enum": [
34n/a "table",
49n/a "smallCards",
516n/a "largeCards"
629471 ],
766n/a "type": "string"
829471}
IconEnum3 of 3 keywords
15339{
25339 "enum": [
3323n/a "archive",
42n/a "bank",
52n/a "basket",
62n/a "bell",
750n/a "bookmark",
83n/a "boxes",
93n/a "briefcase",
102n/a "building",
112n/a "calculator",
122n/a "calendar",
133n/a "camera",
142n/a "card-checklist",
152n/a "cash",
169n/a "chat-left-text",
173n/a "check-circle",
182n/a "clipboard",
192n/a "clock-history",
203n/a "credit-card",
212n/a "download",
222n/a "envelope",
232n/a "exclamation-triangle",
243n/a "file-earmark",
253n/a "file-earmark-check",
262n/a "file-earmark-lock",
272n/a "file-earmark-medical",
282n/a "file-earmark-person",
295n/a "file-earmark-spreadsheet",
304n/a "file-text",
312n/a "files",
322n/a "folder",
332n/a "funnel",
343n/a "gear",
352n/a "globe2",
362n/a "hash",
373n/a "heart",
382n/a "house",
392n/a "inbox",
402n/a "journals",
413n/a "list-task",
422n/a "newspaper",
436n/a "paperclip",
442n/a "people",
453n/a "person",
462n/a "printer",
472n/a "receipt",
482n/a "safe",
492n/a "search",
504n/a "send",
519n/a "shop",
523n/a "stack",
532n/a "stars",
549n/a "tag",
552n/a "tags",
562n/a "telephone",
572n/a "truck",
586n/a "upc-scan",
594n/a "wallet2"
605339 ],
61542n/a "type": "string"
625339}
NullEnum2 of 2 keywords
143466{
243466 "enum": [
3434n/a null
443466 ]
543466}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
RuleTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5,
90n/a 6,
100n/a 7,
110n/a 8,
120n/a 9,
130n/a 10,
140n/a 11,
150n/a 12,
160n/a 13,
170n/a 14,
180n/a 15,
190n/a 16,
200n/a 17,
210n/a 18,
220n/a 19,
230n/a 20,
240n/a 21,
250n/a 22,
260n/a 23,
270n/a 24,
280n/a 25,
290n/a 26,
300n/a 27,
310n/a 28,
320n/a 29,
330n/a 30,
340n/a 31,
350n/a 32,
360n/a 33,
370n/a 34,
380n/a 35,
390n/a 36,
400n/a 37,
410n/a 38,
420n/a 39,
430n/a 40,
440n/a 41,
450n/a 42,
460n/a 43,
470n/a 44,
480n/a 45,
490n/a 46,
500n/a 47,
510n/a 48,
520n/a 49,
530n/a 50
5400 ],
5500 "type": "integer"
5600}
SavedViewFilterRuleRequest0 of 13 keywords
101695{
200 "properties": {
300 "rule_type": {
40n/a "allOf": [
500 {
600 "$ref": "#/components/schemas/RuleTypeEnum"
700 }
80n/a ],
900 "maximum": 9223372036854775807,
1000 "minimum": 0
1100 },
1200 "value": {
1300 "maxLength": 255,
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "rule_type"
2000 ],
2101695 "type": "object"
2201695}
SetPermissionsRequest0 of 5 keywords
101{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1001 "type": "object"
1101}
multipart/form-data29 / 57
PatchedSavedViewRequest
134538{
223538 "properties": {
3508n/a "display_fields": {
4508n/a "nullable": true,
5508n/a },
651917 "display_mode": {
7536n/a "nullable": true,
851917 "oneOf": [
918518 {
1018518 "$ref": "#/components/schemas/DisplayModeEnum"
1118518 },
1214522 {
1314522 "$ref": "#/components/schemas/BlankEnum"
1414522 },
1548749 {
1648749 "$ref": "#/components/schemas/NullEnum"
1748749 }
1851917 ],
1951917 },
200166 "filter_rules": {
210166 "items": {
220235 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
230166 },
241660 "type": "array"
250166 },
265273 "icon": {
275273 "$ref": "#/components/schemas/IconEnum"
285273 },
295277 "name": {
305295 "maxLength": 128,
315322 "minLength": 1,
32534n/a "type": "string"
335277 },
349518 "owner": {
35527n/a "nullable": true,
369518 "type": "integer"
379518 },
3850519 "page_size": {
3950717 "format": "int64",
405072 "maximum": 9223372036854775807,
415072 "minimum": 1,
42524n/a "nullable": true,
4350915 "type": "integer"
4450519 },
450523 "set_permissions": {
460n/a "allOf": [
470523 {
480523 "$ref": "#/components/schemas/SetPermissionsRequest"
490523 }
500n/a ],
51 "writeOnly": true
520523 },
535153 "sort_field": {
545153 "maxLength": 128,
55518n/a "nullable": true,
56518n/a "type": "string"
575153 },
5850810 "sort_reverse": {
5950810 "type": "boolean"
6050810 }
6123538 },
62572n/a "type": "object"
6334538}
Referenced Components (8)10 of 40 keywords
BlankEnum2 of 2 keywords
114522{
214522 "enum": [
314n/a ""
414522 ]
514522}
DisplayModeEnum3 of 3 keywords
118518{
218518 "enum": [
34n/a "table",
47n/a "smallCards",
57n/a "largeCards"
618518 ],
749n/a "type": "string"
818518}
IconEnum3 of 3 keywords
15273{
25273 "enum": [
3390n/a "archive",
42n/a "bank",
53n/a "basket",
62n/a "bell",
72n/a "bookmark",
82n/a "boxes",
93n/a "briefcase",
102n/a "building",
112n/a "calculator",
122n/a "calendar",
132n/a "camera",
143n/a "card-checklist",
152n/a "cash",
162n/a "chat-left-text",
173n/a "check-circle",
184n/a "clipboard",
194n/a "clock-history",
202n/a "credit-card",
212n/a "download",
222n/a "envelope",
232n/a "exclamation-triangle",
242n/a "file-earmark",
252n/a "file-earmark-check",
264n/a "file-earmark-lock",
272n/a "file-earmark-medical",
282n/a "file-earmark-person",
292n/a "file-earmark-spreadsheet",
302n/a "file-text",
312n/a "files",
322n/a "folder",
333n/a "funnel",
342n/a "gear",
353n/a "globe2",
362n/a "hash",
372n/a "heart",
382n/a "house",
393n/a "inbox",
402n/a "journals",
412n/a "list-task",
422n/a "newspaper",
432n/a "paperclip",
443n/a "people",
454n/a "person",
463n/a "printer",
472n/a "receipt",
482n/a "safe",
492n/a "search",
502n/a "send",
512n/a "shop",
524n/a "stack",
532n/a "stars",
548n/a "tag",
552n/a "tags",
562n/a "telephone",
572n/a "truck",
582n/a "upc-scan",
592n/a "wallet2"
605273 ],
61530n/a "type": "string"
625273}
NullEnum2 of 2 keywords
148749{
248749 "enum": [
3487n/a null
448749 ]
548749}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
RuleTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5,
90n/a 6,
100n/a 7,
110n/a 8,
120n/a 9,
130n/a 10,
140n/a 11,
150n/a 12,
160n/a 13,
170n/a 14,
180n/a 15,
190n/a 16,
200n/a 17,
210n/a 18,
220n/a 19,
230n/a 20,
240n/a 21,
250n/a 22,
260n/a 23,
270n/a 24,
280n/a 25,
290n/a 26,
300n/a 27,
310n/a 28,
320n/a 29,
330n/a 30,
340n/a 31,
350n/a 32,
360n/a 33,
370n/a 34,
380n/a 35,
390n/a 36,
400n/a 37,
410n/a 38,
420n/a 39,
430n/a 40,
440n/a 41,
450n/a 42,
460n/a 43,
470n/a 44,
480n/a 45,
490n/a 46,
500n/a 47,
510n/a 48,
520n/a 49,
530n/a 50
5400 ],
5500 "type": "integer"
5600}
SavedViewFilterRuleRequest0 of 13 keywords
10235{
200 "properties": {
300 "rule_type": {
40n/a "allOf": [
500 {
600 "$ref": "#/components/schemas/RuleTypeEnum"
700 }
80n/a ],
900 "maximum": 9223372036854775807,
1000 "minimum": 0
1100 },
1200 "value": {
1300 "maxLength": 255,
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "rule_type"
2000 ],
210235 "type": "object"
220235}
SetPermissionsRequest0 of 5 keywords
10523{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100523 "type": "object"
110523}
Responses1 of 1 documented received
codedescriptionhitsavg
20034814ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2854ms
400Bad Request16236ms
401Unauthorized1318ms
500Internal Server Error87ms
41524ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1215415{
2215415 "type": "integer"
3215415}
Body118 of 174 keywords covered
application/json58 / 58
SavedViewRequest
1675286{
2679272 "properties": {
3584n/a "display_fields": {
4584n/a "nullable": true,
5584n/a },
662915 "display_mode": {
7644n/a "nullable": true,
862915 "oneOf": [
911633 {
1011633 "$ref": "#/components/schemas/DisplayModeEnum"
1111633 },
1218626 {
1318626 "$ref": "#/components/schemas/BlankEnum"
1418626 },
1560044 {
1660044 "$ref": "#/components/schemas/NullEnum"
1760044 }
1862915 ],
1962915 },
2089059 "filter_rules": {
2189049 "items": {
2237049 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
2389049 },
2493910 "type": "array"
2589059 },
2661212 "icon": {
2761212 "$ref": "#/components/schemas/IconEnum"
2861212 },
2993118 "name": {
309354 "maxLength": 128,
319354 "minLength": 1,
3293910 "type": "string"
3393118 },
3461310 "owner": {
35623n/a "nullable": true,
3661310 "type": "integer"
3761310 },
3861820 "page_size": {
3962018 "format": "int64",
406222 "maximum": 9223372036854775807,
416204 "minimum": 1,
42638n/a "nullable": true,
4362810 "type": "integer"
4461820 },
45502120 "set_permissions": {
461n/a "allOf": [
47502120 {
48502120 "$ref": "#/components/schemas/SetPermissionsRequest"
49502120 }
501n/a ],
51 "writeOnly": true
52502120 },
5360911 "sort_field": {
545983 "maxLength": 128,
55620n/a "nullable": true,
566128 "type": "string"
5760911 },
5860610 "sort_reverse": {
5960610 "type": "boolean"
6060610 }
61679272 },
629474 "required": [
639492 "filter_rules",
649492 "name"
659474 ],
6695110 "type": "object"
67675286}
Referenced Components (8)40 of 40 keywords
BlankEnum2 of 2 keywords
118626{
218626 "enum": [
318n/a ""
418626 ]
518626}
DisplayModeEnum3 of 3 keywords
111633{
211633 "enum": [
34n/a "table",
43n/a "smallCards",
54n/a "largeCards"
611633 ],
732612 "type": "string"
811633}
IconEnum3 of 3 keywords
161212{
261212 "enum": [
3458n/a "archive",
45n/a "bank",
52n/a "basket",
63n/a "bell",
73n/a "bookmark",
84n/a "boxes",
92n/a "briefcase",
102n/a "building",
113n/a "calculator",
124n/a "calendar",
137n/a "camera",
142n/a "card-checklist",
152n/a "cash",
163n/a "chat-left-text",
175n/a "check-circle",
182n/a "clipboard",
194n/a "clock-history",
205n/a "credit-card",
213n/a "download",
222n/a "envelope",
232n/a "exclamation-triangle",
242n/a "file-earmark",
252n/a "file-earmark-check",
262n/a "file-earmark-lock",
276n/a "file-earmark-medical",
284n/a "file-earmark-person",
292n/a "file-earmark-spreadsheet",
302n/a "file-text",
314n/a "files",
322n/a "folder",
332n/a "funnel",
343n/a "gear",
352n/a "globe2",
362n/a "hash",
372n/a "heart",
382n/a "house",
392n/a "inbox",
404n/a "journals",
412n/a "list-task",
422n/a "newspaper",
432n/a "paperclip",
444n/a "people",
452n/a "person",
462n/a "printer",
472n/a "receipt",
482n/a "safe",
492n/a "search",
502n/a "send",
512n/a "shop",
522n/a "stack",
532n/a "stars",
546n/a "tag",
552n/a "tags",
562n/a "telephone",
572n/a "truck",
582n/a "upc-scan",
592n/a "wallet2"
6061212 ],
6161410 "type": "string"
6261212}
NullEnum2 of 2 keywords
160044{
260044 "enum": [
3600n/a null
460044 ]
560044}
PermissionSetRequest9 of 9 keywords
11049111{
2103591 "properties": {
3107344 "groups": {
4106228 "items": {
56632 "type": "integer"
6106228 },
71117n/a "nullable": true,
8110116 "type": "array"
9107344 },
10106847 "users": {
11105528 "items": {
123432 "type": "integer"
13105528 },
141115n/a "nullable": true,
15109619 "type": "array"
16106847 }
17103591 },
18114020 "type": "object"
191049111}
RuleTypeEnum3 of 3 keywords
138416{
238416 "enum": [
357n/a 0,
43n/a 1,
55n/a 2,
612n/a 3,
713n/a 4,
810n/a 5,
912n/a 6,
108n/a 7,
113n/a 8,
125n/a 9,
133n/a 10,
143n/a 11,
1511n/a 12,
163n/a 13,
176n/a 14,
183n/a 15,
193n/a 16,
204n/a 17,
219n/a 18,
224n/a 19,
233n/a 20,
244n/a 21,
259n/a 22,
267n/a 23,
278n/a 24,
286n/a 25,
297n/a 26,
3016n/a 27,
315n/a 28,
325n/a 29,
332n/a 30,
344n/a 31,
353n/a 32,
363n/a 33,
3721n/a 34,
388n/a 35,
3920n/a 36,
403n/a 37,
418n/a 38,
423n/a 39,
435n/a 40,
444n/a 41,
4510n/a 42,
466n/a 43,
475n/a 44,
486n/a 45,
497n/a 46,
509n/a 47,
514n/a 48,
524n/a 49,
532n/a 50
5438416 ],
5538812 "type": "integer"
5638416}
SavedViewFilterRuleRequest13 of 13 keywords
137049{
237930 "properties": {
338416 "rule_type": {
41n/a "allOf": [
538416 {
638416 "$ref": "#/components/schemas/RuleTypeEnum"
738416 }
81n/a ],
93882 "maximum": 9223372036854775807,
103882 "minimum": 0
1138416 },
1227914 "value": {
131912 "maxLength": 255,
14293n/a "nullable": true,
1528112 "type": "string"
1627914 }
1737930 },
184009 "required": [
194009 "rule_type"
204009 ],
2140910 "type": "object"
2237049}
SetPermissionsRequest5 of 5 keywords
1502120{
2476110 "properties": {
352556 "change": {
452556 "$ref": "#/components/schemas/PermissionSetRequest"
552556 },
652455 "view": {
752455 "$ref": "#/components/schemas/PermissionSetRequest"
852455 }
9476110 },
1061210 "type": "object"
11502120}
application/x-www-form-urlencoded30 / 58
SavedViewRequest
10551{
233518 "properties": {
3432n/a "display_fields": {
4432n/a "nullable": true,
5432n/a },
647612 "display_mode": {
7488n/a "nullable": true,
847612 "oneOf": [
931457 {
1031457 "$ref": "#/components/schemas/DisplayModeEnum"
1131457 },
129479 {
139479 "$ref": "#/components/schemas/BlankEnum"
149479 },
1543652 {
1643652 "$ref": "#/components/schemas/NullEnum"
1743652 }
1847612 ],
1947612 },
200216 "filter_rules": {
210216 "items": {
2201820 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
230216 },
242160 "type": "array"
250216 },
264783 "icon": {
274783 "$ref": "#/components/schemas/IconEnum"
284783 },
295445 "name": {
305472 "maxLength": 128,
315463 "minLength": 1,
32549n/a "type": "string"
335445 },
3428461 "owner": {
35489n/a "nullable": true,
3628461 "type": "integer"
3728461 },
3846024 "page_size": {
3946222 "format": "int64",
404622 "maximum": 9223372036854775807,
414622 "minimum": 1,
42484n/a "nullable": true,
4346420 "type": "integer"
4446024 },
4500 "set_permissions": {
460n/a "allOf": [
4700 {
4800 "$ref": "#/components/schemas/SetPermissionsRequest"
4900 }
500n/a ],
51 "writeOnly": true
5200 },
534763 "sort_field": {
544763 "maxLength": 128,
55479n/a "nullable": true,
56479n/a "type": "string"
574763 },
584694 "sort_reverse": {
594694 "type": "boolean"
604694 }
6133518 },
62216335 "required": [
63216335 "filter_rules",
645492 "name"
65216335 ],
66551n/a "type": "object"
670551}
Referenced Components (8)10 of 40 keywords
BlankEnum2 of 2 keywords
19479{
29479 "enum": [
39n/a ""
49479 ]
59479}
DisplayModeEnum3 of 3 keywords
131457{
231457 "enum": [
313n/a "table",
410n/a "smallCards",
58n/a "largeCards"
631457 ],
752n/a "type": "string"
831457}
IconEnum3 of 3 keywords
14783{
24783 "enum": [
3316n/a "archive",
42n/a "bank",
52n/a "basket",
62n/a "bell",
72n/a "bookmark",
83n/a "boxes",
94n/a "briefcase",
103n/a "building",
112n/a "calculator",
122n/a "calendar",
136n/a "camera",
142n/a "card-checklist",
155n/a "cash",
164n/a "chat-left-text",
172n/a "check-circle",
182n/a "clipboard",
192n/a "clock-history",
203n/a "credit-card",
212n/a "download",
222n/a "envelope",
232n/a "exclamation-triangle",
242n/a "file-earmark",
252n/a "file-earmark-check",
263n/a "file-earmark-lock",
273n/a "file-earmark-medical",
282n/a "file-earmark-person",
294n/a "file-earmark-spreadsheet",
304n/a "file-text",
312n/a "files",
322n/a "folder",
332n/a "funnel",
342n/a "gear",
352n/a "globe2",
362n/a "hash",
378n/a "heart",
383n/a "house",
392n/a "inbox",
406n/a "journals",
413n/a "list-task",
422n/a "newspaper",
433n/a "paperclip",
442n/a "people",
452n/a "person",
462n/a "printer",
472n/a "receipt",
484n/a "safe",
495n/a "search",
509n/a "send",
512n/a "shop",
522n/a "stack",
533n/a "stars",
545n/a "tag",
552n/a "tags",
562n/a "telephone",
572n/a "truck",
582n/a "upc-scan",
593n/a "wallet2"
604783 ],
61481n/a "type": "string"
624783}
NullEnum2 of 2 keywords
143652{
243652 "enum": [
3436n/a null
443652 ]
543652}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
RuleTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5,
90n/a 6,
100n/a 7,
110n/a 8,
120n/a 9,
130n/a 10,
140n/a 11,
150n/a 12,
160n/a 13,
170n/a 14,
180n/a 15,
190n/a 16,
200n/a 17,
210n/a 18,
220n/a 19,
230n/a 20,
240n/a 21,
250n/a 22,
260n/a 23,
270n/a 24,
280n/a 25,
290n/a 26,
300n/a 27,
310n/a 28,
320n/a 29,
330n/a 30,
340n/a 31,
350n/a 32,
360n/a 33,
370n/a 34,
380n/a 35,
390n/a 36,
400n/a 37,
410n/a 38,
420n/a 39,
430n/a 40,
440n/a 41,
450n/a 42,
460n/a 43,
470n/a 44,
480n/a 45,
490n/a 46,
500n/a 47,
510n/a 48,
520n/a 49,
530n/a 50
5400 ],
5500 "type": "integer"
5600}
SavedViewFilterRuleRequest0 of 13 keywords
101820{
200 "properties": {
300 "rule_type": {
40n/a "allOf": [
500 {
600 "$ref": "#/components/schemas/RuleTypeEnum"
700 }
80n/a ],
900 "maximum": 9223372036854775807,
1000 "minimum": 0
1100 },
1200 "value": {
1300 "maxLength": 255,
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "rule_type"
2000 ],
2101820 "type": "object"
2201820}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data30 / 58
SavedViewRequest
10583{
225558 "properties": {
3500n/a "display_fields": {
4500n/a "nullable": true,
5500n/a },
651814 "display_mode": {
7532n/a "nullable": true,
851814 "oneOf": [
914518 {
1014518 "$ref": "#/components/schemas/DisplayModeEnum"
1114518 },
1213519 {
1313519 "$ref": "#/components/schemas/BlankEnum"
1413519 },
1549141 {
1649141 "$ref": "#/components/schemas/NullEnum"
1749141 }
1851814 ],
1951814 },
200200 "filter_rules": {
210200 "items": {
220440 "$ref": "#/components/schemas/SavedViewFilterRuleRequest"
230200 },
242000 "type": "array"
250200 },
265322 "icon": {
275322 "$ref": "#/components/schemas/IconEnum"
285322 },
295774 "name": {
305792 "maxLength": 128,
315792 "minLength": 1,
32581n/a "type": "string"
335774 },
3415510 "owner": {
35525n/a "nullable": true,
3615510 "type": "integer"
3715510 },
3850426 "page_size": {
3950624 "format": "int64",
405062 "maximum": 9223372036854775807,
415062 "minimum": 1,
42530n/a "nullable": true,
4350822 "type": "integer"
4450426 },
450526 "set_permissions": {
460n/a "allOf": [
470526 {
480526 "$ref": "#/components/schemas/SetPermissionsRequest"
490526 }
500n/a ],
51 "writeOnly": true
520526 },
535222 "sort_field": {
545222 "maxLength": 128,
55524n/a "nullable": true,
56524n/a "type": "string"
575222 },
5851810 "sort_reverse": {
5951810 "type": "boolean"
6051810 }
6125558 },
62200383 "required": [
63200383 "filter_rules",
645812 "name"
65200383 ],
66583n/a "type": "object"
670583}
Referenced Components (8)10 of 40 keywords
BlankEnum2 of 2 keywords
113519{
213519 "enum": [
313n/a ""
413519 ]
513519}
DisplayModeEnum3 of 3 keywords
114518{
214518 "enum": [
36n/a "table",
44n/a "smallCards",
54n/a "largeCards"
614518 ],
741n/a "type": "string"
814518}
IconEnum3 of 3 keywords
15322{
25322 "enum": [
3384n/a "archive",
44n/a "bank",
54n/a "basket",
63n/a "bell",
72n/a "bookmark",
85n/a "boxes",
98n/a "briefcase",
103n/a "building",
112n/a "calculator",
123n/a "calendar",
134n/a "camera",
143n/a "card-checklist",
152n/a "cash",
162n/a "chat-left-text",
172n/a "check-circle",
182n/a "clipboard",
193n/a "clock-history",
202n/a "credit-card",
212n/a "download",
222n/a "envelope",
232n/a "exclamation-triangle",
242n/a "file-earmark",
252n/a "file-earmark-check",
262n/a "file-earmark-lock",
273n/a "file-earmark-medical",
282n/a "file-earmark-person",
292n/a "file-earmark-spreadsheet",
302n/a "file-text",
312n/a "files",
322n/a "folder",
333n/a "funnel",
343n/a "gear",
353n/a "globe2",
362n/a "hash",
372n/a "heart",
382n/a "house",
392n/a "inbox",
403n/a "journals",
412n/a "list-task",
422n/a "newspaper",
432n/a "paperclip",
442n/a "people",
452n/a "person",
462n/a "printer",
472n/a "receipt",
482n/a "safe",
496n/a "search",
502n/a "send",
512n/a "shop",
522n/a "stack",
533n/a "stars",
547n/a "tag",
553n/a "tags",
562n/a "telephone",
572n/a "truck",
582n/a "upc-scan",
592n/a "wallet2"
605322 ],
61534n/a "type": "string"
625322}
NullEnum2 of 2 keywords
149141{
249141 "enum": [
3491n/a null
449141 ]
549141}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
RuleTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5,
90n/a 6,
100n/a 7,
110n/a 8,
120n/a 9,
130n/a 10,
140n/a 11,
150n/a 12,
160n/a 13,
170n/a 14,
180n/a 15,
190n/a 16,
200n/a 17,
210n/a 18,
220n/a 19,
230n/a 20,
240n/a 21,
250n/a 22,
260n/a 23,
270n/a 24,
280n/a 25,
290n/a 26,
300n/a 27,
310n/a 28,
320n/a 29,
330n/a 30,
340n/a 31,
350n/a 32,
360n/a 33,
370n/a 34,
380n/a 35,
390n/a 36,
400n/a 37,
410n/a 38,
420n/a 39,
430n/a 40,
440n/a 41,
450n/a 42,
460n/a 43,
470n/a 44,
480n/a 45,
490n/a 46,
500n/a 47,
510n/a 48,
520n/a 49,
530n/a 50
5400 ],
5500 "type": "integer"
5600}
SavedViewFilterRuleRequest0 of 13 keywords
10440{
200 "properties": {
300 "rule_type": {
40n/a "allOf": [
500 {
600 "$ref": "#/components/schemas/RuleTypeEnum"
700 }
80n/a ],
900 "maximum": 9223372036854775807,
1000 "minimum": 0
1100 },
1200 "value": {
1300 "maxLength": 255,
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "rule_type"
2000 ],
210440 "type": "object"
220440}
SetPermissionsRequest0 of 5 keywords
10526{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100526 "type": "object"
110526}
Responses1 of 1 documented received
codedescriptionhitsavg
20034918ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request14646ms
404Not Found3124ms
401Unauthorized349ms
500Internal Server Error88ms
41529ms
statistics 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses1 of 1 documented received
codedescriptionhitsavg
2001905ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3482ms
status 1 operation 1 covered 0 partial 0 uncovered 0 not measured — #
Responses1 of 1 documented received
codedescriptionhitsavg
200163523ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized452ms
storage_paths 7 operations 4 covered 3 partial 0 uncovered 0 not measured 74% #
Query Parameters15 of 15 keywords covered
full_perms1 / 1
#validinvalidschema
1144862{
2144862 "type": "boolean"
3144862}
id1 / 1
1332178{
2332178 "type": "integer"
3332178}
id__in2 / 2
1867530{
2867530 "items": {
35720972 "type": "integer"
4867530 },
51397n/a "type": "array"
6867530}
name__icontains1 / 1
11427n/a{
21427n/a "type": "string"
31427n/a}
name__iendswith1 / 1
11397n/a{
21397n/a "type": "string"
31397n/a}
name__iexact1 / 1
11380n/a{
21380n/a "type": "string"
31380n/a}
name__istartswith1 / 1
11364n/a{
21364n/a "type": "string"
31364n/a}
ordering1 / 1
11347n/a{
21347n/a "type": "string"
31347n/a}
page1 / 1
1133095{
2133095 "type": "integer"
3133095}
page_size1 / 1
1134693{
2134693 "type": "integer"
3134693}
path__icontains1 / 1
11422n/a{
21422n/a "type": "string"
31422n/a}
path__iendswith1 / 1
11338n/a{
21338n/a "type": "string"
31338n/a}
path__iexact1 / 1
11382n/a{
21382n/a "type": "string"
31382n/a}
path__istartswith1 / 1
11362n/a{
21362n/a "type": "string"
31362n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
20022026ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found11705ms
401Unauthorized1953ms
400Bad Request2154ms
500Internal Server Error1077ms
Body71 of 99 keywords covered
application/json33 / 33
StoragePathRequest
#validinvalidschema
11349253{
21356236 "properties": {
386812 "is_insensitive": {
486812 "type": "boolean"
586812 },
679613 "match": {
77963 "maxLength": 256,
879910 "type": "string"
979613 },
1081717 "matching_algorithm": {
111n/a "allOf": [
1281717 {
1381717 "$ref": "#/components/schemas/MatchingAlgorithm"
1481717 }
151n/a ],
168212 "maximum": 9223372036854775807,
178212 "minimum": 0
1881717 },
19155631 "name": {
20156413 "maxLength": 128,
2115698 "minLength": 1,
22157710 "type": "string"
23155631 },
2478218 "owner": {
25800n/a "nullable": true,
2678218 "type": "integer"
2778218 },
28156723 "path": {
29156711 "minLength": 1,
30157812 "type": "string"
31156723 },
32672135 "set_permissions": {
331n/a "allOf": [
34672135 {
35672135 "$ref": "#/components/schemas/SetPermissionsRequest"
36672135 }
371n/a ],
38 "writeOnly": true
39672135 }
401356236 },
4115857 "required": [
4215875 "name",
4315902 "path"
4415857 ],
45159210 "type": "object"
461349253}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
181717{
281717 "enum": [
3337n/a 0,
484n/a 1,
577n/a 2,
671n/a 3,
7109n/a 4,
872n/a 5,
967n/a 6
1081717 ],
1182113 "type": "integer"
1281717}
PermissionSetRequest9 of 9 keywords
1867136{
2660116 "properties": {
365267 "groups": {
454647 "items": {
5559170 "type": "integer"
654647 },
7719n/a "nullable": true,
869920 "type": "array"
965267 },
1067453 "users": {
1155230 "items": {
1243384 "type": "integer"
1355230 },
14727n/a "nullable": true,
1570423 "type": "array"
1667453 }
17660116 },
1898320 "type": "object"
19867136}
SetPermissionsRequest5 of 5 keywords
1672135{
2433124 "properties": {
342767 "change": {
442767 "$ref": "#/components/schemas/PermissionSetRequest"
542767 },
644069 "view": {
744069 "$ref": "#/components/schemas/PermissionSetRequest"
844069 }
9433124 },
1079611 "type": "object"
11672135}
application/x-www-form-urlencoded19 / 33
StoragePathRequest
1839468{
2842465 "properties": {
37604 "is_insensitive": {
47604 "type": "boolean"
57604 },
67585 "match": {
77585 "maxLength": 256,
8763n/a "type": "string"
97585 },
1072121 "matching_algorithm": {
111n/a "allOf": [
1272121 {
1372121 "$ref": "#/components/schemas/MatchingAlgorithm"
1472121 }
151n/a ],
167322 "maximum": 9223372036854775807,
1772410 "minimum": 0
1872121 },
19128714 "name": {
2012938 "maxLength": 128,
2112956 "minLength": 1,
221301n/a "type": "string"
23128714 },
24286445 "owner": {
25731n/a "nullable": true,
26286445 "type": "integer"
27286445 },
28128916 "path": {
29128916 "minLength": 1,
301305n/a "type": "string"
31128916 },
3200 "set_permissions": {
330n/a "allOf": [
3400 {
3500 "$ref": "#/components/schemas/SetPermissionsRequest"
3600 }
370n/a ],
38 "writeOnly": true
3900 }
40842465 },
4112998 "required": [
4213016 "name",
4313052 "path"
4412998 ],
451307n/a "type": "object"
46839468}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
172121{
272121 "enum": [
3222n/a 0,
462n/a 1,
566n/a 2,
6113n/a 3,
784n/a 4,
895n/a 5,
979n/a 6
1072121 ],
117348 "type": "integer"
1272121}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data19 / 33
StoragePathRequest
1324589{
2324589 "properties": {
350311 "is_insensitive": {
450311 "type": "boolean"
550311 },
648211 "match": {
748211 "maxLength": 256,
8493n/a "type": "string"
948211 },
1046126 "matching_algorithm": {
111n/a "allOf": [
1246126 {
1346126 "$ref": "#/components/schemas/MatchingAlgorithm"
1446126 }
151n/a ],
164669 "maximum": 9223372036854775807,
174732 "minimum": 0
1846126 },
1988724 "name": {
209047 "maxLength": 128,
2189417 "minLength": 1,
22911n/a "type": "string"
2388724 },
24138371 "owner": {
25509n/a "nullable": true,
26138371 "type": "integer"
27138371 },
2889714 "path": {
2989714 "minLength": 1,
30911n/a "type": "string"
3189714 },
320526 "set_permissions": {
330n/a "allOf": [
340526 {
350526 "$ref": "#/components/schemas/SetPermissionsRequest"
360526 }
370n/a ],
38 "writeOnly": true
390526 }
40324589 },
419094 "required": [
429112 "name",
439112 "path"
449094 ],
45913n/a "type": "object"
46324589}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
146126{
246126 "enum": [
3228n/a 0,
449n/a 1,
546n/a 2,
635n/a 3,
722n/a 4,
836n/a 5,
945n/a 6
1046126 ],
1147512 "type": "integer"
1246126}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10526{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100526 "type": "object"
110526}
Responses1 of 1 documented received
codedescriptionhitsavg
20177414ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request33965ms
401Unauthorized1334ms
41523ms
500Internal Server Error78ms
Body18 of 18 keywords covered
application/json6 / 6
StoragePathTestRequest
#validinvalidschema
18446{
28933 "properties": {
311011 "document": {
411011 "type": "integer",
5 "writeOnly": true
611011 },
79325 "path": {
89319 "minLength": 1,
91126 "type": "string",
10 "writeOnly": true
119325 }
128933 },
131178 "required": [
141214 "document",
151187 "path"
161178 ],
171255 "type": "object"
188446}
application/x-www-form-urlencoded6 / 6
StoragePathTestRequest
15635{
26922 "properties": {
3755 "document": {
4755 "type": "integer",
5 "writeOnly": true
6755 },
77118 "path": {
87118 "minLength": 1,
989n/a "type": "string",
10 "writeOnly": true
117118 }
126922 },
137813 "required": [
148011 "document",
15892 "path"
167813 ],
1791n/a "type": "object"
185635}
multipart/form-data6 / 6
StoragePathTestRequest
12418{
23210 "properties": {
3296 "document": {
4296 "type": "integer",
5 "writeOnly": true
6296 },
7374 "path": {
8374 "minLength": 1,
941n/a "type": "string",
10 "writeOnly": true
11374 }
123210 },
13348 "required": [
14357 "document",
15411 "path"
16348 ],
1742n/a "type": "object"
182418}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5383ms
41512ms
401Unauthorized253ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
12389{
22389 "type": "integer"
32389}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body9017ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1375ms
401Unauthorized2013ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
175519{
275519 "type": "integer"
375519}
Query Parameters1 of 1 keywords covered
full_perms1 / 1
120453{
220453 "type": "boolean"
320453}
Responses1 of 1 documented received
codedescriptionhitsavg
2004335ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized328ms
404Not Found3095ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1104012{
2104012 "type": "integer"
3104012}
Body68 of 96 keywords covered
application/json32 / 32
PatchedStoragePathRequest
1362109{
2204103 "properties": {
32717 "is_insensitive": {
42717 "type": "boolean"
52717 },
62098 "match": {
72093 "maxLength": 256,
82125 "type": "string"
92098 },
101989 "matching_algorithm": {
111n/a "allOf": [
121989 {
131989 "$ref": "#/components/schemas/MatchingAlgorithm"
141989 }
151n/a ],
162011 "maximum": 9223372036854775807,
172002 "minimum": 0
181989 },
191997 "name": {
202001 "maxLength": 128,
212001 "minLength": 1,
222015 "type": "string"
231997 },
242015 "owner": {
25206n/a "nullable": true,
262015 "type": "integer"
272015 },
282036 "path": {
292031 "minLength": 1,
302045 "type": "string"
312036 },
3214361 "set_permissions": {
331n/a "allOf": [
3414361 {
3514361 "$ref": "#/components/schemas/SetPermissionsRequest"
3614361 }
371n/a ],
38 "writeOnly": true
3914361 }
40204103 },
414656 "type": "object"
42362109}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11989{
21989 "enum": [
3139n/a 0,
415n/a 1,
511n/a 2,
610n/a 3,
75n/a 4,
813n/a 5,
95n/a 6
101989 ],
112016 "type": "integer"
121989}
PermissionSetRequest9 of 9 keywords
128158{
226648 "properties": {
327626 "groups": {
425318 "items": {
514430 "type": "integer"
625318 },
7302n/a "nullable": true,
82948 "type": "array"
927626 },
1027522 "users": {
1125914 "items": {
1213316 "type": "integer"
1325914 },
14297n/a "nullable": true,
152898 "type": "array"
1627522 }
1726648 },
1832910 "type": "object"
1928158}
SetPermissionsRequest5 of 5 keywords
114361{
211856 "properties": {
314129 "change": {
414129 "$ref": "#/components/schemas/PermissionSetRequest"
514129 },
614029 "view": {
714029 "$ref": "#/components/schemas/PermissionSetRequest"
814029 }
911856 },
101995 "type": "object"
1114361}
application/x-www-form-urlencoded18 / 32
PatchedStoragePathRequest
184110{
267110 "properties": {
31272 "is_insensitive": {
41272 "type": "boolean"
51272 },
613513 "match": {
713513 "maxLength": 256,
8148n/a "type": "string"
913513 },
1013213 "matching_algorithm": {
111n/a "allOf": [
1213213 {
1313213 "$ref": "#/components/schemas/MatchingAlgorithm"
1413213 }
151n/a ],
161343 "maximum": 9223372036854775807,
171361 "minimum": 0
1813213 },
191355 "name": {
201364 "maxLength": 128,
211391 "minLength": 1,
22140n/a "type": "string"
231355 },
2429100 "owner": {
25129n/a "nullable": true,
2629100 "type": "integer"
2729100 },
281224 "path": {
291224 "minLength": 1,
30126n/a "type": "string"
311224 },
3200 "set_permissions": {
330n/a "allOf": [
3400 {
3500 "$ref": "#/components/schemas/SetPermissionsRequest"
3600 }
370n/a ],
38 "writeOnly": true
3900 }
4067110 },
41194n/a "type": "object"
4284110}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
113213{
213213 "enum": [
372n/a 0,
411n/a 1,
58n/a 2,
618n/a 3,
75n/a 4,
83n/a 5,
915n/a 6
1013213 ],
111378 "type": "integer"
1213213}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data18 / 32
PatchedStoragePathRequest
131164{
217164 "properties": {
31415 "is_insensitive": {
41415 "type": "boolean"
51415 },
61521 "match": {
71521 "maxLength": 256,
8153n/a "type": "string"
91521 },
101339 "matching_algorithm": {
111n/a "allOf": [
121339 {
131339 "$ref": "#/components/schemas/MatchingAlgorithm"
141339 }
151n/a ],
161341 "maximum": 9223372036854775807,
171341 "minimum": 0
181339 },
191383 "name": {
201401 "maxLength": 128,
211392 "minLength": 1,
22141n/a "type": "string"
231383 },
2428127 "owner": {
25155n/a "nullable": true,
2628127 "type": "integer"
2728127 },
281392 "path": {
291392 "minLength": 1,
30141n/a "type": "string"
311392 },
320156 "set_permissions": {
330n/a "allOf": [
340156 {
350156 "$ref": "#/components/schemas/SetPermissionsRequest"
360156 }
370n/a ],
38 "writeOnly": true
390156 }
4017164 },
41195n/a "type": "object"
4231164}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11339{
21339 "enum": [
398n/a 0,
44n/a 1,
58n/a 2,
64n/a 3,
73n/a 4,
84n/a 5,
912n/a 6
101339 ],
111357 "type": "integer"
121339}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10156{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100156 "type": "object"
110156}
Responses1 of 1 documented received
codedescriptionhitsavg
20020914ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4225ms
400Bad Request3917ms
401Unauthorized2910ms
41514ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1105813{
2105813 "type": "integer"
3105813}
Body71 of 99 keywords covered
application/json33 / 33
StoragePathRequest
1325121{
2327114 "properties": {
32315 "is_insensitive": {
42315 "type": "boolean"
52315 },
619014 "match": {
71901 "maxLength": 256,
819113 "type": "string"
919014 },
1019011 "matching_algorithm": {
111n/a "allOf": [
1219011 {
1319011 "$ref": "#/components/schemas/MatchingAlgorithm"
1419011 }
151n/a ],
161951 "maximum": 9223372036854775807,
171924 "minimum": 0
1819011 },
194319 "name": {
204341 "maxLength": 128,
214323 "minLength": 1,
224355 "type": "string"
234319 },
242067 "owner": {
25213n/a "nullable": true,
262067 "type": "integer"
272067 },
284328 "path": {
294323 "minLength": 1,
304355 "type": "string"
314328 },
3214662 "set_permissions": {
331n/a "allOf": [
3414662 {
3514662 "$ref": "#/components/schemas/SetPermissionsRequest"
3614662 }
371n/a ],
38 "writeOnly": true
3914662 }
40327114 },
414392 "required": [
424401 "name",
434401 "path"
444392 ],
454415 "type": "object"
46325121}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
119011{
219011 "enum": [
3142n/a 0,
47n/a 1,
513n/a 2,
67n/a 3,
75n/a 4,
86n/a 5,
910n/a 6
1019011 ],
111956 "type": "integer"
1219011}
PermissionSetRequest9 of 9 keywords
127760{
223950 "properties": {
325922 "groups": {
423714 "items": {
57516 "type": "integer"
623714 },
7281n/a "nullable": true,
82738 "type": "array"
925922 },
1025628 "users": {
1123614 "items": {
127516 "type": "integer"
1323614 },
14284n/a "nullable": true,
1527014 "type": "array"
1625628 }
1723950 },
1832710 "type": "object"
1927760}
SetPermissionsRequest5 of 5 keywords
114662{
212257 "properties": {
313930 "change": {
413930 "$ref": "#/components/schemas/PermissionSetRequest"
513930 },
613830 "view": {
713830 "$ref": "#/components/schemas/PermissionSetRequest"
813830 }
912257 },
102035 "type": "object"
1114662}
application/x-www-form-urlencoded19 / 33
StoragePathRequest
1163109{
2163109 "properties": {
31482 "is_insensitive": {
41482 "type": "boolean"
51482 },
61612 "match": {
71612 "maxLength": 256,
8163n/a "type": "string"
91612 },
101386 "matching_algorithm": {
111n/a "allOf": [
121386 {
131386 "$ref": "#/components/schemas/MatchingAlgorithm"
141386 }
151n/a ],
161401 "maximum": 9223372036854775807,
171401 "minimum": 0
181386 },
192674 "name": {
202683 "maxLength": 128,
212701 "minLength": 1,
22271n/a "type": "string"
232674 },
2430107 "owner": {
25137n/a "nullable": true,
2630107 "type": "integer"
2730107 },
282701 "path": {
292701 "minLength": 1,
30271n/a "type": "string"
312701 },
3200 "set_permissions": {
330n/a "allOf": [
3400 {
3500 "$ref": "#/components/schemas/SetPermissionsRequest"
3600 }
370n/a ],
38 "writeOnly": true
3900 }
40163109 },
412702 "required": [
422711 "name",
432711 "path"
442702 ],
45272n/a "type": "object"
46163109}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11386{
21386 "enum": [
381n/a 0,
415n/a 1,
58n/a 2,
63n/a 3,
78n/a 4,
89n/a 5,
914n/a 6
101386 ],
111413 "type": "integer"
121386}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data19 / 33
StoragePathRequest
162172{
262172 "properties": {
315010 "is_insensitive": {
415010 "type": "boolean"
515010 },
61722 "match": {
71722 "maxLength": 256,
8174n/a "type": "string"
91722 },
101539 "matching_algorithm": {
111n/a "allOf": [
121539 {
131539 "$ref": "#/components/schemas/MatchingAlgorithm"
141539 }
151n/a ],
161551 "maximum": 9223372036854775807,
171551 "minimum": 0
181539 },
192284 "name": {
202302 "maxLength": 128,
212302 "minLength": 1,
22232n/a "type": "string"
232284 },
2425135 "owner": {
25160n/a "nullable": true,
2625135 "type": "integer"
2725135 },
282267 "path": {
292267 "minLength": 1,
30233n/a "type": "string"
312267 },
320150 "set_permissions": {
330n/a "allOf": [
340150 {
350150 "$ref": "#/components/schemas/SetPermissionsRequest"
360150 }
370n/a ],
38 "writeOnly": true
390150 }
4062172 },
412313 "required": [
422322 "name",
432331 "path"
442313 ],
45234n/a "type": "object"
4662172}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11539{
21539 "enum": [
3118n/a 0,
49n/a 1,
52n/a 2,
68n/a 3,
75n/a 4,
84n/a 5,
97n/a 6
101539 ],
111566 "type": "integer"
121539}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10150{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100150 "type": "object"
110150}
Responses1 of 1 documented received
codedescriptionhitsavg
20014615ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4996ms
404Not Found4035ms
41514ms
401Unauthorized2212ms
tags 6 operations 3 covered 3 partial 0 uncovered 0 not measured 75% #
Query Parameters12 of 12 keywords covered
full_perms1 / 1
#validinvalidschema
11625142{
21625142 "type": "boolean"
31625142}
id1 / 1
13354147{
23354147 "type": "integer"
33354147}
id__in2 / 2
11016683{
21016683 "items": {
373521751 "type": "integer"
41016683 },
51699n/a "type": "array"
61016683}
is_root1 / 1
1166174{
2166174 "type": "boolean"
3166174}
name__icontains1 / 1
11630n/a{
21630n/a "type": "string"
31630n/a}
name__iendswith1 / 1
11655n/a{
21655n/a "type": "string"
31655n/a}
name__iexact1 / 1
11752n/a{
21752n/a "type": "string"
31752n/a}
name__istartswith1 / 1
11632n/a{
21632n/a "type": "string"
31632n/a}
ordering1 / 1
11608n/a{
21608n/a "type": "string"
31608n/a}
page1 / 1
11498177{
21498177 "type": "integer"
31498177}
page_size1 / 1
11533106{
21533106 "type": "integer"
31533106}
Responses1 of 1 documented received
codedescriptionhitsavg
20020428ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found12316ms
401Unauthorized1773ms
400Bad Request2426ms
500Internal Server Error2517ms
Body83 of 111 keywords covered
application/json37 / 37
TagRequest
#validinvalidschema
11298269{
21303254 "properties": {
3127320 "color": {
412758 "maxLength": 7,
512812 "minLength": 1,
6128310 "type": "string"
7127320 },
882816 "is_inbox_tag": {
982816 "type": "boolean"
1082816 },
1184410 "is_insensitive": {
1284410 "type": "boolean"
1384410 },
1487313 "match": {
158733 "maxLength": 256,
1687610 "type": "string"
1787313 },
1880517 "matching_algorithm": {
191n/a "allOf": [
2080517 {
2180517 "$ref": "#/components/schemas/MatchingAlgorithm"
2280517 }
231n/a ],
248093 "maximum": 9223372036854775807,
258102 "minimum": 0
2680517 },
27151735 "name": {
28152913 "maxLength": 128,
29153012 "minLength": 1,
30154210 "type": "string"
31151735 },
3282610 "owner": {
33836n/a "nullable": true,
3482610 "type": "integer"
3582610 },
3680913 "parent": {
37822n/a "nullable": true,
3880913 "type": "integer"
3980913 },
40672129 "set_permissions": {
411n/a "allOf": [
42672129 {
43672129 "$ref": "#/components/schemas/SetPermissionsRequest"
44672129 }
451n/a ],
46 "writeOnly": true
47672129 }
481303254 },
4915525 "required": [
5015525 "name"
5115525 ],
52155710 "type": "object"
531298269}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
180517{
280517 "enum": [
3371n/a 0,
469n/a 1,
566n/a 2,
674n/a 3,
782n/a 4,
851n/a 5,
992n/a 6
1080517 ],
1181012 "type": "integer"
1280517}
PermissionSetRequest9 of 9 keywords
1958123{
2716103 "properties": {
370953 "groups": {
459734 "items": {
5419134 "type": "integer"
659734 },
7762n/a "nullable": true,
874319 "type": "array"
970953 },
1070150 "users": {
1159334 "items": {
1247191 "type": "integer"
1359334 },
14751n/a "nullable": true,
1573516 "type": "array"
1670150 }
17716103 },
18106120 "type": "object"
19958123}
SetPermissionsRequest5 of 5 keywords
1672129{
2504119 "properties": {
347558 "change": {
447558 "$ref": "#/components/schemas/PermissionSetRequest"
547558 },
648365 "view": {
748365 "$ref": "#/components/schemas/PermissionSetRequest"
848365 }
9504119 },
1079110 "type": "object"
11672129}
application/x-www-form-urlencoded23 / 37
TagRequest
1678739{
2683733 "properties": {
3116718 "color": {
411769 "maxLength": 7,
511769 "minLength": 1,
61185n/a "type": "string"
7116718 },
88194 "is_inbox_tag": {
98194 "type": "boolean"
108194 },
117604 "is_insensitive": {
127604 "type": "boolean"
137604 },
147935 "match": {
157935 "maxLength": 256,
16798n/a "type": "string"
177935 },
1874217 "matching_algorithm": {
191n/a "allOf": [
2074217 {
2174217 "$ref": "#/components/schemas/MatchingAlgorithm"
2274217 }
231n/a ],
247473 "maximum": 9223372036854775807,
257473 "minimum": 0
2674217 },
27137136 "name": {
28139413 "maxLength": 128,
29138423 "minLength": 1,
301407n/a "type": "string"
31137136 },
32310502 "owner": {
33812n/a "nullable": true,
34310502 "type": "integer"
35310502 },
36288476 "parent": {
37764n/a "nullable": true,
38288476 "type": "integer"
39288476 },
4000 "set_permissions": {
410n/a "allOf": [
4200 {
4300 "$ref": "#/components/schemas/SetPermissionsRequest"
4400 }
450n/a ],
46 "writeOnly": true
4700 }
48683733 },
49140710 "required": [
50140710 "name"
51140710 ],
521417n/a "type": "object"
53678739}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
174217{
274217 "enum": [
3242n/a 0,
468n/a 1,
588n/a 2,
684n/a 3,
795n/a 4,
864n/a 5,
9101n/a 6
1074217 ],
117509 "type": "integer"
1274217}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data23 / 37
TagRequest
1286716{
2286714 "properties": {
38526 "color": {
48553 "maxLength": 7,
58553 "minLength": 1,
6858n/a "type": "string"
78526 },
860811 "is_inbox_tag": {
960811 "type": "boolean"
1060811 },
1159511 "is_insensitive": {
1259511 "type": "boolean"
1359511 },
146192 "match": {
156192 "maxLength": 256,
16621n/a "type": "string"
176192 },
1857021 "matching_algorithm": {
191n/a "allOf": [
2057021 {
2157021 "$ref": "#/components/schemas/MatchingAlgorithm"
2257021 }
231n/a ],
245732 "maximum": 9223372036854775807,
255723 "minimum": 0
2657021 },
279879 "name": {
289942 "maxLength": 128,
299897 "minLength": 1,
30996n/a "type": "string"
319879 },
32182437 "owner": {
33619n/a "nullable": true,
34182437 "type": "integer"
35182437 },
36198431 "parent": {
37629n/a "nullable": true,
38198431 "type": "integer"
39198431 },
400635 "set_permissions": {
410n/a "allOf": [
420635 {
430635 "$ref": "#/components/schemas/SetPermissionsRequest"
440635 }
450n/a ],
46 "writeOnly": true
470635 }
48286714 },
499966 "required": [
509966 "name"
519966 ],
521002n/a "type": "object"
53286716}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
157021{
257021 "enum": [
3275n/a 0,
446n/a 1,
542n/a 2,
654n/a 3,
745n/a 4,
865n/a 5,
943n/a 6
1057021 ],
1157516 "type": "integer"
1257021}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10635{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100635 "type": "object"
110635}
Responses1 of 1 documented received
codedescriptionhitsavg
20153788ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request39065ms
401Unauthorized1514ms
41523ms
500Internal Server Error27ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11966{
21966 "type": "integer"
31966}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body6073ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1196ms
401Unauthorized2311ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168114{
268114 "type": "integer"
368114}
Query Parameters1 of 1 keywords covered
full_perms1 / 1
117859{
217859 "type": "boolean"
317859}
Responses1 of 1 documented received
codedescriptionhitsavg
2003727ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized388ms
404Not Found2855ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1107417{
2107417 "type": "integer"
3107417}
Body80 of 108 keywords covered
application/json36 / 36
PatchedTagRequest
1409118{
2199112 "properties": {
32667 "color": {
42671 "maxLength": 7,
52671 "minLength": 1,
62685 "type": "string"
72667 },
82065 "is_inbox_tag": {
92065 "type": "boolean"
102065 },
112035 "is_insensitive": {
122035 "type": "boolean"
132035 },
141956 "match": {
151951 "maxLength": 256,
161965 "type": "string"
171956 },
182558 "matching_algorithm": {
191n/a "allOf": [
202558 {
212558 "$ref": "#/components/schemas/MatchingAlgorithm"
222558 }
231n/a ],
242571 "maximum": 9223372036854775807,
252571 "minimum": 0
262558 },
271928 "name": {
281932 "maxLength": 128,
291941 "minLength": 1,
301955 "type": "string"
311928 },
322516 "owner": {
33257n/a "nullable": true,
342516 "type": "integer"
352516 },
361927 "parent": {
37199n/a "nullable": true,
381927 "type": "integer"
391927 },
4013763 "set_permissions": {
411n/a "allOf": [
4213763 {
4313763 "$ref": "#/components/schemas/SetPermissionsRequest"
4413763 }
451n/a ],
46 "writeOnly": true
4713763 }
48199112 },
495216 "type": "object"
50409118}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
12558{
22558 "enum": [
3147n/a 0,
49n/a 1,
55n/a 2,
661n/a 3,
78n/a 4,
812n/a 5,
913n/a 6
102558 ],
112576 "type": "integer"
122558}
PermissionSetRequest9 of 9 keywords
127960{
226550 "properties": {
327526 "groups": {
426315 "items": {
58233 "type": "integer"
626315 },
7301n/a "nullable": true,
829011 "type": "array"
927526 },
1028326 "users": {
1126414 "items": {
129816 "type": "integer"
1326414 },
14309n/a "nullable": true,
1529712 "type": "array"
1628326 }
1726550 },
1832910 "type": "object"
1927960}
SetPermissionsRequest5 of 5 keywords
113763{
212357 "properties": {
313930 "change": {
413930 "$ref": "#/components/schemas/PermissionSetRequest"
513930 },
614030 "view": {
714030 "$ref": "#/components/schemas/PermissionSetRequest"
814030 }
912357 },
101946 "type": "object"
1113763}
application/x-www-form-urlencoded22 / 36
PatchedTagRequest
199137{
266137 "properties": {
31545 "color": {
41563 "maxLength": 7,
51572 "minLength": 1,
6159n/a "type": "string"
71545 },
81392 "is_inbox_tag": {
91392 "type": "boolean"
101392 },
111472 "is_insensitive": {
121472 "type": "boolean"
131472 },
141512 "match": {
151512 "maxLength": 256,
16153n/a "type": "string"
171512 },
181368 "matching_algorithm": {
191n/a "allOf": [
201368 {
211368 "$ref": "#/components/schemas/MatchingAlgorithm"
221368 }
231n/a ],
241372 "maximum": 9223372036854775807,
251381 "minimum": 0
261368 },
271322 "name": {
281331 "maxLength": 128,
291331 "minLength": 1,
30134n/a "type": "string"
311322 },
3228121 "owner": {
33149n/a "nullable": true,
3428121 "type": "integer"
3528121 },
3622110 "parent": {
37132n/a "nullable": true,
3822110 "type": "integer"
3922110 },
4000 "set_permissions": {
410n/a "allOf": [
4200 {
4300 "$ref": "#/components/schemas/SetPermissionsRequest"
4400 }
450n/a ],
46 "writeOnly": true
4700 }
4866137 },
49236n/a "type": "object"
5099137}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11368{
21368 "enum": [
389n/a 0,
44n/a 1,
515n/a 2,
68n/a 3,
73n/a 4,
813n/a 5,
94n/a 6
101368 ],
111395 "type": "integer"
121368}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data22 / 36
PatchedTagRequest
134156{
224156 "properties": {
31493 "color": {
41502 "maxLength": 7,
51511 "minLength": 1,
6152n/a "type": "string"
71493 },
81415 "is_inbox_tag": {
91415 "type": "boolean"
101415 },
111465 "is_insensitive": {
121465 "type": "boolean"
131465 },
141421 "match": {
151421 "maxLength": 256,
16143n/a "type": "string"
171421 },
1814010 "matching_algorithm": {
191n/a "allOf": [
2014010 {
2114010 "$ref": "#/components/schemas/MatchingAlgorithm"
2214010 }
231n/a ],
241431 "maximum": 9223372036854775807,
251413 "minimum": 0
2614010 },
271563 "name": {
281581 "maxLength": 128,
291572 "minLength": 1,
30159n/a "type": "string"
311563 },
3212133 "owner": {
33145n/a "nullable": true,
3412133 "type": "integer"
3512133 },
3615133 "parent": {
37148n/a "nullable": true,
3815133 "type": "integer"
3915133 },
400145 "set_permissions": {
410n/a "allOf": [
420145 {
430145 "$ref": "#/components/schemas/SetPermissionsRequest"
440145 }
450n/a ],
46 "writeOnly": true
470145 }
4824156 },
49190n/a "type": "object"
5034156}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
114010{
214010 "enum": [
3111n/a 0,
416n/a 1,
53n/a 2,
62n/a 3,
74n/a 4,
83n/a 5,
91n/a 6
1014010 ],
111446 "type": "integer"
1214010}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10145{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100145 "type": "object"
110145}
Responses1 of 1 documented received
codedescriptionhitsavg
20028032ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3085ms
400Bad Request4637ms
401Unauthorized378ms
41515ms
500Internal Server Error28ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1101712{
2101712 "type": "integer"
3101712}
Body83 of 111 keywords covered
application/json37 / 37
TagRequest
1371120{
2372114 "properties": {
33347 "color": {
43351 "maxLength": 7,
53351 "minLength": 1,
63365 "type": "string"
73347 },
81995 "is_inbox_tag": {
91995 "type": "boolean"
101995 },
112035 "is_insensitive": {
122035 "type": "boolean"
132035 },
142086 "match": {
152081 "maxLength": 256,
162095 "type": "string"
172086 },
182438 "matching_algorithm": {
191n/a "allOf": [
202438 {
212438 "$ref": "#/components/schemas/MatchingAlgorithm"
222438 }
231n/a ],
242451 "maximum": 9223372036854775807,
252451 "minimum": 0
262438 },
2747114 "name": {
284727 "maxLength": 128,
294781 "minLength": 1,
304796 "type": "string"
3147114 },
322065 "owner": {
33211n/a "nullable": true,
342065 "type": "integer"
352065 },
362006 "parent": {
37206n/a "nullable": true,
382006 "type": "integer"
392006 },
4013960 "set_permissions": {
411n/a "allOf": [
4213960 {
4313960 "$ref": "#/components/schemas/SetPermissionsRequest"
4413960 }
451n/a ],
46 "writeOnly": true
4713960 }
48372114 },
494851 "required": [
504851 "name"
514851 ],
524865 "type": "object"
53371120}
Referenced Components (3)17 of 17 keywords
MatchingAlgorithm3 of 3 keywords
12438{
22438 "enum": [
3183n/a 0,
49n/a 1,
54n/a 2,
611n/a 3,
715n/a 4,
812n/a 5,
99n/a 6
102438 ],
112456 "type": "integer"
122438}
PermissionSetRequest9 of 9 keywords
127955{
226545 "properties": {
327723 "groups": {
426515 "items": {
51624 "type": "integer"
626515 },
7300n/a "nullable": true,
82928 "type": "array"
927723 },
1027922 "users": {
1126714 "items": {
122716 "type": "integer"
1326714 },
14301n/a "nullable": true,
152938 "type": "array"
1627922 }
1726545 },
1832410 "type": "object"
1927955}
SetPermissionsRequest5 of 5 keywords
113960{
212155 "properties": {
313628 "change": {
413628 "$ref": "#/components/schemas/PermissionSetRequest"
513628 },
614327 "view": {
714327 "$ref": "#/components/schemas/PermissionSetRequest"
814327 }
912155 },
101945 "type": "object"
1113960}
application/x-www-form-urlencoded23 / 37
TagRequest
184154{
284153 "properties": {
31892 "color": {
41901 "maxLength": 7,
51901 "minLength": 1,
6191n/a "type": "string"
71892 },
81372 "is_inbox_tag": {
91372 "type": "boolean"
101372 },
111472 "is_insensitive": {
121472 "type": "boolean"
131472 },
141472 "match": {
151472 "maxLength": 256,
16149n/a "type": "string"
171472 },
181327 "matching_algorithm": {
191n/a "allOf": [
201327 {
211327 "$ref": "#/components/schemas/MatchingAlgorithm"
221327 }
231n/a ],
241333 "maximum": 9223372036854775807,
251351 "minimum": 0
261327 },
272313 "name": {
282322 "maxLength": 128,
292331 "minLength": 1,
30234n/a "type": "string"
312313 },
3226123 "owner": {
33149n/a "nullable": true,
3426123 "type": "integer"
3526123 },
3626132 "parent": {
37158n/a "nullable": true,
3826132 "type": "integer"
3926132 },
4000 "set_permissions": {
410n/a "allOf": [
4200 {
4300 "$ref": "#/components/schemas/SetPermissionsRequest"
4400 }
450n/a ],
46 "writeOnly": true
4700 }
4884153 },
492344 "required": [
502344 "name"
512344 ],
52238n/a "type": "object"
5384154}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11327{
21327 "enum": [
386n/a 0,
44n/a 1,
57n/a 2,
64n/a 3,
714n/a 4,
812n/a 5,
95n/a 6
101327 ],
111363 "type": "integer"
121327}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
100{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
1000 "type": "object"
1100}
multipart/form-data23 / 37
TagRequest
141183{
241183 "properties": {
32043 "color": {
42061 "maxLength": 7,
52052 "minLength": 1,
6207n/a "type": "string"
72043 },
81805 "is_inbox_tag": {
91805 "type": "boolean"
101805 },
111715 "is_insensitive": {
121715 "type": "boolean"
131715 },
141665 "match": {
151665 "maxLength": 256,
16171n/a "type": "string"
171665 },
181569 "matching_algorithm": {
191n/a "allOf": [
201569 {
211569 "$ref": "#/components/schemas/MatchingAlgorithm"
221569 }
231n/a ],
241581 "maximum": 9223372036854775807,
251572 "minimum": 0
261569 },
272202 "name": {
282211 "maxLength": 128,
292211 "minLength": 1,
30222n/a "type": "string"
312202 },
3222139 "owner": {
33161n/a "nullable": true,
3422139 "type": "integer"
3522139 },
3623151 "parent": {
37174n/a "nullable": true,
3823151 "type": "integer"
3923151 },
400170 "set_permissions": {
410n/a "allOf": [
420170 {
430170 "$ref": "#/components/schemas/SetPermissionsRequest"
440170 }
450n/a ],
46 "writeOnly": true
470170 }
4841183 },
492222 "required": [
502222 "name"
512222 ],
52224n/a "type": "object"
5341183}
Referenced Components (3)3 of 17 keywords
MatchingAlgorithm3 of 3 keywords
11569{
21569 "enum": [
3114n/a 0,
410n/a 1,
54n/a 2,
67n/a 3,
76n/a 4,
84n/a 5,
911n/a 6
101569 ],
111596 "type": "integer"
121569}
PermissionSetRequest0 of 9 keywords
100{
200 "properties": {
300 "groups": {
400 "items": {
500 "type": "integer"
600 },
70n/a "nullable": true,
800 "type": "array"
900 },
1000 "users": {
1100 "items": {
1200 "type": "integer"
1300 },
140n/a "nullable": true,
1500 "type": "array"
1600 }
1700 },
1800 "type": "object"
1900}
SetPermissionsRequest0 of 5 keywords
10170{
200 "properties": {
300 "change": {
400 "$ref": "#/components/schemas/PermissionSetRequest"
500 },
600 "view": {
700 "$ref": "#/components/schemas/PermissionSetRequest"
800 }
900 },
100170 "type": "object"
110170}
Responses1 of 1 documented received
codedescriptionhitsavg
20013364ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5417ms
404Not Found3416ms
41518ms
401Unauthorized1318ms
tasks 7 operations 6 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters22 of 22 keywords covered
acknowledged1 / 1
#validinvalidschema
1139424{
2139424 "type": "boolean"
3139424}
date_created_after2 / 2
1128738{
2128738 "format": "date-time",
31325n/a "type": "string"
4128738}
date_created_before2 / 2
1139632{
2139632 "format": "date-time",
31428n/a "type": "string"
4139632}
is_complete1 / 1
1136717{
2136717 "type": "boolean"
3136717}
name1 / 1
11412n/a{
21412n/a "type": "string"
31412n/a}
ordering1 / 1
11387n/a{
21387n/a "type": "string"
31387n/a}
owner1 / 1
1136373{
2136373 "type": "integer"
3136373}
page1 / 1
1135368{
2135368 "type": "integer"
3135368}
page_size1 / 1
1129579{
2129579 "type": "integer"
3129579}
result1 / 1
11373n/a{
21373n/a "type": "string"
31373n/a}
status3 / 3
1115631{
2115631 "items": {
3672276 "enum": [
41471n/a "failure",
51330n/a "pending",
61303n/a "revoked",
71281n/a "started",
81337n/a "success"
9672276 ],
106798n/a "type": "string"
11115631 },
121187n/a "type": "array"
13115631}
task_id1 / 1
13455n/a{
23455n/a "type": "string"
33455n/a}
task_type3 / 3
1106426{
2106426 "items": {
3610864 "enum": [
4537n/a "apply_ai_suggestions",
5451n/a "build_share_link",
6491n/a "bulk_delete",
7482n/a "bulk_update",
8497n/a "check_workflows",
9464n/a "consume_file",
10435n/a "empty_trash",
11422n/a "index_optimize",
12506n/a "llm_index",
13476n/a "mail_fetch",
14397n/a "reprocess_document",
15478n/a "sanity_check",
16472n/a "train_classifier"
17610864 ],
186172n/a "type": "string"
19106426 },
201090n/a "type": "array"
21106426}
trigger_source3 / 3
1115620{
2115620 "items": {
3609025 "enum": [
4992n/a "api_upload",
5898n/a "email_consume",
6873n/a "folder_consume",
7834n/a "manual",
8812n/a "scheduled",
9812n/a "system",
10869n/a "web_ui"
11609025 ],
126115n/a "type": "string"
13115620 },
141176n/a "type": "array"
15115620}
Responses1 of 1 documented received
codedescriptionhitsavg
20021767ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request14325ms
401Unauthorized1803ms
404Not Found4365ms
Body13 of 15 keywords covered
application/json5 / 5
AcknowledgeTasksViewRequest
#validinvalidschema
1124126{
25485 "properties": {
35470 "all": {
45470 "type": "boolean",
5 "writeOnly": true
65470 },
74880 "tasks": {
84862 "items": {
9115205 "type": "integer"
104862 },
1111018 "type": "array",
12 "writeOnly": true
134880 }
145485 },
1520941 "type": "object"
16124126}
application/x-www-form-urlencoded4 / 5
AcknowledgeTasksViewRequest
18112{
25112 "properties": {
3532 "all": {
4532 "type": "boolean",
5 "writeOnly": true
6532 },
72210 "tasks": {
82210 "items": {
915710 "type": "integer"
102210 },
11320 "type": "array",
12 "writeOnly": true
132210 }
145112 },
1593n/a "type": "object"
168112}
multipart/form-data4 / 5
AcknowledgeTasksViewRequest
18634{
27234 "properties": {
3956 "all": {
4956 "type": "boolean",
5 "writeOnly": true
6956 },
72528 "tasks": {
82528 "items": {
931328 "type": "integer"
102528 },
11530 "type": "array",
12 "writeOnly": true
132528 }
147234 },
15120n/a "type": "object"
168634}
Responses1 of 1 documented received
codedescriptionhitsavg
200475ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4513ms
401Unauthorized536ms
41513ms
500Internal Server Error416ms
Examples3 / 3 used
Body: application/json
falseAcknowledgeTasksViewRequest.all
Body: application/x-www-form-urlencoded
falseAcknowledgeTasksViewRequest.all
Body: multipart/form-data
falseAcknowledgeTasksViewRequest.all
Query Parameters19 of 19 keywords covered
acknowledged1 / 1
#validinvalidschema
1170146{
2170146 "type": "boolean"
3170146}
date_created_after2 / 2
1169446{
2169446 "format": "date-time",
31740n/a "type": "string"
4169446}
date_created_before2 / 2
1176442{
2176442 "format": "date-time",
31806n/a "type": "string"
4176442}
is_complete1 / 1
1169849{
2169849 "type": "boolean"
3169849}
name1 / 1
11670n/a{
21670n/a "type": "string"
31670n/a}
ordering1 / 1
11699n/a{
21699n/a "type": "string"
31699n/a}
owner1 / 1
11620105{
21620105 "type": "integer"
31620105}
result1 / 1
11737n/a{
21737n/a "type": "string"
31737n/a}
status3 / 3
1129778{
2129778 "items": {
37629286 "enum": [
41621n/a "failure",
51483n/a "pending",
61413n/a "revoked",
71516n/a "started",
81596n/a "success"
97629286 ],
107915n/a "type": "string"
11129778 },
121375n/a "type": "array"
13129778}
task_type3 / 3
1133174{
2133174 "items": {
37959179 "enum": [
4686n/a "apply_ai_suggestions",
5569n/a "build_share_link",
6540n/a "bulk_delete",
7652n/a "bulk_update",
8586n/a "check_workflows",
9545n/a "consume_file",
10593n/a "empty_trash",
11707n/a "index_optimize",
12580n/a "llm_index",
13743n/a "mail_fetch",
14605n/a "reprocess_document",
15540n/a "sanity_check",
16613n/a "train_classifier"
177959179 ],
188138n/a "type": "string"
19133174 },
201405n/a "type": "array"
21133174}
trigger_source3 / 3
11309106{
21309106 "items": {
37709397 "enum": [
41108n/a "api_upload",
5956n/a "email_consume",
61049n/a "folder_consume",
71354n/a "manual",
8995n/a "scheduled",
91093n/a "system",
101154n/a "web_ui"
117709397 ],
128106n/a "type": "string"
131309106 },
141415n/a "type": "array"
151309106}
Responses1 of 1 documented received
codedescriptionhitsavg
200375313ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1504ms
Body21 of 21 keywords covered
application/json7 / 7
RunTaskRequest
#validinvalidschema
120026{
220014 "properties": {
320014 "task_type": {
41n/a "allOf": [
520014 {
620014 "$ref": "#/components/schemas/TaskTypeEnum"
720014 }
81n/a ],
9 "writeOnly": true
1020014 }
1120014 },
122147 "required": [
132147 "task_type"
142147 ],
152215 "type": "object"
1620026}
Referenced Components (1)3 of 3 keywords
TaskTypeEnum3 of 3 keywords
120014{
220014 "enum": [
36n/a "consume_file",
48n/a "train_classifier",
56n/a "sanity_check",
65n/a "index_optimize",
714n/a "mail_fetch",
896n/a "llm_index",
97n/a "empty_trash",
108n/a "check_workflows",
119n/a "bulk_update",
129n/a "reprocess_document",
132n/a "build_share_link",
1418n/a "bulk_delete",
1512n/a "apply_ai_suggestions"
1620014 ],
172077 "type": "string"
1820014}
application/x-www-form-urlencoded7 / 7
RunTaskRequest
112341{
21236 "properties": {
31236 "task_type": {
41n/a "allOf": [
51236 {
61236 "$ref": "#/components/schemas/TaskTypeEnum"
71236 }
81n/a ],
9 "writeOnly": true
101236 }
111236 },
1212935 "required": [
1312935 "task_type"
1412935 ],
15164n/a "type": "object"
1612341}
Referenced Components (1)3 of 3 keywords
TaskTypeEnum3 of 3 keywords
11236{
21236 "enum": [
38n/a "consume_file",
411n/a "train_classifier",
55n/a "sanity_check",
66n/a "index_optimize",
74n/a "mail_fetch",
825n/a "llm_index",
94n/a "empty_trash",
1010n/a "check_workflows",
115n/a "bulk_update",
1240n/a "reprocess_document",
131n/a "build_share_link",
141n/a "bulk_delete",
153n/a "apply_ai_suggestions"
161236 ],
17129n/a "type": "string"
181236}
multipart/form-data7 / 7
RunTaskRequest
14811{
2485 "properties": {
3485 "task_type": {
41n/a "allOf": [
5485 {
6485 "$ref": "#/components/schemas/TaskTypeEnum"
7485 }
81n/a ],
9 "writeOnly": true
10485 }
11485 },
12536 "required": [
13536 "task_type"
14536 ],
1559n/a "type": "object"
164811}
Referenced Components (1)3 of 3 keywords
TaskTypeEnum3 of 3 keywords
1485{
2485 "enum": [
33n/a "consume_file",
45n/a "train_classifier",
52n/a "sanity_check",
68n/a "index_optimize",
73n/a "mail_fetch",
89n/a "llm_index",
92n/a "empty_trash",
103n/a "check_workflows",
112n/a "bulk_update",
125n/a "reprocess_document",
132n/a "build_share_link",
141n/a "bulk_delete",
153n/a "apply_ai_suggestions"
16485 ],
1753n/a "type": "string"
18485}
Responses2 of 2 documented received
codedescriptionhitsavg
20018219ms
4003254ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized655ms
41513ms
Responses1 of 1 documented received
codedescriptionhitsavg
2001774ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3572ms
Query Parameters22 of 22 keywords covered
acknowledged1 / 1
#validinvalidschema
127130{
227130 "type": "boolean"
327130}
date_created_after2 / 2
122528{
222528 "format": "date-time",
3253n/a "type": "string"
422528}
date_created_before2 / 2
123233{
223233 "format": "date-time",
3265n/a "type": "string"
423233}
days3 / 3
121738{
22318 "maximum": 365,
322514 "minimum": 1,
423916 "type": "integer"
521738}
is_complete1 / 1
121228{
221228 "type": "boolean"
321228}
name1 / 1
1236n/a{
2236n/a "type": "string"
3236n/a}
ordering1 / 1
1213n/a{
2213n/a "type": "string"
3213n/a}
owner1 / 1
119524{
219524 "type": "integer"
319524}
result1 / 1
1229n/a{
2229n/a "type": "string"
3229n/a}
status3 / 3
116555{
216555 "items": {
3794170 "enum": [
4202n/a "failure",
5145n/a "pending",
6133n/a "revoked",
7182n/a "started",
8132n/a "success"
9794170 ],
10964n/a "type": "string"
1116555 },
12220n/a "type": "array"
1316555}
task_type3 / 3
118635{
218635 "items": {
377155 "enum": [
4144n/a "apply_ai_suggestions",
543n/a "build_share_link",
645n/a "bulk_delete",
788n/a "bulk_update",
836n/a "check_workflows",
972n/a "consume_file",
1064n/a "empty_trash",
1129n/a "index_optimize",
1254n/a "llm_index",
1335n/a "mail_fetch",
1447n/a "reprocess_document",
1578n/a "sanity_check",
1636n/a "train_classifier"
1777155 ],
18826n/a "type": "string"
1918635 },
20221n/a "type": "array"
2118635}
trigger_source3 / 3
118025{
218025 "items": {
359853 "enum": [
4150n/a "api_upload",
574n/a "email_consume",
668n/a "folder_consume",
769n/a "manual",
8112n/a "scheduled",
962n/a "system",
1063n/a "web_ui"
1159853 ],
12651n/a "type": "string"
1318025 },
14205n/a "type": "array"
1518025}
Responses1 of 1 documented received
codedescriptionhitsavg
2006124ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized536ms
400Bad Request163ms
Examples1 / 1 used
Query
30days
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
186618{
286618 "type": "integer"
386618}
Responses1 of 1 documented received
codedescriptionhitsavg
2007435ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found214ms
401Unauthorized1204ms
token 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Body27 of 27 keywords covered
application/json9 / 9
PaperlessAuthTokenRequest
#validinvalidschema
14337{
24530 "properties": {
33913 "code": {
4395 "minLength": 1,
5448 "type": "string",
6 "writeOnly": true
73913 },
86311 "password": {
9631 "minLength": 1,
106410 "type": "string",
11 "writeOnly": true
126311 },
135618 "username": {
14566 "minLength": 1,
156212 "type": "string",
16 "writeOnly": true
175618 }
184530 },
19732 "required": [
20741 "password",
21741 "username"
22732 ],
23755 "type": "object"
244337}
application/x-www-form-urlencoded9 / 9
PaperlessAuthTokenRequest
112183{
212774 "properties": {
36711 "code": {
46711 "minLength": 1,
578n/a "type": "string",
6 "writeOnly": true
76711 },
818610 "password": {
918610 "minLength": 1,
10196n/a "type": "string",
11 "writeOnly": true
1218610 },
1314159 "username": {
1414159 "minLength": 1,
15200n/a "type": "string",
16 "writeOnly": true
1714159 }
1812774 },
191959 "required": [
201968 "password",
212004 "username"
221959 ],
23204n/a "type": "object"
2412183}
multipart/form-data9 / 9
PaperlessAuthTokenRequest
17924{
28221 "properties": {
32810 "code": {
42810 "minLength": 1,
538n/a "type": "string",
6 "writeOnly": true
72810 },
8929 "password": {
9929 "minLength": 1,
10101n/a "type": "string",
11 "writeOnly": true
12929 },
13948 "username": {
14948 "minLength": 1,
15102n/a "type": "string",
16 "writeOnly": true
17948 }
188221 },
191003 "required": [
201012 "password",
211021 "username"
221003 ],
23103n/a "type": "object"
247924}
Responses0 of 1 documented received
codedescriptionhitsavg
2000never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request52151ms
429Too Many Requests4313ms
trash 2 operations 1 covered 1 partial 0 uncovered 0 not measured 93% #
Query Parameters2 of 2 keywords covered
page1 / 1
#validinvalidschema
1105316{
2105316 "type": "integer"
3105316}
page_size1 / 1
188315{
288315 "type": "integer"
388315}
Responses1 of 1 documented received
codedescriptionhitsavg
200No response body1414ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized506ms
404Not Found3604ms
Body25 of 27 keywords covered
application/json9 / 9
TrashRequest
#validinvalidschema
123737{
224023 "properties": {
324911 "action": {
41n/a "allOf": [
524911 {
624911 "$ref": "#/components/schemas/TrashActionEnum"
724911 }
81n/a ],
9 "writeOnly": true
1024911 },
1115412 "documents": {
121546 "items": {
135996 "type": "integer"
141546 },
151606 "type": "array",
16 "writeOnly": true
1715412 }
1824023 },
192609 "required": [
202609 "action"
212609 ],
222695 "type": "object"
2323737}
Referenced Components (1)3 of 3 keywords
TrashActionEnum3 of 3 keywords
124911{
224911 "enum": [
378n/a "restore",
4171n/a "empty"
524911 ],
62528 "type": "string"
724911}
application/x-www-form-urlencoded8 / 9
TrashRequest
18056{
28446 "properties": {
310916 "action": {
41n/a "allOf": [
510916 {
610916 "$ref": "#/components/schemas/TrashActionEnum"
710916 }
81n/a ],
9 "writeOnly": true
1010916 },
112030 "documents": {
122030 "items": {
1394331 "type": "integer"
142030 },
15500 "type": "array",
16 "writeOnly": true
172030 }
188446 },
1912511 "required": [
2012511 "action"
2112511 ],
22136n/a "type": "object"
238056}
Referenced Components (1)3 of 3 keywords
TrashActionEnum3 of 3 keywords
110916{
210916 "enum": [
338n/a "restore",
471n/a "empty"
510916 ],
6125n/a "type": "string"
710916}
multipart/form-data8 / 9
TrashRequest
17038{
27330 "properties": {
3937 "action": {
41n/a "allOf": [
5937 {
6937 "$ref": "#/components/schemas/TrashActionEnum"
7937 }
81n/a ],
9 "writeOnly": true
10937 },
112227 "documents": {
122227 "items": {
1319728 "type": "integer"
142227 },
15490 "type": "array",
16 "writeOnly": true
172227 }
187330 },
191008 "required": [
201008 "action"
211008 ],
22108n/a "type": "object"
237038}
Referenced Components (1)3 of 3 keywords
TrashActionEnum3 of 3 keywords
1937{
2937 "enum": [
336n/a "restore",
457n/a "empty"
5937 ],
6100n/a "type": "string"
7937}
Responses1 of 1 documented received
codedescriptionhitsavg
200No response body1835ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2284ms
401Unauthorized794ms
500Internal Server Error955ms
41513ms
ui_settings 2 operations 1 covered 1 partial 0 uncovered 0 not measured 80% #
Responses1 of 1 documented received
codedescriptionhitsavg
2001725ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error214ms
401Unauthorized3402ms
Body12 of 15 keywords covered
application/json5 / 5
UiSettingsViewRequest
#validinvalidschema
124218{
21647 "properties": {
31647 "settings": {
4107n/a "additionalProperties": {},
5171n/a "nullable": true,
61647 "type": "object"
71647 }
81647 },
924911 "type": "object"
1024218}
application/x-www-form-urlencoded2 / 5
UiSettingsViewRequest
14516{
2016 "properties": {
3016 "settings": {
40n/a "additionalProperties": {},
516n/a "nullable": true,
6016 "type": "object"
7016 }
8016 },
961n/a "type": "object"
104516}
multipart/form-data5 / 5
UiSettingsViewRequest
16918{
25118 "properties": {
35118 "settings": {
435n/a "additionalProperties": {},
569n/a "nullable": true,
65118 "type": "object"
75118 }
85118 },
987n/a "type": "object"
106918}
Responses1 of 1 documented received
codedescriptionhitsavg
2004217ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized705ms
400Bad Request363ms
500Internal Server Error425ms
41513ms
users 7 operations 4 covered 3 partial 0 uncovered 0 not measured 95% #
Query Parameters7 of 7 keywords covered
ordering1 / 1
#validinvalidschema
11825n/a{
21825n/a "type": "string"
31825n/a}
page1 / 1
11564308{
21564308 "type": "integer"
31564308}
page_size1 / 1
11544322{
21544322 "type": "integer"
31544322}
username__icontains1 / 1
11723n/a{
21723n/a "type": "string"
31723n/a}
username__iendswith1 / 1
11760n/a{
21760n/a "type": "string"
31760n/a}
username__iexact1 / 1
11720n/a{
21720n/a "type": "string"
31720n/a}
username__istartswith1 / 1
11702n/a{
21702n/a "type": "string"
31702n/a}
Responses1 of 1 documented received
codedescriptionhitsavg
200179112ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found17164ms
401Unauthorized1144ms
400Bad Request764ms
Body83 of 87 keywords covered
application/json29 / 29
UserRequest
#validinvalidschema
1111789{
2112078 "properties": {
36197 "date_joined": {
46191 "format": "date-time",
56206 "type": "string"
66197 },
76197 "email": {
86197 "oneOf": [
9497129 {
10503123 "format": "email",
116201 "maxLength": 254,
126215 "type": "string"
13497129 },
14122504 {
15122499 "maxLength": 0,
166215 "type": "string"
17122504 }
186197 ],
196197 },
206266 "first_name": {
216261 "maxLength": 150,
226275 "type": "string"
236266 },
2464311 "groups": {
256436 "items": {
2631006 "type": "integer"
276436 },
286495 "type": "array"
2964311 },
306435 "is_active": {
316435 "type": "boolean"
326435 },
336445 "is_staff": {
346445 "type": "boolean"
356445 },
366105 "is_superuser": {
376105 "type": "boolean"
386105 },
396326 "last_name": {
406321 "maxLength": 150,
416335 "type": "string"
426326 },
437157 "password": {
447151 "minLength": 1,
457166 "type": "string"
467157 },
4761612 "user_permissions": {
486166 "items": {
4929131 "minLength": 1,
5029145 "type": "string"
516166 },
526226 "type": "array"
5361612 },
5411878 "username": {
5511891 "maxLength": 150,
5611891 "minLength": 1,
5711882 "pattern": "^[\\w.@+-]+$",
5811905 "type": "string"
5911878 }
60112078 },
6111954 "required": [
6211954 "username"
6311954 ],
6411997 "type": "object"
65111789}
application/x-www-form-urlencoded27 / 29
UserRequest
1870149{
2871147 "properties": {
34873 "date_joined": {
44873 "format": "date-time",
5490n/a "type": "string"
64873 },
74513 "email": {
84513 "oneOf": [
938173 {
1038272 "format": "email",
114531 "maxLength": 254,
12454n/a "type": "string"
1338173 },
1470384 {
1570384 "maxLength": 0,
16454n/a "type": "string"
1770384 }
184513 ],
194513 },
204553 "first_name": {
214553 "maxLength": 150,
22458n/a "type": "string"
234553 },
24260115 "groups": {
25260115 "items": {
262480130 "type": "integer"
27260115 },
283750 "type": "array"
29260115 },
304812 "is_active": {
314812 "type": "boolean"
324812 },
334592 "is_staff": {
344592 "type": "boolean"
354592 },
364572 "is_superuser": {
374572 "type": "boolean"
384572 },
394321 "last_name": {
404321 "maxLength": 150,
41433n/a "type": "string"
424321 },
436106 "password": {
446106 "minLength": 1,
45616n/a "type": "string"
466106 },
473792 "user_permissions": {
483792 "items": {
4923562 "minLength": 1,
502358n/a "type": "string"
513792 },
523810 "type": "array"
533792 },
5410089 "username": {
5510161 "maxLength": 150,
5610161 "minLength": 1,
5710098 "pattern": "^[\\w.@+-]+$",
581017n/a "type": "string"
5910089 }
60871147 },
6110172 "required": [
6210172 "username"
6310172 ],
641019n/a "type": "object"
65870149}
multipart/form-data27 / 29
UserRequest
163586{
263784 "properties": {
33561 "date_joined": {
43561 "format": "date-time",
5357n/a "type": "string"
63561 },
73302 "email": {
83302 "oneOf": [
927755 {
1027854 "format": "email",
113311 "maxLength": 254,
12332n/a "type": "string"
1327755 },
1453279 {
1553279 "maxLength": 0,
16332n/a "type": "string"
1753279 }
183302 ],
193302 },
203262 "first_name": {
213262 "maxLength": 150,
22328n/a "type": "string"
233262 },
2416858 "groups": {
2516858 "items": {
26132873 "type": "integer"
2716858 },
282260 "type": "array"
2916858 },
303385 "is_active": {
313385 "type": "boolean"
323385 },
333395 "is_staff": {
343395 "type": "boolean"
353395 },
364005 "is_superuser": {
374005 "type": "boolean"
384005 },
393641 "last_name": {
403641 "maxLength": 150,
41365n/a "type": "string"
423641 },
434121 "password": {
444121 "minLength": 1,
45413n/a "type": "string"
464121 },
472381 "user_permissions": {
482381 "items": {
4913291 "minLength": 1,
501330n/a "type": "string"
512381 },
522390 "type": "array"
532381 },
547163 "username": {
557181 "maxLength": 150,
567181 "minLength": 1,
577172 "pattern": "^[\\w.@+-]+$",
58719n/a "type": "string"
597163 }
6063784 },
617192 "required": [
627192 "username"
637192 ],
64721n/a "type": "object"
6563586}
Responses1 of 1 documented received
codedescriptionhitsavg
20113117ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request32244ms
500Internal Server Error64ms
41513ms
401Unauthorized1454ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11797{
21797 "type": "integer"
31797}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body5717ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1063ms
401Unauthorized1318ms
500Internal Server Error109ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
164027{
264027 "type": "integer"
364027}
Responses1 of 1 documented received
codedescriptionhitsavg
2002685ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3444ms
401Unauthorized556ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
192215{
292215 "type": "integer"
392215}
Body80 of 84 keywords covered
application/json28 / 28
PatchedUserRequest
137786{
236780 "properties": {
31616 "date_joined": {
41611 "format": "date-time",
51625 "type": "string"
61616 },
71417 "email": {
81417 "oneOf": [
912523 {
1013117 "format": "email",
111421 "maxLength": 254,
121435 "type": "string"
1312523 },
1416132 {
1516127 "maxLength": 0,
161435 "type": "string"
1716132 }
181417 ],
191417 },
201496 "first_name": {
211491 "maxLength": 150,
221505 "type": "string"
231496 },
2413811 "groups": {
251386 "items": {
262566 "type": "integer"
271386 },
281445 "type": "array"
2913811 },
301425 "is_active": {
311425 "type": "boolean"
321425 },
331415 "is_staff": {
341415 "type": "boolean"
351415 },
361395 "is_superuser": {
371395 "type": "boolean"
381395 },
391396 "last_name": {
401391 "maxLength": 150,
411405 "type": "string"
421396 },
431336 "password": {
441331 "minLength": 1,
451345 "type": "string"
461336 },
4712511 "user_permissions": {
481256 "items": {
491471 "minLength": 1,
501485 "type": "string"
511256 },
521315 "type": "array"
5312511 },
5441312 "username": {
554191 "maxLength": 150,
564191 "minLength": 1,
574146 "pattern": "^[\\w.@+-]+$",
584205 "type": "string"
5941312 }
6036780 },
614576 "type": "object"
6237786}
application/x-www-form-urlencoded26 / 28
PatchedUserRequest
116742{
216542 "properties": {
3921 "date_joined": {
4921 "format": "date-time",
593n/a "type": "string"
6921 },
711110 "email": {
811110 "oneOf": [
910219 {
1010318 "format": "email",
111192 "maxLength": 254,
12121n/a "type": "string"
1310219 },
149112 {
159112 "maxLength": 0,
16121n/a "type": "string"
179112 }
1811110 ],
1911110 },
201033 "first_name": {
211033 "maxLength": 150,
22106n/a "type": "string"
231033 },
245317 "groups": {
255317 "items": {
2640718 "type": "integer"
275317 },
28700 "type": "array"
295317 },
30942 "is_active": {
31942 "type": "boolean"
32942 },
331022 "is_staff": {
341022 "type": "boolean"
351022 },
36872 "is_superuser": {
37872 "type": "boolean"
38872 },
391102 "last_name": {
401102 "maxLength": 150,
41112n/a "type": "string"
421102 },
431112 "password": {
441112 "minLength": 1,
45113n/a "type": "string"
461112 },
47361 "user_permissions": {
48361 "items": {
491841 "minLength": 1,
50185n/a "type": "string"
51361 },
52370 "type": "array"
53361 },
541553 "username": {
551571 "maxLength": 150,
561571 "minLength": 1,
571562 "pattern": "^[\\w.@+-]+$",
58158n/a "type": "string"
591553 }
6016542 },
61209n/a "type": "object"
6216742}
multipart/form-data26 / 28
PatchedUserRequest
110339{
29439 "properties": {
31001 "date_joined": {
41001 "format": "date-time",
5101n/a "type": "string"
61001 },
7902 "email": {
8902 "oneOf": [
9839 {
10848 "format": "email",
11911 "maxLength": 254,
1292n/a "type": "string"
13839 },
14785 {
15785 "maxLength": 0,
1692n/a "type": "string"
17785 }
18902 ],
19902 },
20941 "first_name": {
21941 "maxLength": 150,
2295n/a "type": "string"
23941 },
241113 "groups": {
251113 "items": {
264413 "type": "integer"
271113 },
28240 "type": "array"
291113 },
30925 "is_active": {
31925 "type": "boolean"
32925 },
33935 "is_staff": {
34935 "type": "boolean"
35935 },
36836 "is_superuser": {
37836 "type": "boolean"
38836 },
39852 "last_name": {
40852 "maxLength": 150,
4187n/a "type": "string"
42852 },
43861 "password": {
44861 "minLength": 1,
4587n/a "type": "string"
46861 },
47381 "user_permissions": {
48381 "items": {
491831 "minLength": 1,
50184n/a "type": "string"
51381 },
52390 "type": "array"
53381 },
541093 "username": {
551111 "maxLength": 150,
561111 "minLength": 1,
571102 "pattern": "^[\\w.@+-]+$",
58112n/a "type": "string"
591093 }
609439 },
61142n/a "type": "object"
6210339}
Responses1 of 1 documented received
codedescriptionhitsavg
20015314ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3894ms
400Bad Request3595ms
401Unauthorized318ms
500Internal Server Error46ms
41513ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
18839{
28839 "type": "integer"
38839}
Body83 of 87 keywords covered
application/json29 / 29
UserRequest
122386{
222579 "properties": {
31468 "date_joined": {
41462 "format": "date-time",
51486 "type": "string"
61468 },
71478 "email": {
81478 "oneOf": [
913817 {
1014411 "format": "email",
111491 "maxLength": 254,
121505 "type": "string"
1313817 },
149146 {
159141 "maxLength": 0,
161505 "type": "string"
179146 }
181478 ],
191478 },
201367 "first_name": {
211362 "maxLength": 150,
221385 "type": "string"
231367 },
2413712 "groups": {
251377 "items": {
261987 "type": "integer"
271377 },
281445 "type": "array"
2913712 },
301395 "is_active": {
311395 "type": "boolean"
321395 },
331376 "is_staff": {
341376 "type": "boolean"
351376 },
361416 "is_superuser": {
371416 "type": "boolean"
381416 },
391447 "last_name": {
401441 "maxLength": 150,
411456 "type": "string"
421447 },
431906 "password": {
441901 "minLength": 1,
451915 "type": "string"
461906 },
4714012 "user_permissions": {
481406 "items": {
491761 "minLength": 1,
501775 "type": "string"
511406 },
521466 "type": "array"
5314012 },
542948 "username": {
552961 "maxLength": 150,
562961 "minLength": 1,
572952 "pattern": "^[\\w.@+-]+$",
582975 "type": "string"
592948 }
6022579 },
613022 "required": [
623022 "username"
633022 ],
643045 "type": "object"
6522386}
application/x-www-form-urlencoded27 / 29
UserRequest
119332{
219530 "properties": {
31711 "date_joined": {
41711 "format": "date-time",
5172n/a "type": "string"
61711 },
71242 "email": {
81242 "oneOf": [
910422 {
1010521 "format": "email",
111251 "maxLength": 254,
12126n/a "type": "string"
1310422 },
1420106 {
1520106 "maxLength": 0,
16126n/a "type": "string"
1720106 }
181242 ],
191242 },
201081 "first_name": {
211081 "maxLength": 150,
22109n/a "type": "string"
231081 },
243614 "groups": {
253614 "items": {
2625316 "type": "integer"
273614 },
28500 "type": "array"
293614 },
301162 "is_active": {
311162 "type": "boolean"
321162 },
331072 "is_staff": {
341072 "type": "boolean"
351072 },
361132 "is_superuser": {
371132 "type": "boolean"
381132 },
391151 "last_name": {
401151 "maxLength": 150,
41116n/a "type": "string"
421151 },
431781 "password": {
441781 "minLength": 1,
45179n/a "type": "string"
461781 },
47631 "user_permissions": {
48631 "items": {
494121 "minLength": 1,
50413n/a "type": "string"
51631 },
52640 "type": "array"
53631 },
542203 "username": {
552221 "maxLength": 150,
562221 "minLength": 1,
572212 "pattern": "^[\\w.@+-]+$",
58223n/a "type": "string"
592203 }
6019530 },
612232 "required": [
622232 "username"
632232 ],
64225n/a "type": "object"
6519332}
multipart/form-data27 / 29
UserRequest
112753{
212852 "properties": {
3991 "date_joined": {
4991 "format": "date-time",
5100n/a "type": "string"
6991 },
71002 "email": {
81002 "oneOf": [
9939 {
10948 "format": "email",
111011 "maxLength": 254,
12102n/a "type": "string"
13939 },
14795 {
15795 "maxLength": 0,
16102n/a "type": "string"
17795 }
181002 ],
191002 },
201031 "first_name": {
211031 "maxLength": 150,
22104n/a "type": "string"
231031 },
24926 "groups": {
25926 "items": {
2614526 "type": "integer"
27926 },
28350 "type": "array"
29926 },
30905 "is_active": {
31905 "type": "boolean"
32905 },
33895 "is_staff": {
34895 "type": "boolean"
35895 },
361375 "is_superuser": {
371375 "type": "boolean"
381375 },
39941 "last_name": {
40941 "maxLength": 150,
4195n/a "type": "string"
42941 },
431541 "password": {
441541 "minLength": 1,
45155n/a "type": "string"
461541 },
47252 "user_permissions": {
48252 "items": {
49792 "minLength": 1,
5081n/a "type": "string"
51252 },
52270 "type": "array"
53252 },
541763 "username": {
551781 "maxLength": 150,
561781 "minLength": 1,
571772 "pattern": "^[\\w.@+-]+$",
58179n/a "type": "string"
591763 }
6012852 },
611791 "required": [
621791 "username"
631791 ],
64180n/a "type": "object"
6512753}
Responses1 of 1 documented received
codedescriptionhitsavg
200212ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3425ms
404Not Found4503ms
500Internal Server Error45ms
41514ms
401Unauthorized934ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168714{
268714 "type": "integer"
368714}
Responses1 of 2 documented received
codedescriptionhitsavg
2000never seen
4044744ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1734ms
403Forbidden12ms
401Unauthorized532ms
workflow_actions 6 operations 3 covered 3 partial 0 uncovered 0 not measured 67% #
Query Parameters2 of 2 keywords covered
page1 / 1
#validinvalidschema
11404473{
21404473 "type": "integer"
31404473}
page_size1 / 1
11476449{
21476449 "type": "integer"
31476449}
Responses1 of 1 documented received
codedescriptionhitsavg
200159431ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1474ms
404Not Found17644ms
Body201 of 297 keywords covered
application/json99 / 99
WorkflowActionRequest
#validinvalidschema
112471135{
29281125 "properties": {
3112412 "ai_create_missing": {
4112412 "type": "boolean"
5112412 },
6108610 "ai_overwrite_existing": {
7108610 "type": "boolean"
8108610 },
9938n/a "ai_suggestion_fields": {
10938n/a "nullable": true
11938n/a },
12109824 "assign_change_groups": {
13109812 "items": {
14100712 "type": "integer"
15109812 },
16111012 "type": "array"
17109824 },
18107823 "assign_change_users": {
19107812 "items": {
2073112 "type": "integer"
21107812 },
22109011 "type": "array"
23107823 },
24109112 "assign_correspondent": {
251103n/a "nullable": true,
26109112 "type": "integer"
27109112 },
28106922 "assign_custom_fields": {
29106912 "items": {
3098512 "type": "integer"
31106912 },
32108110 "type": "array"
33106922 },
34928n/a "assign_custom_fields_values": {
35928n/a "nullable": true,
36928n/a },
37113311 "assign_document_type": {
381144n/a "nullable": true,
39113311 "type": "integer"
40113311 },
41105723 "assign_owner": {
421080n/a "nullable": true,
43105723 "type": "integer"
44105723 },
45105318 "assign_storage_path": {
461071n/a "nullable": true,
47105318 "type": "integer"
48105318 },
49105532 "assign_tags": {
50105515 "items": {
51650n/a "nullable": true,
5262624 "type": "integer"
53105515 },
54107017 "type": "array"
55105532 },
5610599 "assign_title": {
571068n/a "nullable": true,
5810599 "type": "string"
5910599 },
60105223 "assign_view_groups": {
61105213 "items": {
6269814 "type": "integer"
63105213 },
64106510 "type": "array"
65105223 },
66108438 "assign_view_users": {
67108427 "items": {
6893265 "type": "integer"
69108427 },
70111111 "type": "array"
71108438 },
72108991 "email": {
731n/a "allOf": [
74108991 {
75108991 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
76108991 }
771n/a ],
781099n/a "nullable": true
79108991 },
80106318 "id": {
811081n/a "nullable": true,
82106318 "type": "integer"
83106318 },
84908n/a "passwords": {
85908n/a "nullable": true
86908n/a },
87104310 "remove_all_correspondents": {
88104310 "type": "boolean"
89104310 },
90103925 "remove_all_custom_fields": {
91103925 "type": "boolean"
92103925 },
93108812 "remove_all_document_types": {
94108812 "type": "boolean"
95108812 },
96102412 "remove_all_owners": {
97102412 "type": "boolean"
98102412 },
99104010 "remove_all_permissions": {
100104010 "type": "boolean"
101104010 },
102102210 "remove_all_storage_paths": {
103102210 "type": "boolean"
104102210 },
105102710 "remove_all_tags": {
106102710 "type": "boolean"
107102710 },
108103822 "remove_change_groups": {
109103812 "items": {
11061812 "type": "integer"
111103812 },
112105010 "type": "array"
113103822 },
114103022 "remove_change_users": {
115103012 "items": {
11669812 "type": "integer"
117103012 },
118104210 "type": "array"
119103022 },
120100122 "remove_correspondents": {
121100112 "items": {
12271812 "type": "integer"
123100112 },
124101310 "type": "array"
125100122 },
12699629 "remove_custom_fields": {
12799619 "items": {
12877038 "type": "integer"
12999619 },
130101510 "type": "array"
13199629 },
132103123 "remove_document_types": {
133103112 "items": {
13488112 "type": "integer"
135103112 },
136104311 "type": "array"
137103123 },
138103322 "remove_owners": {
139103312 "items": {
14065412 "type": "integer"
141103312 },
142104510 "type": "array"
143103322 },
144101124 "remove_storage_paths": {
145101113 "items": {
14658115 "type": "integer"
147101113 },
148102411 "type": "array"
149101124 },
150104124 "remove_tags": {
151104113 "items": {
152101315 "type": "integer"
153104113 },
154105411 "type": "array"
155104124 },
156101922 "remove_view_groups": {
157101912 "items": {
15882212 "type": "integer"
159101912 },
160103110 "type": "array"
161101922 },
16296023 "remove_view_users": {
16396012 "items": {
16445812 "type": "integer"
16596012 },
16697211 "type": "array"
16796023 },
168104823 "type": {
1691n/a "allOf": [
170104823 {
171104823 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
172104823 }
1731n/a ],
17410529 "maximum": 9223372036854775807,
17510592 "minimum": 0,
176104823 },
177130876 "webhook": {
1781n/a "allOf": [
179130876 {
180130876 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
181130876 }
1821n/a ],
1831006n/a "nullable": true
184130876 }
1859281125 },
186237210 "type": "object"
18712471135}
Referenced Components (3)35 of 35 keywords
WorkflowActionEmailRequest15 of 15 keywords
1108991{
211463 "properties": {
316312 "body": {
41632 "minLength": 1,
516510 "type": "string"
616312 },
711910 "id": {
8129n/a "nullable": true,
911910 "type": "integer"
1011910 },
1111711 "include_document": {
1211711 "type": "boolean"
1311711 },
1415718 "subject": {
151596 "maxLength": 256,
161632 "minLength": 1,
1716510 "type": "string"
1815718 },
1916312 "to": {
201632 "minLength": 1,
2116510 "type": "string"
2216312 }
2311463 },
241718 "required": [
251754 "body",
261754 "subject",
271754 "to"
281718 ],
29179920 "type": "object"
30108991}
WorkflowActionTypeEnum3 of 3 keywords
1104823{
2104823 "enum": [
3882n/a 1,
423n/a 2,
528n/a 3,
633n/a 4,
719n/a 5,
830n/a 6,
921n/a 7,
1012n/a 8
11104823 ],
12105912 "type": "integer"
13104823}
WorkflowActionWebhookRequest17 of 17 keywords
1130876{
213265 "properties": {
314210 "as_json": {
414210 "type": "boolean"
514210 },
61528 "body": {
7160n/a "nullable": true,
81528 "type": "string"
91528 },
10117n/a "headers": {
11117n/a "nullable": true,
12117n/a },
1313912 "id": {
14151n/a "nullable": true,
1513912 "type": "integer"
1613912 },
1713611 "include_document": {
1813611 "type": "boolean"
1913611 },
20110n/a "params": {
21110n/a "nullable": true,
22110n/a },
2318114 "url": {
241832 "maxLength": 256,
251832 "minLength": 1,
2618510 "type": "string"
2718114 },
2812710 "use_params": {
2912710 "type": "boolean"
3012710 }
3113265 },
321954 "required": [
331954 "url"
341954 ],
35199807 "type": "object"
36130876}
application/x-www-form-urlencoded51 / 99
WorkflowActionRequest
15141172{
23391172 "properties": {
38514 "ai_create_missing": {
48514 "type": "boolean"
58514 },
68654 "ai_overwrite_existing": {
78654 "type": "boolean"
88654 },
9664n/a "ai_suggestion_fields": {
10664n/a "nullable": true
11664n/a },
1211327 "assign_change_groups": {
1311327 "items": {
1453628 "type": "integer"
1511327 },
161400 "type": "array"
1711327 },
187535 "assign_change_users": {
197535 "items": {
2048244 "type": "integer"
217535 },
221100 "type": "array"
237535 },
2478748 "assign_correspondent": {
25826n/a "nullable": true,
2678748 "type": "integer"
2778748 },
2810535 "assign_custom_fields": {
2910535 "items": {
3071245 "type": "integer"
3110535 },
321400 "type": "array"
3310535 },
34654n/a "assign_custom_fields_values": {
35654n/a "nullable": true,
36654n/a },
3777751 "assign_document_type": {
38828n/a "nullable": true,
3977751 "type": "integer"
4077751 },
4172746 "assign_owner": {
42818n/a "nullable": true,
4372746 "type": "integer"
4472746 },
4571732 "assign_storage_path": {
46803n/a "nullable": true,
4771732 "type": "integer"
4871732 },
4916129 "assign_tags": {
5016129 "items": {
51738n/a "nullable": true,
52337401 "type": "integer"
5316129 },
541450 "type": "array"
5516129 },
56816n/a "assign_title": {
57816n/a "nullable": true,
58816n/a "type": "string"
59816n/a },
608451 "assign_view_groups": {
618451 "items": {
6278567 "type": "integer"
638451 },
641350 "type": "array"
658451 },
669948 "assign_view_users": {
679948 "items": {
6882453 "type": "integer"
699948 },
701470 "type": "array"
719948 },
720678 "email": {
730n/a "allOf": [
740678 {
750678 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
760678 }
770n/a ],
78678n/a "nullable": true
790678 },
8088741 "id": {
81829n/a "nullable": true,
8288741 "type": "integer"
8388741 },
84634n/a "passwords": {
85634n/a "nullable": true
86634n/a },
877774 "remove_all_correspondents": {
887774 "type": "boolean"
897774 },
907724 "remove_all_custom_fields": {
917724 "type": "boolean"
927724 },
937594 "remove_all_document_types": {
947594 "type": "boolean"
957594 },
967764 "remove_all_owners": {
977764 "type": "boolean"
987764 },
997674 "remove_all_permissions": {
1007674 "type": "boolean"
1017674 },
1027694 "remove_all_storage_paths": {
1037694 "type": "boolean"
1047694 },
1057564 "remove_all_tags": {
1067564 "type": "boolean"
1077564 },
10810630 "remove_change_groups": {
10910630 "items": {
11044232 "type": "integer"
11110630 },
1121360 "type": "array"
11310630 },
11410830 "remove_change_users": {
11510830 "items": {
11666634 "type": "integer"
11710830 },
1181380 "type": "array"
11910830 },
12011138 "remove_correspondents": {
12111138 "items": {
12260740 "type": "integer"
12311138 },
1241490 "type": "array"
12511138 },
12611939 "remove_custom_fields": {
12711939 "items": {
128105248 "type": "integer"
12911939 },
1301580 "type": "array"
13111939 },
13211625 "remove_document_types": {
13311625 "items": {
13460026 "type": "integer"
13511625 },
1361410 "type": "array"
13711625 },
1389733 "remove_owners": {
1399733 "items": {
14061634 "type": "integer"
1419733 },
1421300 "type": "array"
1439733 },
1449835 "remove_storage_paths": {
1459835 "items": {
14658044 "type": "integer"
1479835 },
1481330 "type": "array"
1499835 },
1509132 "remove_tags": {
1519132 "items": {
15247643 "type": "integer"
1539132 },
1541230 "type": "array"
1559132 },
1568942 "remove_view_groups": {
1578942 "items": {
15869045 "type": "integer"
1598942 },
1601310 "type": "array"
1618942 },
16212038 "remove_view_users": {
16312038 "items": {
16468947 "type": "integer"
16512038 },
1661580 "type": "array"
16712038 },
16875035 "type": {
1691n/a "allOf": [
17075035 {
17175035 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17275035 }
1731n/a ],
17476910 "maximum": 9223372036854775807,
17576712 "minimum": 0,
17675035 },
1770568 "webhook": {
1780n/a "allOf": [
1790568 {
1800568 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
1810568 }
1820n/a ],
183568n/a "nullable": true
1840568 }
1853391172 },
1861686n/a "type": "object"
1875141172}
Referenced Components (3)3 of 35 keywords
WorkflowActionEmailRequest0 of 15 keywords
10678{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
290678 "type": "object"
300678}
WorkflowActionTypeEnum3 of 3 keywords
175035{
275035 "enum": [
3609n/a 1,
433n/a 2,
510n/a 3,
616n/a 4,
719n/a 5,
831n/a 6,
918n/a 7,
1014n/a 8
1175035 ],
127796 "type": "integer"
1375035}
WorkflowActionWebhookRequest0 of 17 keywords
10568{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
350568 "type": "object"
360568}
multipart/form-data51 / 99
WorkflowActionRequest
13621319{
21881319 "properties": {
3102211 "ai_create_missing": {
4102211 "type": "boolean"
5102211 },
6103010 "ai_overwrite_existing": {
7103010 "type": "boolean"
8103010 },
9944n/a "ai_suggestion_fields": {
10944n/a "nullable": true
11944n/a },
124345 "assign_change_groups": {
134345 "items": {
1432659 "type": "integer"
154345 },
16880 "type": "array"
174345 },
185834 "assign_change_users": {
195834 "items": {
2038436 "type": "integer"
215834 },
22920 "type": "array"
235834 },
2450996 "assign_correspondent": {
251046n/a "nullable": true,
2650996 "type": "integer"
2750996 },
286436 "assign_custom_fields": {
296436 "items": {
3045140 "type": "integer"
316436 },
321000 "type": "array"
336436 },
34934n/a "assign_custom_fields_values": {
35934n/a "nullable": true,
36934n/a },
3737970 "assign_document_type": {
381007n/a "nullable": true,
3937970 "type": "integer"
4037970 },
4140994 "assign_owner": {
421034n/a "nullable": true,
4340994 "type": "integer"
4440994 },
4537982 "assign_storage_path": {
461019n/a "nullable": true,
4737982 "type": "integer"
4837982 },
491465 "assign_tags": {
501465 "items": {
51251n/a "nullable": true,
52111140 "type": "integer"
531465 },
54790 "type": "array"
551465 },
561021n/a "assign_title": {
571021n/a "nullable": true,
581021n/a "type": "string"
591021n/a },
607138 "assign_view_groups": {
617138 "items": {
6239139 "type": "integer"
637138 },
641090 "type": "array"
657138 },
666045 "assign_view_users": {
676045 "items": {
6838051 "type": "integer"
696045 },
701050 "type": "array"
716045 },
7201013 "email": {
730n/a "allOf": [
7401013 {
7501013 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7601013 }
770n/a ],
781013n/a "nullable": true
7901013 },
8062949 "id": {
811011n/a "nullable": true,
8262949 "type": "integer"
8362949 },
84914n/a "passwords": {
85914n/a "nullable": true
86914n/a },
8796011 "remove_all_correspondents": {
8896011 "type": "boolean"
8996011 },
90100610 "remove_all_custom_fields": {
91100610 "type": "boolean"
92100610 },
9395210 "remove_all_document_types": {
9495210 "type": "boolean"
9595210 },
9699710 "remove_all_owners": {
9799710 "type": "boolean"
9899710 },
99100610 "remove_all_permissions": {
100100610 "type": "boolean"
101100610 },
10297410 "remove_all_storage_paths": {
10397410 "type": "boolean"
10497410 },
10596110 "remove_all_tags": {
10696110 "type": "boolean"
10796110 },
1084340 "remove_change_groups": {
1094340 "items": {
11036543 "type": "integer"
1114340 },
112830 "type": "array"
1134340 },
1146044 "remove_change_users": {
1156044 "items": {
11636053 "type": "integer"
1176044 },
1181040 "type": "array"
1196044 },
1204931 "remove_correspondents": {
1214931 "items": {
12232731 "type": "integer"
1234931 },
124800 "type": "array"
1254931 },
1265733 "remove_custom_fields": {
1275733 "items": {
12830235 "type": "integer"
1295733 },
130900 "type": "array"
1315733 },
1327543 "remove_document_types": {
1337543 "items": {
13468262 "type": "integer"
1357543 },
1361180 "type": "array"
1377543 },
1385236 "remove_owners": {
1395236 "items": {
14029337 "type": "integer"
1415236 },
142880 "type": "array"
1435236 },
1446933 "remove_storage_paths": {
1456933 "items": {
14639245 "type": "integer"
1476933 },
1481020 "type": "array"
1496933 },
1506139 "remove_tags": {
1516139 "items": {
15235844 "type": "integer"
1536139 },
1541000 "type": "array"
1556139 },
1565344 "remove_view_groups": {
1575344 "items": {
15853450 "type": "integer"
1595344 },
160970 "type": "array"
1615344 },
1626140 "remove_view_users": {
1636140 "items": {
16430142 "type": "integer"
1656140 },
1661010 "type": "array"
1676140 },
16894920 "type": {
1691n/a "allOf": [
17094920 {
17194920 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17294920 }
1731n/a ],
1749552 "maximum": 9223372036854775807,
1759516 "minimum": 0,
17694920 },
17701004 "webhook": {
1780n/a "allOf": [
17901004 {
18001004 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18101004 }
1820n/a ],
1831004n/a "nullable": true
18401004 }
1851881319 },
1861681n/a "type": "object"
1873621319}
Referenced Components (3)3 of 35 keywords
WorkflowActionEmailRequest0 of 15 keywords
101013{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2901013 "type": "object"
3001013}
WorkflowActionTypeEnum3 of 3 keywords
194920{
294920 "enum": [
3858n/a 1,
47n/a 2,
513n/a 3,
69n/a 4,
76n/a 5,
832n/a 6,
910n/a 7,
1014n/a 8
1194920 ],
1295712 "type": "integer"
1394920}
WorkflowActionWebhookRequest0 of 17 keywords
101004{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3501004 "type": "object"
3601004}
Responses1 of 1 documented received
codedescriptionhitsavg
201171720ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request46865ms
401Unauthorized1504ms
500Internal Server Error607ms
415212ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
142818{
242818 "type": "integer"
342818}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body15017ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2153ms
401Unauthorized815ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
17598{
27598 "type": "integer"
37598}
Responses1 of 1 documented received
codedescriptionhitsavg
2003609ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3003ms
401Unauthorized1074ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1212117{
2212117 "type": "integer"
3212117}
Body201 of 297 keywords covered
application/json99 / 99
PatchedWorkflowActionRequest
1328484{
2148478 "properties": {
34955 "ai_create_missing": {
44955 "type": "boolean"
54955 },
64805 "ai_overwrite_existing": {
74805 "type": "boolean"
84805 },
9474n/a "ai_suggestion_fields": {
10474n/a "nullable": true
11474n/a },
1248411 "assign_change_groups": {
134846 "items": {
141526 "type": "integer"
154846 },
164905 "type": "array"
1748411 },
1847311 "assign_change_users": {
194736 "items": {
20636 "type": "integer"
214736 },
224795 "type": "array"
2347311 },
244765 "assign_correspondent": {
25481n/a "nullable": true,
264765 "type": "integer"
274765 },
2847111 "assign_custom_fields": {
294716 "items": {
30456 "type": "integer"
314716 },
324775 "type": "array"
3347111 },
34469n/a "assign_custom_fields_values": {
35469n/a "nullable": true,
36469n/a },
374785 "assign_document_type": {
38483n/a "nullable": true,
394785 "type": "integer"
404785 },
414766 "assign_owner": {
42482n/a "nullable": true,
434766 "type": "integer"
444766 },
454817 "assign_storage_path": {
46488n/a "nullable": true,
474817 "type": "integer"
484817 },
4946010 "assign_tags": {
504605 "items": {
5135n/a "nullable": true,
52305 "type": "integer"
534605 },
544655 "type": "array"
5546010 },
564724 "assign_title": {
57476n/a "nullable": true,
584724 "type": "string"
594724 },
6046412 "assign_view_groups": {
614647 "items": {
624924 "type": "integer"
634647 },
644715 "type": "array"
6546412 },
6646517 "assign_view_users": {
674656 "items": {
681356 "type": "integer"
694656 },
7047111 "type": "array"
7146517 },
7220457 "email": {
731n/a "allOf": [
7420457 {
7520457 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7620457 }
771n/a ],
78477n/a "nullable": true
7920457 },
804855 "id": {
81490n/a "nullable": true,
824855 "type": "integer"
834855 },
84459n/a "passwords": {
85459n/a "nullable": true
86459n/a },
874676 "remove_all_correspondents": {
884676 "type": "boolean"
894676 },
904625 "remove_all_custom_fields": {
914625 "type": "boolean"
924625 },
934595 "remove_all_document_types": {
944595 "type": "boolean"
954595 },
964625 "remove_all_owners": {
974625 "type": "boolean"
984625 },
994605 "remove_all_permissions": {
1004605 "type": "boolean"
1014605 },
1024656 "remove_all_storage_paths": {
1034656 "type": "boolean"
1044656 },
1054635 "remove_all_tags": {
1064635 "type": "boolean"
1074635 },
10844911 "remove_change_groups": {
1094496 "items": {
110216 "type": "integer"
1114496 },
1124555 "type": "array"
11344911 },
11445711 "remove_change_users": {
1154576 "items": {
1161066 "type": "integer"
1174576 },
1184635 "type": "array"
11945711 },
12045111 "remove_correspondents": {
1214516 "items": {
122876 "type": "integer"
1234516 },
1244575 "type": "array"
12545111 },
12645311 "remove_custom_fields": {
1274536 "items": {
1281576 "type": "integer"
1294536 },
1304595 "type": "array"
13145311 },
13245311 "remove_document_types": {
1334536 "items": {
1341846 "type": "integer"
1354536 },
1364595 "type": "array"
13745311 },
13844811 "remove_owners": {
1394486 "items": {
140376 "type": "integer"
1414486 },
1424545 "type": "array"
14344811 },
14445011 "remove_storage_paths": {
1454506 "items": {
1461456 "type": "integer"
1474506 },
1484565 "type": "array"
14945011 },
15045211 "remove_tags": {
1514526 "items": {
1521016 "type": "integer"
1534526 },
1544585 "type": "array"
15545211 },
15644711 "remove_view_groups": {
1574476 "items": {
158606 "type": "integer"
1594476 },
1604535 "type": "array"
16144711 },
16245111 "remove_view_users": {
1634516 "items": {
1641496 "type": "integer"
1654516 },
1664575 "type": "array"
16745111 },
1684428 "type": {
1691n/a "allOf": [
1704428 {
1714428 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
1724428 }
1731n/a ],
1744441 "maximum": 9223372036854775807,
1754441 "minimum": 0,
1764428 },
17739416 "webhook": {
1781n/a "allOf": [
17939416 {
18039416 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18139416 }
1821n/a ],
183455n/a "nullable": true
18439416 }
185148478 },
1868066 "type": "object"
187328484}
Referenced Components (3)35 of 35 keywords
WorkflowActionEmailRequest15 of 15 keywords
120457{
22330 "properties": {
3466 "body": {
4461 "minLength": 1,
5475 "type": "string"
6466 },
7386 "id": {
844n/a "nullable": true,
9386 "type": "integer"
10386 },
11395 "include_document": {
12395 "type": "boolean"
13395 },
14457 "subject": {
15461 "maxLength": 256,
16461 "minLength": 1,
17475 "type": "string"
18457 },
19466 "to": {
20461 "minLength": 1,
21475 "type": "string"
22466 }
232330 },
24504 "required": [
25522 "body",
26522 "subject",
27522 "to"
28504 ],
2954423 "type": "object"
3020457}
WorkflowActionTypeEnum3 of 3 keywords
14428{
24428 "enum": [
3426n/a 1,
43n/a 2,
52n/a 3,
61n/a 4,
71n/a 5,
81n/a 6,
91n/a 7,
107n/a 8
114428 ],
124446 "type": "integer"
134428}
WorkflowActionWebhookRequest17 of 17 keywords
139416{
24038 "properties": {
3565 "as_json": {
4565 "type": "boolean"
5565 },
6575 "body": {
762n/a "nullable": true,
8575 "type": "string"
9575 },
1058n/a "headers": {
1158n/a "nullable": true,
1258n/a },
135511 "id": {
1466n/a "nullable": true,
155511 "type": "integer"
165511 },
17555 "include_document": {
18555 "type": "boolean"
19555 },
2055n/a "params": {
2155n/a "nullable": true,
2255n/a },
23707 "url": {
24711 "maxLength": 256,
25711 "minLength": 1,
26725 "type": "string"
27707 },
28545 "use_params": {
29545 "type": "boolean"
30545 }
314038 },
32772 "required": [
33772 "url"
34772 ],
3579376 "type": "object"
3639416}
application/x-www-form-urlencoded51 / 99
PatchedWorkflowActionRequest
195396{
259396 "properties": {
33542 "ai_create_missing": {
43542 "type": "boolean"
53542 },
63452 "ai_overwrite_existing": {
73452 "type": "boolean"
83452 },
9332n/a "ai_suggestion_fields": {
10332n/a "nullable": true
11332n/a },
1297 "assign_change_groups": {
1397 "items": {
14497 "type": "integer"
1597 },
16160 "type": "array"
1797 },
18238 "assign_change_users": {
19238 "items": {
20968 "type": "integer"
21238 },
22310 "type": "array"
23238 },
2416334 "assign_correspondent": {
25350n/a "nullable": true,
2616334 "type": "integer"
2716334 },
28118 "assign_custom_fields": {
29118 "items": {
30718 "type": "integer"
31118 },
32190 "type": "array"
33118 },
34327n/a "assign_custom_fields_values": {
35327n/a "nullable": true,
36327n/a },
3710335 "assign_document_type": {
38345n/a "nullable": true,
3910335 "type": "integer"
4010335 },
415327 "assign_owner": {
42332n/a "nullable": true,
435327 "type": "integer"
445327 },
4514340 "assign_storage_path": {
46354n/a "nullable": true,
4714340 "type": "integer"
4814340 },
49216 "assign_tags": {
50216 "items": {
5186n/a "nullable": true,
523551 "type": "integer"
53216 },
54180 "type": "array"
55216 },
56337n/a "assign_title": {
57337n/a "nullable": true,
58337n/a "type": "string"
59337n/a },
60819 "assign_view_groups": {
61819 "items": {
6210620 "type": "integer"
63819 },
64270 "type": "array"
65819 },
6698 "assign_view_users": {
6798 "items": {
68518 "type": "integer"
6998 },
70170 "type": "array"
7198 },
720305 "email": {
730n/a "allOf": [
740305 {
750305 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
760305 }
770n/a ],
78305n/a "nullable": true
790305 },
8021328 "id": {
81349n/a "nullable": true,
8221328 "type": "integer"
8321328 },
84317n/a "passwords": {
85317n/a "nullable": true
86317n/a },
873312 "remove_all_correspondents": {
883312 "type": "boolean"
893312 },
903282 "remove_all_custom_fields": {
913282 "type": "boolean"
923282 },
933262 "remove_all_document_types": {
943262 "type": "boolean"
953262 },
963302 "remove_all_owners": {
973302 "type": "boolean"
983302 },
993222 "remove_all_permissions": {
1003222 "type": "boolean"
1013222 },
1023162 "remove_all_storage_paths": {
1033162 "type": "boolean"
1043162 },
1053162 "remove_all_tags": {
1063162 "type": "boolean"
1073162 },
108178 "remove_change_groups": {
109178 "items": {
110478 "type": "integer"
111178 },
112250 "type": "array"
113178 },
11497 "remove_change_users": {
11597 "items": {
116517 "type": "integer"
11797 },
118160 "type": "array"
11997 },
120713 "remove_correspondents": {
121713 "items": {
1229713 "type": "integer"
123713 },
124200 "type": "array"
125713 },
126116 "remove_custom_fields": {
127116 "items": {
128586 "type": "integer"
129116 },
130170 "type": "array"
131116 },
13276 "remove_document_types": {
13376 "items": {
134386 "type": "integer"
13576 },
136130 "type": "array"
13776 },
138157 "remove_owners": {
139157 "items": {
140407 "type": "integer"
141157 },
142220 "type": "array"
143157 },
144913 "remove_storage_paths": {
145913 "items": {
1469014 "type": "integer"
147913 },
148220 "type": "array"
149913 },
150712 "remove_tags": {
151712 "items": {
1528515 "type": "integer"
153712 },
154190 "type": "array"
155712 },
156127 "remove_view_groups": {
157127 "items": {
158397 "type": "integer"
159127 },
160190 "type": "array"
161127 },
162138 "remove_view_users": {
163138 "items": {
164748 "type": "integer"
165138 },
166210 "type": "array"
167138 },
1683075 "type": {
1691n/a "allOf": [
1703075 {
1713075 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
1723075 }
1731n/a ],
1743081 "maximum": 9223372036854775807,
1753081 "minimum": 0,
1763075 },
1770260 "webhook": {
1780n/a "allOf": [
1790260 {
1800260 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
1810260 }
1820n/a ],
183260n/a "nullable": true
1840260 }
18559396 },
186491n/a "type": "object"
18795396}
Referenced Components (3)3 of 35 keywords
WorkflowActionEmailRequest0 of 15 keywords
10305{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
290305 "type": "object"
300305}
WorkflowActionTypeEnum3 of 3 keywords
13075{
23075 "enum": [
3290n/a 1,
42n/a 2,
52n/a 3,
64n/a 4,
73n/a 5,
82n/a 6,
92n/a 7,
102n/a 8
113075 ],
123093 "type": "integer"
133075}
WorkflowActionWebhookRequest0 of 17 keywords
10260{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
350260 "type": "object"
360260}
multipart/form-data51 / 99
PatchedWorkflowActionRequest
187520{
231520 "properties": {
34735 "ai_create_missing": {
44735 "type": "boolean"
54735 },
64805 "ai_overwrite_existing": {
74805 "type": "boolean"
84805 },
9472n/a "ai_suggestion_fields": {
10472n/a "nullable": true
11472n/a },
12512 "assign_change_groups": {
13512 "items": {
141813 "type": "integer"
15512 },
16170 "type": "array"
17512 },
18415 "assign_change_users": {
19415 "items": {
202521 "type": "integer"
21415 },
22190 "type": "array"
23415 },
242474 "assign_correspondent": {
25476n/a "nullable": true,
262474 "type": "integer"
272474 },
28612 "assign_custom_fields": {
29612 "items": {
303314 "type": "integer"
31612 },
32180 "type": "array"
33612 },
34467n/a "assign_custom_fields_values": {
35467n/a "nullable": true,
36467n/a },
375471 "assign_document_type": {
38476n/a "nullable": true,
395471 "type": "integer"
405471 },
416465 "assign_owner": {
42471n/a "nullable": true,
436465 "type": "integer"
446465 },
452474 "assign_storage_path": {
46476n/a "nullable": true,
472474 "type": "integer"
482474 },
49325 "assign_tags": {
50325 "items": {
5175n/a "nullable": true,
522649 "type": "integer"
53325 },
54280 "type": "array"
55325 },
56473n/a "assign_title": {
57473n/a "nullable": true,
58473n/a "type": "string"
59473n/a },
60617 "assign_view_groups": {
61617 "items": {
625834 "type": "integer"
63617 },
64230 "type": "array"
65617 },
66511 "assign_view_users": {
67511 "items": {
681711 "type": "integer"
69511 },
70160 "type": "array"
71511 },
720471 "email": {
730n/a "allOf": [
740471 {
750471 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
760471 }
770n/a ],
78471n/a "nullable": true
790471 },
809463 "id": {
81472n/a "nullable": true,
829463 "type": "integer"
839463 },
84457n/a "passwords": {
85457n/a "nullable": true
86457n/a },
874555 "remove_all_correspondents": {
884555 "type": "boolean"
894555 },
904565 "remove_all_custom_fields": {
914565 "type": "boolean"
924565 },
934535 "remove_all_document_types": {
944535 "type": "boolean"
954535 },
964555 "remove_all_owners": {
974555 "type": "boolean"
984555 },
994515 "remove_all_permissions": {
1004515 "type": "boolean"
1014515 },
1024515 "remove_all_storage_paths": {
1034515 "type": "boolean"
1044515 },
1054555 "remove_all_tags": {
1064555 "type": "boolean"
1074555 },
108511 "remove_change_groups": {
109511 "items": {
1101311 "type": "integer"
111511 },
112160 "type": "array"
113511 },
114717 "remove_change_users": {
115717 "items": {
1164417 "type": "integer"
117717 },
118240 "type": "array"
119717 },
120712 "remove_correspondents": {
121712 "items": {
1222312 "type": "integer"
123712 },
124190 "type": "array"
125712 },
126811 "remove_custom_fields": {
127811 "items": {
1284111 "type": "integer"
129811 },
130190 "type": "array"
131811 },
132411 "remove_document_types": {
133411 "items": {
1341511 "type": "integer"
135411 },
136150 "type": "array"
137411 },
138512 "remove_owners": {
139512 "items": {
1401912 "type": "integer"
141512 },
142170 "type": "array"
143512 },
144411 "remove_storage_paths": {
145411 "items": {
146711 "type": "integer"
147411 },
148150 "type": "array"
149411 },
1501319 "remove_tags": {
1511319 "items": {
1529219 "type": "integer"
1531319 },
154320 "type": "array"
1551319 },
156212 "remove_view_groups": {
157212 "items": {
158712 "type": "integer"
159212 },
160140 "type": "array"
161212 },
162611 "remove_view_users": {
163611 "items": {
1642011 "type": "integer"
165611 },
166170 "type": "array"
167611 },
1684368 "type": {
1691n/a "allOf": [
1704368 {
1714368 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
1724368 }
1731n/a ],
1744371 "maximum": 9223372036854775807,
1754371 "minimum": 0,
1764368 },
1770455 "webhook": {
1780n/a "allOf": [
1790455 {
1800455 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
1810455 }
1820n/a ],
183455n/a "nullable": true
1840455 }
18531520 },
186607n/a "type": "object"
18787520}
Referenced Components (3)3 of 35 keywords
WorkflowActionEmailRequest0 of 15 keywords
10471{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
290471 "type": "object"
300471}
WorkflowActionTypeEnum3 of 3 keywords
14368{
24368 "enum": [
3425n/a 1,
41n/a 2,
51n/a 3,
63n/a 4,
72n/a 5,
81n/a 6,
91n/a 7,
102n/a 8
114368 ],
124386 "type": "integer"
134368}
WorkflowActionWebhookRequest0 of 17 keywords
10455{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
350455 "type": "object"
360455}
Responses1 of 1 documented received
codedescriptionhitsavg
20030423ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request14164ms
404Not Found3814ms
401Unauthorized339ms
500Internal Server Error34ms
41514ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1339330{
2339330 "type": "integer"
3339330}
Body201 of 297 keywords covered
application/json99 / 99
WorkflowActionRequest
1243937{
2132926 "properties": {
392510 "ai_create_missing": {
492510 "type": "boolean"
592510 },
691910 "ai_overwrite_existing": {
791910 "type": "boolean"
891910 },
9912n/a "ai_suggestion_fields": {
10912n/a "nullable": true
11912n/a },
1290422 "assign_change_groups": {
1390412 "items": {
148612 "type": "integer"
1590412 },
1691610 "type": "array"
1790422 },
1889922 "assign_change_users": {
1989912 "items": {
208312 "type": "integer"
2189912 },
2291110 "type": "array"
2389922 },
2492110 "assign_correspondent": {
25931n/a "nullable": true,
2692110 "type": "integer"
2792110 },
2890327 "assign_custom_fields": {
2990312 "items": {
306012 "type": "integer"
3190312 },
3291515 "type": "array"
3390327 },
34907n/a "assign_custom_fields_values": {
35907n/a "nullable": true,
36907n/a },
3791810 "assign_document_type": {
38928n/a "nullable": true,
3991810 "type": "integer"
4091810 },
4190410 "assign_owner": {
42914n/a "nullable": true,
4390410 "type": "integer"
4490410 },
4591110 "assign_storage_path": {
46921n/a "nullable": true,
4791110 "type": "integer"
4891110 },
4990220 "assign_tags": {
5090210 "items": {
51100n/a "nullable": true,
529010 "type": "integer"
5390210 },
5491210 "type": "array"
5590220 },
569148 "assign_title": {
57922n/a "nullable": true,
589148 "type": "string"
599148 },
6089722 "assign_view_groups": {
6189712 "items": {
628112 "type": "integer"
6389712 },
6490910 "type": "array"
6589722 },
6689222 "assign_view_users": {
6789212 "items": {
685512 "type": "integer"
6989212 },
7090410 "type": "array"
7189222 },
7234884 "email": {
731n/a "allOf": [
7434884 {
7534884 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7634884 }
771n/a ],
78918n/a "nullable": true
7934884 },
8091715 "id": {
81932n/a "nullable": true,
8291715 "type": "integer"
8391715 },
84897n/a "passwords": {
85897n/a "nullable": true
86897n/a },
8790810 "remove_all_correspondents": {
8890810 "type": "boolean"
8990810 },
9090210 "remove_all_custom_fields": {
9190210 "type": "boolean"
9290210 },
9390010 "remove_all_document_types": {
9490010 "type": "boolean"
9590010 },
9690710 "remove_all_owners": {
9790710 "type": "boolean"
9890710 },
9991310 "remove_all_permissions": {
10091310 "type": "boolean"
10191310 },
10289510 "remove_all_storage_paths": {
10389510 "type": "boolean"
10489510 },
10588810 "remove_all_tags": {
10688810 "type": "boolean"
10788810 },
10888522 "remove_change_groups": {
10988512 "items": {
11011012 "type": "integer"
11188512 },
11289710 "type": "array"
11388522 },
11487722 "remove_change_users": {
11587712 "items": {
1166512 "type": "integer"
11787712 },
11888910 "type": "array"
11987722 },
12088122 "remove_correspondents": {
12188112 "items": {
1228912 "type": "integer"
12388112 },
12489310 "type": "array"
12588122 },
12689122 "remove_custom_fields": {
12789112 "items": {
12815112 "type": "integer"
12989112 },
13090310 "type": "array"
13189122 },
13287922 "remove_document_types": {
13387912 "items": {
1346412 "type": "integer"
13587912 },
13689110 "type": "array"
13787922 },
13887922 "remove_owners": {
13987912 "items": {
1402912 "type": "integer"
14187912 },
14289110 "type": "array"
14387922 },
14487922 "remove_storage_paths": {
14587912 "items": {
14612312 "type": "integer"
14787912 },
14889110 "type": "array"
14987922 },
15088522 "remove_tags": {
15188512 "items": {
15215812 "type": "integer"
15388512 },
15489710 "type": "array"
15588522 },
15687222 "remove_view_groups": {
15787212 "items": {
15812812 "type": "integer"
15987212 },
16088410 "type": "array"
16187222 },
16286622 "remove_view_users": {
16386612 "items": {
1644812 "type": "integer"
16586612 },
16687810 "type": "array"
16786622 },
16887116 "type": {
1691n/a "allOf": [
17087116 {
17187116 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17287116 }
1731n/a ],
1748752 "maximum": 9223372036854775807,
1758752 "minimum": 0,
17687116 },
17773824 "webhook": {
1781n/a "allOf": [
17973824 {
18073824 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18173824 }
1821n/a ],
183897n/a "nullable": true
18473824 }
185132926 },
186116911 "type": "object"
187243937}
Referenced Components (3)35 of 35 keywords
WorkflowActionEmailRequest15 of 15 keywords
134884{
24060 "properties": {
38513 "body": {
4853 "minLength": 1,
58810 "type": "string"
68513 },
77710 "id": {
887n/a "nullable": true,
97710 "type": "integer"
107710 },
118010 "include_document": {
128010 "type": "boolean"
138010 },
148315 "subject": {
15853 "maxLength": 256,
16862 "minLength": 1,
178810 "type": "string"
188315 },
198612 "to": {
20862 "minLength": 1,
218810 "type": "string"
228612 }
234060 },
24948 "required": [
25984 "body",
26984 "subject",
27984 "to"
28948 ],
29102816 "type": "object"
3034884}
WorkflowActionTypeEnum3 of 3 keywords
187116{
287116 "enum": [
3853n/a 1,
42n/a 2,
53n/a 3,
63n/a 4,
73n/a 5,
83n/a 6,
92n/a 7,
102n/a 8
1187116 ],
1287512 "type": "integer"
1387116}
WorkflowActionWebhookRequest17 of 17 keywords
173824{
27562 "properties": {
310910 "as_json": {
410910 "type": "boolean"
510910 },
61118 "body": {
7119n/a "nullable": true,
81118 "type": "string"
91118 },
10116n/a "headers": {
11116n/a "nullable": true,
12116n/a },
1310610 "id": {
14116n/a "nullable": true,
1510610 "type": "integer"
1610610 },
1710410 "include_document": {
1810410 "type": "boolean"
1910410 },
20110n/a "params": {
21110n/a "nullable": true,
22110n/a },
2312114 "url": {
241232 "maxLength": 256,
251232 "minLength": 1,
2612510 "type": "string"
2712114 },
2810010 "use_params": {
2910010 "type": "boolean"
3010010 }
317562 },
321354 "required": [
331354 "url"
341354 ],
35139758 "type": "object"
3673824}
application/x-www-form-urlencoded51 / 99
WorkflowActionRequest
1106732{
263732 "properties": {
36824 "ai_create_missing": {
46824 "type": "boolean"
56824 },
66904 "ai_overwrite_existing": {
76904 "type": "boolean"
86904 },
9664n/a "ai_suggestion_fields": {
10664n/a "nullable": true
11664n/a },
121321 "assign_change_groups": {
131321 "items": {
148423 "type": "integer"
151321 },
16340 "type": "array"
171321 },
181414 "assign_change_users": {
191414 "items": {
204514 "type": "integer"
211414 },
22280 "type": "array"
231414 },
2413670 "assign_correspondent": {
25683n/a "nullable": true,
2613670 "type": "integer"
2713670 },
281214 "assign_custom_fields": {
291214 "items": {
306615 "type": "integer"
311214 },
32260 "type": "array"
331214 },
34654n/a "assign_custom_fields_values": {
35654n/a "nullable": true,
36654n/a },
375656 "assign_document_type": {
38661n/a "nullable": true,
395656 "type": "integer"
405656 },
413669 "assign_owner": {
42672n/a "nullable": true,
433669 "type": "integer"
443669 },
455654 "assign_storage_path": {
46659n/a "nullable": true,
475654 "type": "integer"
485654 },
491321 "assign_tags": {
501321 "items": {
5171n/a "nullable": true,
523239 "type": "integer"
531321 },
54340 "type": "array"
551321 },
56667n/a "assign_title": {
57667n/a "nullable": true,
58667n/a "type": "string"
59667n/a },
602112 "assign_view_groups": {
612112 "items": {
626612 "type": "integer"
632112 },
64330 "type": "array"
652112 },
661015 "assign_view_users": {
671015 "items": {
686715 "type": "integer"
691015 },
70250 "type": "array"
711015 },
720604 "email": {
730n/a "allOf": [
740604 {
750604 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
760604 }
770n/a ],
78604n/a "nullable": true
790604 },
8016651 "id": {
81667n/a "nullable": true,
8216651 "type": "integer"
8316651 },
84634n/a "passwords": {
85634n/a "nullable": true
86634n/a },
876534 "remove_all_correspondents": {
886534 "type": "boolean"
896534 },
906554 "remove_all_custom_fields": {
916554 "type": "boolean"
926554 },
936414 "remove_all_document_types": {
946414 "type": "boolean"
956414 },
966434 "remove_all_owners": {
976434 "type": "boolean"
986434 },
996364 "remove_all_permissions": {
1006364 "type": "boolean"
1016364 },
1026344 "remove_all_storage_paths": {
1036344 "type": "boolean"
1046344 },
1056364 "remove_all_tags": {
1066364 "type": "boolean"
1076364 },
1081622 "remove_change_groups": {
1091622 "items": {
11014522 "type": "integer"
1111622 },
112380 "type": "array"
1131622 },
1142812 "remove_change_users": {
1152812 "items": {
11613112 "type": "integer"
1172812 },
118400 "type": "array"
1192812 },
120716 "remove_correspondents": {
121716 "items": {
1224718 "type": "integer"
123716 },
124230 "type": "array"
125716 },
1261812 "remove_custom_fields": {
1271812 "items": {
1284712 "type": "integer"
1291812 },
130300 "type": "array"
1311812 },
1321014 "remove_document_types": {
1331014 "items": {
1344614 "type": "integer"
1351014 },
136240 "type": "array"
1371014 },
1381914 "remove_owners": {
1391914 "items": {
1408916 "type": "integer"
1411914 },
142330 "type": "array"
1431914 },
144712 "remove_storage_paths": {
145712 "items": {
1462412 "type": "integer"
147712 },
148190 "type": "array"
149712 },
1501717 "remove_tags": {
1511717 "items": {
1529117 "type": "integer"
1531717 },
154340 "type": "array"
1551717 },
1561213 "remove_view_groups": {
1571213 "items": {
1585113 "type": "integer"
1591213 },
160250 "type": "array"
1611213 },
1621716 "remove_view_users": {
1631716 "items": {
16410417 "type": "integer"
1651716 },
166330 "type": "array"
1671716 },
16859514 "type": {
1691n/a "allOf": [
17059514 {
17159514 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17259514 }
1731n/a ],
1746002 "maximum": 9223372036854775807,
1756002 "minimum": 0,
17659514 },
1770503 "webhook": {
1780n/a "allOf": [
1790503 {
1800503 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
1810503 }
1820n/a ],
183503n/a "nullable": true
1840503 }
18563732 },
186838n/a "type": "object"
187106732}
Referenced Components (3)3 of 35 keywords
WorkflowActionEmailRequest0 of 15 keywords
10604{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
290604 "type": "object"
300604}
WorkflowActionTypeEnum3 of 3 keywords
159514{
259514 "enum": [
3576n/a 1,
42n/a 2,
52n/a 3,
62n/a 4,
72n/a 5,
82n/a 6,
94n/a 7,
105n/a 8
1159514 ],
126027 "type": "integer"
1359514}
WorkflowActionWebhookRequest0 of 17 keywords
10503{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
350503 "type": "object"
360503}
multipart/form-data51 / 99
WorkflowActionRequest
11691010{
2871010 "properties": {
396310 "ai_create_missing": {
496310 "type": "boolean"
596310 },
696910 "ai_overwrite_existing": {
796910 "type": "boolean"
896910 },
9944n/a "ai_suggestion_fields": {
10944n/a "nullable": true
11944n/a },
123322 "assign_change_groups": {
133322 "items": {
1412722 "type": "integer"
153322 },
16550 "type": "array"
173322 },
182728 "assign_change_users": {
192728 "items": {
2010428 "type": "integer"
212728 },
22550 "type": "array"
232728 },
246942 "assign_correspondent": {
25948n/a "nullable": true,
266942 "type": "integer"
276942 },
281223 "assign_custom_fields": {
291223 "items": {
306423 "type": "integer"
311223 },
32350 "type": "array"
331223 },
34936n/a "assign_custom_fields_values": {
35936n/a "nullable": true,
36936n/a },
374936 "assign_document_type": {
38940n/a "nullable": true,
394936 "type": "integer"
404936 },
419935 "assign_owner": {
42944n/a "nullable": true,
439935 "type": "integer"
449935 },
4511940 "assign_storage_path": {
46951n/a "nullable": true,
4711940 "type": "integer"
4811940 },
49432 "assign_tags": {
50432 "items": {
5187n/a "nullable": true,
522661 "type": "integer"
53432 },
54360 "type": "array"
55432 },
56942n/a "assign_title": {
57942n/a "nullable": true,
58942n/a "type": "string"
59942n/a },
601724 "assign_view_groups": {
611724 "items": {
628324 "type": "integer"
631724 },
64410 "type": "array"
651724 },
662525 "assign_view_users": {
672525 "items": {
689325 "type": "integer"
692525 },
70500 "type": "array"
712525 },
720938 "email": {
730n/a "allOf": [
740938 {
750938 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
760938 }
770n/a ],
78938n/a "nullable": true
790938 },
8024922 "id": {
81946n/a "nullable": true,
8224922 "type": "integer"
8324922 },
84914n/a "passwords": {
85914n/a "nullable": true
86914n/a },
8791610 "remove_all_correspondents": {
8891610 "type": "boolean"
8991610 },
9090910 "remove_all_custom_fields": {
9190910 "type": "boolean"
9290910 },
9393110 "remove_all_document_types": {
9493110 "type": "boolean"
9593110 },
9691710 "remove_all_owners": {
9791710 "type": "boolean"
9891710 },
9991310 "remove_all_permissions": {
10091310 "type": "boolean"
10191310 },
10291210 "remove_all_storage_paths": {
10391210 "type": "boolean"
10491210 },
10589510 "remove_all_tags": {
10689510 "type": "boolean"
10789510 },
1081732 "remove_change_groups": {
1091732 "items": {
11013632 "type": "integer"
1111732 },
112490 "type": "array"
1131732 },
114826 "remove_change_users": {
115826 "items": {
1164828 "type": "integer"
117826 },
118340 "type": "array"
119826 },
1201223 "remove_correspondents": {
1211223 "items": {
1228923 "type": "integer"
1231223 },
124350 "type": "array"
1251223 },
126726 "remove_custom_fields": {
127726 "items": {
1282826 "type": "integer"
129726 },
130330 "type": "array"
131726 },
132730 "remove_document_types": {
133730 "items": {
1342830 "type": "integer"
135730 },
136370 "type": "array"
137730 },
138626 "remove_owners": {
139626 "items": {
1402126 "type": "integer"
141626 },
142320 "type": "array"
143626 },
144725 "remove_storage_paths": {
145725 "items": {
1465626 "type": "integer"
147725 },
148320 "type": "array"
149725 },
1501225 "remove_tags": {
1511225 "items": {
1526625 "type": "integer"
1531225 },
154370 "type": "array"
1551225 },
156833 "remove_view_groups": {
157833 "items": {
1585333 "type": "integer"
159833 },
160410 "type": "array"
161833 },
1621226 "remove_view_users": {
1631226 "items": {
1649029 "type": "integer"
1651226 },
166380 "type": "array"
1671226 },
16887416 "type": {
1691n/a "allOf": [
17087416 {
17187416 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17287416 }
1731n/a ],
1748762 "maximum": 9223372036854775807,
1758762 "minimum": 0,
17687416 },
1770890 "webhook": {
1780n/a "allOf": [
1790890 {
1800890 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
1810890 }
1820n/a ],
183890n/a "nullable": true
1840890 }
185871010 },
1861179n/a "type": "object"
1871691010}
Referenced Components (3)3 of 35 keywords
WorkflowActionEmailRequest0 of 15 keywords
10938{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
290938 "type": "object"
300938}
WorkflowActionTypeEnum3 of 3 keywords
187416{
287416 "enum": [
3854n/a 1,
42n/a 2,
52n/a 3,
62n/a 4,
75n/a 5,
83n/a 6,
93n/a 7,
103n/a 8
1187416 ],
1287812 "type": "integer"
1387416}
WorkflowActionWebhookRequest0 of 17 keywords
10890{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
350890 "type": "object"
360890}
Responses1 of 1 documented received
codedescriptionhitsavg
20041726ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5594ms
400Bad Request23908ms
401Unauthorized2211ms
500Internal Server Error349ms
415114ms
workflow_triggers 6 operations 3 covered 3 partial 0 uncovered 0 not measured 89% #
Query Parameters2 of 2 keywords covered
page1 / 1
#validinvalidschema
11493468{
21493468 "type": "integer"
31493468}
page_size1 / 1
11602439{
21602439 "type": "integer"
31602439}
Responses1 of 1 documented received
codedescriptionhitsavg
200175423ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1384ms
404Not Found18894ms
Body191 of 213 keywords covered
application/json71 / 71
WorkflowTriggerRequest
#validinvalidschema
11660462{
21677430 "properties": {
38879 "filter_custom_field_query": {
4896n/a "nullable": true,
58879 "type": "string"
68879 },
785610 "filter_filename": {
88052 "maxLength": 256,
9866n/a "nullable": true,
108588 "type": "string"
1185610 },
1281223 "filter_has_all_tags": {
1381213 "items": {
14104518 "type": "integer"
1581213 },
1682510 "type": "array"
1781223 },
1879723 "filter_has_any_correspondents": {
1979712 "items": {
20107712 "type": "integer"
2179712 },
2280911 "type": "array"
2379723 },
2480822 "filter_has_any_document_types": {
2580812 "items": {
26139112 "type": "integer"
2780812 },
2882010 "type": "array"
2980822 },
3080522 "filter_has_any_storage_paths": {
3180512 "items": {
32127912 "type": "integer"
3380512 },
3481710 "type": "array"
3580522 },
3680212 "filter_has_correspondent": {
37814n/a "nullable": true,
3880212 "type": "integer"
3980212 },
4080010 "filter_has_document_type": {
41810n/a "nullable": true,
4280010 "type": "integer"
4380010 },
4479623 "filter_has_not_correspondents": {
4579612 "items": {
46114112 "type": "integer"
4779612 },
4880811 "type": "array"
4979623 },
5076322 "filter_has_not_document_types": {
5176312 "items": {
52117812 "type": "integer"
5376312 },
5477510 "type": "array"
5576322 },
5676822 "filter_has_not_storage_paths": {
5776812 "items": {
5899112 "type": "integer"
5976812 },
6078010 "type": "array"
6176822 },
6278923 "filter_has_not_tags": {
6378913 "items": {
64135219 "type": "integer"
6578913 },
6680210 "type": "array"
6778923 },
6882612 "filter_has_storage_path": {
69838n/a "nullable": true,
7082612 "type": "integer"
7182612 },
7274922 "filter_has_tags": {
7374912 "items": {
7498112 "type": "integer"
7574912 },
7676110 "type": "array"
7774922 },
7877011 "filter_mailrule": {
79781n/a "nullable": true,
8077011 "type": "integer"
8177011 },
8278511 "filter_path": {
837262 "maxLength": 256,
84796n/a "nullable": true,
857879 "type": "string"
8678511 },
8779310 "id": {
88803n/a "nullable": true,
8979310 "type": "integer"
9079310 },
9176510 "is_insensitive": {
9276510 "type": "boolean"
9376510 },
9481312 "match": {
958132 "maxLength": 256,
9681510 "type": "string"
9781312 },
9875817 "matching_algorithm": {
991n/a "allOf": [
10075817 {
10175817 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10275817 }
1031n/a ],
1047632 "maximum": 9223372036854775807,
1057623 "minimum": 0
10675817 },
10776812 "schedule_date_custom_field": {
108780n/a "nullable": true,
10976812 "type": "integer"
11076812 },
11177213 "schedule_date_field": {
1121n/a "allOf": [
11377213 {
11477213 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11577213 }
1161n/a ],
11777213 },
11878914 "schedule_is_recurring": {
11978914 "type": "boolean"
12078914 },
12173820 "schedule_offset_days": {
12273820 "format": "int64",
1237462 "maximum": 9223372036854775807,
1247426 "minimum": -9223372036854775808,
12574612 "type": "integer"
12673820 },
12774416 "schedule_recurring_interval_days": {
12874614 "format": "int64",
1297482 "maximum": 9223372036854775807,
1307464 "minimum": 1,
13174812 "type": "integer"
13274416 },
13374822 "sources": {
13474812 "items": {
135259512 "$ref": "#/components/schemas/SourcesEnum"
13674812 },
13776010 "type": "array"
13874822 },
139207812 "type": {
1401n/a "allOf": [
141207812 {
142207812 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
143207812 }
1441n/a ],
145207812 }
1461677430 },
147209022 "required": [
148209022 "type"
149209022 ],
150211210 "type": "object"
1511660462}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
177213{
277213 "enum": [
3572n/a "added",
450n/a "created",
564n/a "modified",
686n/a "custom_field"
777213 ],
877510 "type": "string"
977213}
SourcesEnum3 of 3 keywords
1259512{
2259512 "enum": [
3743n/a 1,
4779n/a 2,
5755n/a 3,
6318n/a 4
7259512 ],
8259512 "type": "integer"
9259512}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
175817{
275817 "enum": [
3537n/a 0,
465n/a 1,
544n/a 2,
634n/a 3,
739n/a 4,
839n/a 5
975817 ],
1076213 "type": "integer"
1175817}
WorkflowTriggerTypeEnum3 of 3 keywords
1207812{
2207812 "enum": [
31021n/a 1,
4447n/a 2,
5299n/a 3,
6311n/a 4
7207812 ],
8207812 "type": "integer"
9207812}
application/x-www-form-urlencoded60 / 71
WorkflowTriggerRequest
1716928{
2727914 "properties": {
3602n/a "filter_custom_field_query": {
4602n/a "nullable": true,
5602n/a "type": "string"
6602n/a },
75893 "filter_filename": {
85893 "maxLength": 256,
9592n/a "nullable": true,
10592n/a "type": "string"
115893 },
1212845 "filter_has_all_tags": {
1312845 "items": {
1491350 "type": "integer"
1512845 },
161730 "type": "array"
1712845 },
1814046 "filter_has_any_correspondents": {
1914046 "items": {
2084452 "type": "integer"
2114046 },
221860 "type": "array"
2314046 },
2413858 "filter_has_any_document_types": {
2513858 "items": {
26117362 "type": "integer"
2713858 },
281960 "type": "array"
2913858 },
3018932 "filter_has_any_storage_paths": {
3118932 "items": {
3295434 "type": "integer"
3318932 },
342210 "type": "array"
3518932 },
36108480 "filter_has_correspondent": {
37588n/a "nullable": true,
38108480 "type": "integer"
39108480 },
4099480 "filter_has_document_type": {
41579n/a "nullable": true,
4299480 "type": "integer"
4399480 },
4414044 "filter_has_not_correspondents": {
4514044 "items": {
46119648 "type": "integer"
4714044 },
481840 "type": "array"
4914044 },
5012162 "filter_has_not_document_types": {
5112162 "items": {
5292270 "type": "integer"
5312162 },
541830 "type": "array"
5512162 },
569842 "filter_has_not_storage_paths": {
579842 "items": {
5864843 "type": "integer"
599842 },
601400 "type": "array"
619842 },
6213650 "filter_has_not_tags": {
6313650 "items": {
64106061 "type": "integer"
6513650 },
661860 "type": "array"
6713650 },
6899453 "filter_has_storage_path": {
69552n/a "nullable": true,
7099453 "type": "integer"
7199453 },
7215142 "filter_has_tags": {
7315142 "items": {
7493349 "type": "integer"
7515142 },
761930 "type": "array"
7715142 },
7887449 "filter_mailrule": {
79536n/a "nullable": true,
8087449 "type": "integer"
8187449 },
825842 "filter_path": {
835842 "maxLength": 256,
84586n/a "nullable": true,
85586n/a "type": "string"
865842 },
8797470 "id": {
88567n/a "nullable": true,
8997470 "type": "integer"
9097470 },
915904 "is_insensitive": {
925904 "type": "boolean"
935904 },
945304 "match": {
955304 "maxLength": 256,
96534n/a "type": "string"
975304 },
9856024 "matching_algorithm": {
991n/a "allOf": [
10056024 {
10156024 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10256024 }
1031n/a ],
10456711 "maximum": 9223372036854775807,
1055744 "minimum": 0
10656024 },
10789472 "schedule_date_custom_field": {
108561n/a "nullable": true,
10989472 "type": "integer"
11089472 },
1115583 "schedule_date_field": {
1121n/a "allOf": [
1135583 {
1145583 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1155583 }
1161n/a ],
1175583 },
1186684 "schedule_is_recurring": {
1196684 "type": "boolean"
1206684 },
12164715 "schedule_offset_days": {
12264715 "format": "int64",
1236475 "maximum": 9223372036854775807,
1246520 "minimum": -9223372036854775808,
12565210 "type": "integer"
12664715 },
12761110 "schedule_recurring_interval_days": {
1286138 "format": "int64",
1296132 "maximum": 9223372036854775807,
1306132 "minimum": 1,
1316156 "type": "integer"
13261110 },
13349816 "sources": {
13449816 "items": {
135187316 "$ref": "#/components/schemas/SourcesEnum"
13649816 },
1375140 "type": "array"
13849816 },
13916129 "type": {
1401n/a "allOf": [
14116129 {
14216129 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14316129 }
1441n/a ],
14516129 }
146727914 },
147162123 "required": [
148162123 "type"
149162123 ],
1501644n/a "type": "object"
151716928}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
15583{
25583 "enum": [
3394n/a "added",
445n/a "created",
571n/a "modified",
648n/a "custom_field"
75583 ],
8561n/a "type": "string"
95583}
SourcesEnum3 of 3 keywords
1187316{
2187316 "enum": [
3587n/a 1,
4527n/a 2,
5546n/a 3,
6213n/a 4
7187316 ],
8187514 "type": "integer"
9187316}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
156024{
256024 "enum": [
3353n/a 0,
435n/a 1,
535n/a 2,
645n/a 3,
755n/a 4,
837n/a 5
956024 ],
105786 "type": "integer"
1156024}
WorkflowTriggerTypeEnum3 of 3 keywords
116129{
216129 "enum": [
3690n/a 1,
4310n/a 2,
5347n/a 3,
6265n/a 4
716129 ],
816147 "type": "integer"
916129}
multipart/form-data60 / 71
WorkflowTriggerRequest
1431907{
2431902 "properties": {
3691n/a "filter_custom_field_query": {
4691n/a "nullable": true,
5691n/a "type": "string"
6691n/a },
76862 "filter_filename": {
86862 "maxLength": 256,
9688n/a "nullable": true,
10688n/a "type": "string"
116862 },
128449 "filter_has_all_tags": {
138449 "items": {
1462852 "type": "integer"
158449 },
161330 "type": "array"
178449 },
1810152 "filter_has_any_correspondents": {
1910152 "items": {
2070762 "type": "integer"
2110152 },
221530 "type": "array"
2310152 },
248362 "filter_has_any_document_types": {
258362 "items": {
2657365 "type": "integer"
278362 },
281450 "type": "array"
298362 },
308839 "filter_has_any_storage_paths": {
318839 "items": {
3252042 "type": "integer"
338839 },
341270 "type": "array"
358839 },
3657590 "filter_has_correspondent": {
37647n/a "nullable": true,
3857590 "type": "integer"
3957590 },
4046625 "filter_has_document_type": {
41671n/a "nullable": true,
4246625 "type": "integer"
4346625 },
448964 "filter_has_not_correspondents": {
458964 "items": {
4661472 "type": "integer"
478964 },
481530 "type": "array"
498964 },
5010947 "filter_has_not_document_types": {
5110947 "items": {
5279250 "type": "integer"
5310947 },
541560 "type": "array"
5510947 },
5610154 "filter_has_not_storage_paths": {
5710154 "items": {
5887259 "type": "integer"
5910154 },
601550 "type": "array"
6110154 },
629135 "filter_has_not_tags": {
639135 "items": {
6442137 "type": "integer"
659135 },
661260 "type": "array"
679135 },
6858592 "filter_has_storage_path": {
69650n/a "nullable": true,
7058592 "type": "integer"
7158592 },
729460 "filter_has_tags": {
739460 "items": {
7482865 "type": "integer"
759460 },
761540 "type": "array"
779460 },
7856589 "filter_mailrule": {
79645n/a "nullable": true,
8056589 "type": "integer"
8156589 },
826512 "filter_path": {
836512 "maxLength": 256,
84653n/a "nullable": true,
85653n/a "type": "string"
866512 },
8755592 "id": {
88647n/a "nullable": true,
8955592 "type": "integer"
9055592 },
9164610 "is_insensitive": {
9264610 "type": "boolean"
9364610 },
946412 "match": {
956412 "maxLength": 256,
96643n/a "type": "string"
976412 },
9864120 "matching_algorithm": {
991n/a "allOf": [
10064120 {
10164120 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10264120 }
1031n/a ],
1046436 "maximum": 9223372036854775807,
1056472 "minimum": 0
10664120 },
10767571 "schedule_date_custom_field": {
108638n/a "nullable": true,
10967571 "type": "integer"
11067571 },
1116403 "schedule_date_field": {
1121n/a "allOf": [
1136403 {
1146403 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1156403 }
1161n/a ],
1176403 },
11864910 "schedule_is_recurring": {
11964910 "type": "boolean"
12064910 },
12163317 "schedule_offset_days": {
12263317 "format": "int64",
1236332 "maximum": 9223372036854775807,
1246350 "minimum": -9223372036854775808,
12563515 "type": "integer"
12663317 },
12759717 "schedule_recurring_interval_days": {
12860014 "format": "int64",
1296002 "maximum": 9223372036854775807,
1305993 "minimum": 1,
13160212 "type": "integer"
13259717 },
13357528 "sources": {
13457528 "items": {
135216528 "$ref": "#/components/schemas/SourcesEnum"
13657528 },
1376030 "type": "array"
13857528 },
139131512 "type": {
1401n/a "allOf": [
141131512 {
142131512 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
143131512 }
1441n/a ],
145131512 }
146431902 },
147132711 "required": [
148132711 "type"
149132711 ],
1501338n/a "type": "object"
151431907}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
16403{
26403 "enum": [
3530n/a "added",
434n/a "created",
529n/a "modified",
647n/a "custom_field"
76403 ],
8643n/a "type": "string"
96403}
SourcesEnum3 of 3 keywords
1216528{
2216528 "enum": [
3672n/a 1,
4704n/a 2,
5623n/a 3,
6166n/a 4
7216528 ],
8216726 "type": "integer"
9216528}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
164120{
264120 "enum": [
3498n/a 0,
424n/a 1,
534n/a 2,
636n/a 3,
734n/a 4,
815n/a 5
964120 ],
1064912 "type": "integer"
1164120}
WorkflowTriggerTypeEnum3 of 3 keywords
1131512{
2131512 "enum": [
3764n/a 1,
4157n/a 2,
5193n/a 3,
6201n/a 4
7131512 ],
8131512 "type": "integer"
9131512}
Responses1 of 1 documented received
codedescriptionhitsavg
201114517ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request43985ms
401Unauthorized1264ms
415211ms
500Internal Server Error157ms
Examples3 / 3 used
Body: application/json
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: application/x-www-form-urlencoded
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: multipart/form-data
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
149311{
249311 "type": "integer"
349311}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body13614ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3043ms
401Unauthorized645ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
168325{
268325 "type": "integer"
368325}
Responses1 of 1 documented received
codedescriptionhitsavg
2003237ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3063ms
401Unauthorized795ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1155012{
2155012 "type": "integer"
3155012}
Body188 of 210 keywords covered
application/json70 / 70
PatchedWorkflowTriggerRequest
1412222{
2198211 "properties": {
33214 "filter_custom_field_query": {
4325n/a "nullable": true,
53214 "type": "string"
63214 },
72975 "filter_filename": {
82941 "maxLength": 256,
9302n/a "nullable": true,
102984 "type": "string"
112975 },
1230011 "filter_has_all_tags": {
133006 "items": {
14726 "type": "integer"
153006 },
163065 "type": "array"
1730011 },
1829411 "filter_has_any_correspondents": {
192946 "items": {
20796 "type": "integer"
212946 },
223005 "type": "array"
2329411 },
2429711 "filter_has_any_document_types": {
252976 "items": {
26846 "type": "integer"
272976 },
283035 "type": "array"
2929711 },
3029611 "filter_has_any_storage_paths": {
312966 "items": {
32896 "type": "integer"
332966 },
343025 "type": "array"
3529611 },
362905 "filter_has_correspondent": {
37295n/a "nullable": true,
382905 "type": "integer"
392905 },
402955 "filter_has_document_type": {
41300n/a "nullable": true,
422955 "type": "integer"
432955 },
4430111 "filter_has_not_correspondents": {
453016 "items": {
461176 "type": "integer"
473016 },
483075 "type": "array"
4930111 },
5029511 "filter_has_not_document_types": {
512956 "items": {
521106 "type": "integer"
532956 },
543015 "type": "array"
5529511 },
5628311 "filter_has_not_storage_paths": {
572836 "items": {
58696 "type": "integer"
592836 },
602895 "type": "array"
6128311 },
6228812 "filter_has_not_tags": {
632886 "items": {
641296 "type": "integer"
652886 },
662946 "type": "array"
6728812 },
682936 "filter_has_storage_path": {
69299n/a "nullable": true,
702936 "type": "integer"
712936 },
7228811 "filter_has_tags": {
732886 "items": {
741666 "type": "integer"
752886 },
762945 "type": "array"
7728811 },
782885 "filter_mailrule": {
79293n/a "nullable": true,
802885 "type": "integer"
812885 },
822946 "filter_path": {
832902 "maxLength": 256,
84300n/a "nullable": true,
852964 "type": "string"
862946 },
872906 "id": {
88296n/a "nullable": true,
892906 "type": "integer"
902906 },
912835 "is_insensitive": {
922835 "type": "boolean"
932835 },
942759 "match": {
952754 "maxLength": 256,
962795 "type": "string"
972759 },
982748 "matching_algorithm": {
991n/a "allOf": [
1002748 {
1012748 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
1022748 }
1031n/a ],
1042761 "maximum": 9223372036854775807,
1052761 "minimum": 0
1062748 },
1072845 "schedule_date_custom_field": {
108289n/a "nullable": true,
1092845 "type": "integer"
1102845 },
1112766 "schedule_date_field": {
1121n/a "allOf": [
1132766 {
1142766 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1152766 }
1161n/a ],
1172766 },
1182825 "schedule_is_recurring": {
1192825 "type": "boolean"
1202825 },
1212778 "schedule_offset_days": {
1222778 "format": "int64",
1232791 "maximum": 9223372036854775807,
1242791 "minimum": -9223372036854775808,
1252796 "type": "integer"
1262778 },
1272688 "schedule_recurring_interval_days": {
1282697 "format": "int64",
1292701 "maximum": 9223372036854775807,
1302692 "minimum": 1,
1312706 "type": "integer"
1322688 },
13327011 "sources": {
1342706 "items": {
1358016 "$ref": "#/components/schemas/SourcesEnum"
1362706 },
1372765 "type": "array"
13827011 },
1392746 "type": {
1401n/a "allOf": [
1412746 {
1422746 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
1432746 }
1441n/a ],
1452746 }
146198211 },
14762311 "type": "object"
148412222}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
12766{
22766 "enum": [
3262n/a "added",
45n/a "created",
52n/a "modified",
67n/a "custom_field"
72766 ],
82775 "type": "string"
92766}
SourcesEnum3 of 3 keywords
18016{
28016 "enum": [
3256n/a 1,
4265n/a 2,
5263n/a 3,
617n/a 4
78016 ],
88016 "type": "integer"
98016}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
12748{
22748 "enum": [
3259n/a 0,
44n/a 1,
54n/a 2,
61n/a 3,
74n/a 4,
82n/a 5
92748 ],
102766 "type": "integer"
112748}
WorkflowTriggerTypeEnum3 of 3 keywords
12746{
22746 "enum": [
3255n/a 1,
414n/a 2,
52n/a 3,
63n/a 4
72746 ],
82746 "type": "integer"
92746}
application/x-www-form-urlencoded59 / 70
PatchedWorkflowTriggerRequest
1116261{
246261 "properties": {
3209n/a "filter_custom_field_query": {
4209n/a "nullable": true,
5209n/a "type": "string"
6209n/a },
72182 "filter_filename": {
82182 "maxLength": 256,
9220n/a "nullable": true,
10220n/a "type": "string"
112182 },
122114 "filter_has_all_tags": {
132114 "items": {
1419018 "type": "integer"
152114 },
16350 "type": "array"
172114 },
182216 "filter_has_any_correspondents": {
192216 "items": {
2016518 "type": "integer"
212216 },
22380 "type": "array"
232216 },
24308 "filter_has_any_document_types": {
25308 "items": {
261918 "type": "integer"
27308 },
28380 "type": "array"
29308 },
3079 "filter_has_any_storage_paths": {
3179 "items": {
32539 "type": "integer"
3379 },
34160 "type": "array"
3579 },
3618196 "filter_has_correspondent": {
37214n/a "nullable": true,
3818196 "type": "integer"
3918196 },
4014201 "filter_has_document_type": {
41215n/a "nullable": true,
4214201 "type": "integer"
4314201 },
44248 "filter_has_not_correspondents": {
45248 "items": {
46798 "type": "integer"
47248 },
48320 "type": "array"
49248 },
502011 "filter_has_not_document_types": {
512011 "items": {
5210114 "type": "integer"
532011 },
54310 "type": "array"
552011 },
56218 "filter_has_not_storage_paths": {
57218 "items": {
581718 "type": "integer"
59218 },
60290 "type": "array"
61218 },
62179 "filter_has_not_tags": {
63179 "items": {
6414210 "type": "integer"
65179 },
66260 "type": "array"
67179 },
6815193 "filter_has_storage_path": {
69208n/a "nullable": true,
7015193 "type": "integer"
7115193 },
721410 "filter_has_tags": {
731410 "items": {
749610 "type": "integer"
751410 },
76240 "type": "array"
771410 },
7811201 "filter_mailrule": {
79212n/a "nullable": true,
8011201 "type": "integer"
8111201 },
821971 "filter_path": {
831971 "maxLength": 256,
84198n/a "nullable": true,
85198n/a "type": "string"
861971 },
8736185 "id": {
88221n/a "nullable": true,
8936185 "type": "integer"
9036185 },
912082 "is_insensitive": {
922082 "type": "boolean"
932082 },
941875 "match": {
951875 "maxLength": 256,
96192n/a "type": "string"
971875 },
9818610 "matching_algorithm": {
991n/a "allOf": [
10018610 {
10118610 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10218610 }
1031n/a ],
1041912 "maximum": 9223372036854775807,
1051894 "minimum": 0
10618610 },
10721186 "schedule_date_custom_field": {
108207n/a "nullable": true,
10921186 "type": "integer"
11021186 },
1111933 "schedule_date_field": {
1121n/a "allOf": [
1131933 {
1141933 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1151933 }
1161n/a ],
1171933 },
1181922 "schedule_is_recurring": {
1191922 "type": "boolean"
1201922 },
1211807 "schedule_offset_days": {
1221807 "format": "int64",
1231801 "maximum": 9223372036854775807,
1241810 "minimum": -9223372036854775808,
1251816 "type": "integer"
1261807 },
1271727 "schedule_recurring_interval_days": {
1281745 "format": "int64",
1291742 "maximum": 9223372036854775807,
1301742 "minimum": 1,
1311763 "type": "integer"
1321727 },
13316710 "sources": {
13416710 "items": {
13552910 "$ref": "#/components/schemas/SourcesEnum"
13616710 },
1371770 "type": "array"
13816710 },
1391905 "type": {
1401n/a "allOf": [
1411905 {
1421905 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
1431905 }
1441n/a ],
1451905 }
14646261 },
147377n/a "type": "object"
148116261}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
11933{
21933 "enum": [
3174n/a "added",
48n/a "created",
54n/a "modified",
67n/a "custom_field"
71933 ],
8196n/a "type": "string"
91933}
SourcesEnum3 of 3 keywords
152910{
252910 "enum": [
3173n/a 1,
4171n/a 2,
5173n/a 3,
612n/a 4
752910 ],
85309 "type": "integer"
952910}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
118610{
218610 "enum": [
3167n/a 0,
47n/a 1,
53n/a 2,
61n/a 3,
77n/a 4,
81n/a 5
918610 ],
101933 "type": "integer"
1118610}
WorkflowTriggerTypeEnum3 of 3 keywords
11905{
21905 "enum": [
3163n/a 1,
44n/a 2,
52n/a 3,
621n/a 4
71905 ],
81923 "type": "integer"
91905}
multipart/form-data59 / 70
PatchedWorkflowTriggerRequest
167309{
237309 "properties": {
3282n/a "filter_custom_field_query": {
4282n/a "nullable": true,
5282n/a "type": "string"
6282n/a },
72851 "filter_filename": {
82851 "maxLength": 256,
9286n/a "nullable": true,
10286n/a "type": "string"
112851 },
121017 "filter_has_all_tags": {
131017 "items": {
1410117 "type": "integer"
151017 },
16270 "type": "array"
171017 },
18521 "filter_has_any_correspondents": {
19521 "items": {
2011521 "type": "integer"
21521 },
22260 "type": "array"
23521 },
24817 "filter_has_any_document_types": {
25817 "items": {
2611317 "type": "integer"
27817 },
28250 "type": "array"
29817 },
30812 "filter_has_any_storage_paths": {
31812 "items": {
323212 "type": "integer"
33812 },
34200 "type": "array"
35812 },
367281 "filter_has_correspondent": {
37288n/a "nullable": true,
387281 "type": "integer"
397281 },
409279 "filter_has_document_type": {
41288n/a "nullable": true,
429279 "type": "integer"
439279 },
441515 "filter_has_not_correspondents": {
451515 "items": {
4615215 "type": "integer"
471515 },
48300 "type": "array"
491515 },
50412 "filter_has_not_document_types": {
51412 "items": {
52713 "type": "integer"
53412 },
54160 "type": "array"
55412 },
561012 "filter_has_not_storage_paths": {
571012 "items": {
587114 "type": "integer"
591012 },
60220 "type": "array"
611012 },
621111 "filter_has_not_tags": {
631111 "items": {
642611 "type": "integer"
651111 },
66220 "type": "array"
671111 },
686275 "filter_has_storage_path": {
69281n/a "nullable": true,
706275 "type": "integer"
716275 },
72712 "filter_has_tags": {
73712 "items": {
741512 "type": "integer"
75712 },
76190 "type": "array"
77712 },
784273 "filter_mailrule": {
79277n/a "nullable": true,
804273 "type": "integer"
814273 },
822802 "filter_path": {
832802 "maxLength": 256,
84282n/a "nullable": true,
85282n/a "type": "string"
862802 },
879255 "id": {
88264n/a "nullable": true,
899255 "type": "integer"
909255 },
912745 "is_insensitive": {
922745 "type": "boolean"
932745 },
942622 "match": {
952622 "maxLength": 256,
96264n/a "type": "string"
972622 },
982588 "matching_algorithm": {
991n/a "allOf": [
1002588 {
1012588 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
1022588 }
1031n/a ],
1042591 "maximum": 9223372036854775807,
1052591 "minimum": 0
1062588 },
1074254 "schedule_date_custom_field": {
108258n/a "nullable": true,
1094254 "type": "integer"
1104254 },
1112751 "schedule_date_field": {
1121n/a "allOf": [
1132751 {
1142751 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1152751 }
1161n/a ],
1172751 },
1182595 "schedule_is_recurring": {
1192595 "type": "boolean"
1202595 },
1212638 "schedule_offset_days": {
1222638 "format": "int64",
1232631 "maximum": 9223372036854775807,
1242640 "minimum": -9223372036854775808,
1252647 "type": "integer"
1262638 },
1272548 "schedule_recurring_interval_days": {
1282557 "format": "int64",
1292551 "maximum": 9223372036854775807,
1302551 "minimum": 1,
1312566 "type": "integer"
1322548 },
13324312 "sources": {
13424312 "items": {
13577712 "$ref": "#/components/schemas/SourcesEnum"
13624312 },
1372550 "type": "array"
13824312 },
1392486 "type": {
1401n/a "allOf": [
1412486 {
1422486 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
1432486 }
1441n/a ],
1452486 }
14637309 },
147376n/a "type": "object"
14867309}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
12751{
22751 "enum": [
3264n/a "added",
41n/a "created",
56n/a "modified",
64n/a "custom_field"
72751 ],
8276n/a "type": "string"
92751}
SourcesEnum3 of 3 keywords
177712{
277712 "enum": [
3250n/a 1,
4247n/a 2,
5259n/a 3,
621n/a 4
777712 ],
877811 "type": "integer"
977712}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
12588{
22588 "enum": [
3247n/a 0,
43n/a 1,
53n/a 2,
61n/a 3,
71n/a 4,
83n/a 5
92588 ],
102606 "type": "integer"
112588}
WorkflowTriggerTypeEnum3 of 3 keywords
12486{
22486 "enum": [
3237n/a 1,
41n/a 2,
55n/a 3,
65n/a 4
72486 ],
82486 "type": "integer"
92486}
Responses1 of 1 documented received
codedescriptionhitsavg
20013615ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request9574ms
404Not Found4344ms
500Internal Server Error34ms
401Unauthorized319ms
41513ms
Examples3 / 3 used
Body: application/json
[ 1, 2, 3 ]PatchedWorkflowTriggerRequest.sources
Body: application/x-www-form-urlencoded
[ 1, 2, 3 ]PatchedWorkflowTriggerRequest.sources
Body: multipart/form-data
[ 1, 2, 3 ]PatchedWorkflowTriggerRequest.sources
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1246218{
2246218 "type": "integer"
3246218}
Body191 of 213 keywords covered
application/json71 / 71
WorkflowTriggerRequest
1581432{
2585418 "properties": {
36138 "filter_custom_field_query": {
4621n/a "nullable": true,
56138 "type": "string"
66138 },
759610 "filter_filename": {
85872 "maxLength": 256,
9606n/a "nullable": true,
105988 "type": "string"
1159610 },
1257222 "filter_has_all_tags": {
1357212 "items": {
146712 "type": "integer"
1557212 },
1658410 "type": "array"
1757222 },
1859122 "filter_has_any_correspondents": {
1959112 "items": {
2024212 "type": "integer"
2159112 },
2260310 "type": "array"
2359122 },
2458322 "filter_has_any_document_types": {
2558312 "items": {
2626112 "type": "integer"
2758312 },
2859510 "type": "array"
2958322 },
3059322 "filter_has_any_storage_paths": {
3159312 "items": {
3221012 "type": "integer"
3359312 },
3460510 "type": "array"
3559322 },
3660310 "filter_has_correspondent": {
37613n/a "nullable": true,
3860310 "type": "integer"
3960310 },
4058310 "filter_has_document_type": {
41593n/a "nullable": true,
4258310 "type": "integer"
4358310 },
4458522 "filter_has_not_correspondents": {
4558512 "items": {
4623112 "type": "integer"
4758512 },
4859710 "type": "array"
4958522 },
5057822 "filter_has_not_document_types": {
5157812 "items": {
5218812 "type": "integer"
5357812 },
5459010 "type": "array"
5557822 },
5657122 "filter_has_not_storage_paths": {
5757112 "items": {
5820012 "type": "integer"
5957112 },
6058310 "type": "array"
6157122 },
6257422 "filter_has_not_tags": {
6357412 "items": {
6424312 "type": "integer"
6557412 },
6658610 "type": "array"
6757422 },
6858010 "filter_has_storage_path": {
69590n/a "nullable": true,
7058010 "type": "integer"
7158010 },
7256822 "filter_has_tags": {
7356812 "items": {
7419512 "type": "integer"
7556812 },
7658010 "type": "array"
7756822 },
7857810 "filter_mailrule": {
79588n/a "nullable": true,
8057810 "type": "integer"
8157810 },
8257511 "filter_path": {
835682 "maxLength": 256,
84586n/a "nullable": true,
855779 "type": "string"
8657511 },
8760610 "id": {
88616n/a "nullable": true,
8960610 "type": "integer"
9060610 },
9156310 "is_insensitive": {
9256310 "type": "boolean"
9356310 },
9457212 "match": {
955722 "maxLength": 256,
9657410 "type": "string"
9757212 },
9855916 "matching_algorithm": {
991n/a "allOf": [
10055916 {
10155916 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10255916 }
1031n/a ],
1045632 "maximum": 9223372036854775807,
1055632 "minimum": 0
10655916 },
10756910 "schedule_date_custom_field": {
108579n/a "nullable": true,
10956910 "type": "integer"
11056910 },
11158412 "schedule_date_field": {
1121n/a "allOf": [
11358412 {
11458412 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11558412 }
1161n/a ],
11758412 },
11855514 "schedule_is_recurring": {
11955514 "type": "boolean"
12055514 },
12155017 "schedule_offset_days": {
12255017 "format": "int64",
1235552 "maximum": 9223372036854775807,
1245543 "minimum": -9223372036854775808,
12555512 "type": "integer"
12655017 },
12754816 "schedule_recurring_interval_days": {
12855014 "format": "int64",
1295522 "maximum": 9223372036854775807,
1305504 "minimum": 1,
13155212 "type": "integer"
13254816 },
13353622 "sources": {
13453612 "items": {
135166312 "$ref": "#/components/schemas/SourcesEnum"
13653612 },
13754810 "type": "array"
13853622 },
13998712 "type": {
1401n/a "allOf": [
14198712 {
14298712 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14398712 }
1441n/a ],
14598712 }
146585418 },
1479994 "required": [
1489994 "type"
1499994 ],
150100310 "type": "object"
151581432}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
158412{
258412 "enum": [
3526n/a "added",
430n/a "created",
57n/a "modified",
621n/a "custom_field"
758412 ],
858610 "type": "string"
958412}
SourcesEnum3 of 3 keywords
1166312{
2166312 "enum": [
3559n/a 1,
4553n/a 2,
5519n/a 3,
632n/a 4
7166312 ],
8166312 "type": "integer"
9166312}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
155916{
255916 "enum": [
3524n/a 0,
48n/a 1,
54n/a 2,
64n/a 3,
715n/a 4,
84n/a 5
955916 ],
1056312 "type": "integer"
1155916}
WorkflowTriggerTypeEnum3 of 3 keywords
198712{
298712 "enum": [
3791n/a 1,
434n/a 2,
551n/a 3,
6111n/a 4
798712 ],
898712 "type": "integer"
998712}
application/x-www-form-urlencoded60 / 71
WorkflowTriggerRequest
1123474{
2125472 "properties": {
3413n/a "filter_custom_field_query": {
4413n/a "nullable": true,
5413n/a "type": "string"
6413n/a },
74092 "filter_filename": {
84092 "maxLength": 256,
9411n/a "nullable": true,
10411n/a "type": "string"
114092 },
123415 "filter_has_all_tags": {
133415 "items": {
1413815 "type": "integer"
153415 },
16490 "type": "array"
173415 },
181918 "filter_has_any_correspondents": {
191918 "items": {
2014622 "type": "integer"
211918 },
22370 "type": "array"
231918 },
243018 "filter_has_any_document_types": {
253018 "items": {
2626122 "type": "integer"
273018 },
28480 "type": "array"
293018 },
302615 "filter_has_any_storage_paths": {
312615 "items": {
3210716 "type": "integer"
332615 },
34410 "type": "array"
352615 },
366397 "filter_has_correspondent": {
37403n/a "nullable": true,
386397 "type": "integer"
396397 },
4015401 "filter_has_document_type": {
41416n/a "nullable": true,
4215401 "type": "integer"
4315401 },
442920 "filter_has_not_correspondents": {
452920 "items": {
4616920 "type": "integer"
472920 },
48490 "type": "array"
492920 },
502017 "filter_has_not_document_types": {
512017 "items": {
529520 "type": "integer"
532017 },
54370 "type": "array"
552017 },
562615 "filter_has_not_storage_paths": {
572615 "items": {
588515 "type": "integer"
592615 },
60410 "type": "array"
612615 },
622516 "filter_has_not_tags": {
632516 "items": {
6411117 "type": "integer"
652516 },
66410 "type": "array"
672516 },
6811378 "filter_has_storage_path": {
69389n/a "nullable": true,
7011378 "type": "integer"
7111378 },
723419 "filter_has_tags": {
733419 "items": {
7412919 "type": "integer"
753419 },
76530 "type": "array"
773419 },
7811378 "filter_mailrule": {
79389n/a "nullable": true,
8011378 "type": "integer"
8111378 },
823862 "filter_path": {
833862 "maxLength": 256,
84388n/a "nullable": true,
85388n/a "type": "string"
863862 },
8732364 "id": {
88396n/a "nullable": true,
8932364 "type": "integer"
9032364 },
913674 "is_insensitive": {
923674 "type": "boolean"
933674 },
943694 "match": {
953694 "maxLength": 256,
96373n/a "type": "string"
973694 },
9836810 "matching_algorithm": {
991n/a "allOf": [
10036810 {
10136810 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10236810 }
1031n/a ],
1043702 "maximum": 9223372036854775807,
1053702 "minimum": 0
10636810 },
10729368 "schedule_date_custom_field": {
108397n/a "nullable": true,
10929368 "type": "integer"
11029368 },
1113643 "schedule_date_field": {
1121n/a "allOf": [
1133643 {
1143643 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1153643 }
1161n/a ],
1173643 },
1183494 "schedule_is_recurring": {
1193494 "type": "boolean"
1203494 },
12134710 "schedule_offset_days": {
12234710 "format": "int64",
1233472 "maximum": 9223372036854775807,
1243490 "minimum": -9223372036854775808,
1253498 "type": "integer"
12634710 },
12734310 "schedule_recurring_interval_days": {
1283458 "format": "int64",
1293452 "maximum": 9223372036854775807,
1303452 "minimum": 1,
1313476 "type": "integer"
13234310 },
13336114 "sources": {
13436114 "items": {
135117714 "$ref": "#/components/schemas/SourcesEnum"
13636114 },
1373750 "type": "array"
13836114 },
1395857 "type": {
1401n/a "allOf": [
1415857 {
1425857 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
1435857 }
1441n/a ],
1455857 }
146125472 },
1475925 "required": [
1485925 "type"
1495925 ],
150597n/a "type": "object"
151123474}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
13643{
23643 "enum": [
3338n/a "added",
47n/a "created",
510n/a "modified",
69n/a "custom_field"
73643 ],
8367n/a "type": "string"
93643}
SourcesEnum3 of 3 keywords
1117714{
2117714 "enum": [
3367n/a 1,
4360n/a 2,
5382n/a 3,
668n/a 4
7117714 ],
8117912 "type": "integer"
9117714}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
136810{
236810 "enum": [
3330n/a 0,
46n/a 1,
517n/a 2,
65n/a 3,
75n/a 4,
85n/a 5
936810 ],
103726 "type": "integer"
1136810}
WorkflowTriggerTypeEnum3 of 3 keywords
15857{
25857 "enum": [
3461n/a 1,
442n/a 2,
549n/a 3,
633n/a 4
75857 ],
85866 "type": "integer"
95857}
multipart/form-data60 / 71
WorkflowTriggerRequest
1124594{
2124594 "properties": {
3556n/a "filter_custom_field_query": {
4556n/a "nullable": true,
5556n/a "type": "string"
6556n/a },
75722 "filter_filename": {
85722 "maxLength": 256,
9574n/a "nullable": true,
10574n/a "type": "string"
115722 },
12926 "filter_has_all_tags": {
13926 "items": {
145229 "type": "integer"
15926 },
16350 "type": "array"
17926 },
182625 "filter_has_any_correspondents": {
192625 "items": {
2010025 "type": "integer"
212625 },
22510 "type": "array"
232625 },
241623 "filter_has_any_document_types": {
251623 "items": {
267123 "type": "integer"
271623 },
28390 "type": "array"
291623 },
301930 "filter_has_any_storage_paths": {
311930 "items": {
325930 "type": "integer"
331930 },
34490 "type": "array"
351930 },
364542 "filter_has_correspondent": {
37546n/a "nullable": true,
384542 "type": "integer"
394542 },
4037546 "filter_has_document_type": {
41583n/a "nullable": true,
4237546 "type": "integer"
4337546 },
441723 "filter_has_not_correspondents": {
451723 "items": {
468423 "type": "integer"
471723 },
48400 "type": "array"
491723 },
501225 "filter_has_not_document_types": {
511225 "items": {
529125 "type": "integer"
531225 },
54370 "type": "array"
551225 },
563223 "filter_has_not_storage_paths": {
573223 "items": {
589924 "type": "integer"
593223 },
60550 "type": "array"
613223 },
621735 "filter_has_not_tags": {
631735 "items": {
6415645 "type": "integer"
651735 },
66520 "type": "array"
671735 },
6814529 "filter_has_storage_path": {
69543n/a "nullable": true,
7014529 "type": "integer"
7114529 },
72836 "filter_has_tags": {
73836 "items": {
7412736 "type": "integer"
75836 },
76440 "type": "array"
77836 },
7816528 "filter_mailrule": {
79544n/a "nullable": true,
8016528 "type": "integer"
8116528 },
825282 "filter_path": {
835282 "maxLength": 256,
84530n/a "nullable": true,
85530n/a "type": "string"
865282 },
8733514 "id": {
88547n/a "nullable": true,
8933514 "type": "integer"
9033514 },
9151410 "is_insensitive": {
9251410 "type": "boolean"
9351410 },
945232 "match": {
955232 "maxLength": 256,
96525n/a "type": "string"
975232 },
9852017 "matching_algorithm": {
991n/a "allOf": [
10052017 {
10152017 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10252017 }
1031n/a ],
1045222 "maximum": 9223372036854775807,
1055222 "minimum": 0
10652017 },
10715507 "schedule_date_custom_field": {
108522n/a "nullable": true,
10915507 "type": "integer"
11015507 },
1115302 "schedule_date_field": {
1121n/a "allOf": [
1135302 {
1145302 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1155302 }
1161n/a ],
1175302 },
11850910 "schedule_is_recurring": {
11950910 "type": "boolean"
12050910 },
12152616 "schedule_offset_days": {
12252616 "format": "int64",
1235262 "maximum": 9223372036854775807,
1245280 "minimum": -9223372036854775808,
12552814 "type": "integer"
12652616 },
12750117 "schedule_recurring_interval_days": {
12850315 "format": "int64",
1295033 "maximum": 9223372036854775807,
1305042 "minimum": 1,
13150612 "type": "integer"
13250117 },
13348724 "sources": {
13448724 "items": {
135147524 "$ref": "#/components/schemas/SourcesEnum"
13648724 },
1375110 "type": "array"
13848724 },
13970412 "type": {
1401n/a "allOf": [
14170412 {
14270412 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14370412 }
1441n/a ],
14570412 }
146124594 },
1477162 "required": [
1487162 "type"
1497162 ],
150718n/a "type": "object"
151124594}
Referenced Components (4)12 of 12 keywords
ScheduleDateFieldEnum3 of 3 keywords
15302{
25302 "enum": [
3502n/a "added",
411n/a "created",
515n/a "modified",
62n/a "custom_field"
75302 ],
8532n/a "type": "string"
95302}
SourcesEnum3 of 3 keywords
1147524{
2147524 "enum": [
3475n/a 1,
4491n/a 2,
5490n/a 3,
619n/a 4
7147524 ],
8147722 "type": "integer"
9147524}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
152017{
252017 "enum": [
3480n/a 0,
47n/a 1,
520n/a 2,
65n/a 3,
73n/a 4,
85n/a 5
952017 ],
1052413 "type": "integer"
1152017}
WorkflowTriggerTypeEnum3 of 3 keywords
170412{
270412 "enum": [
3589n/a 1,
439n/a 2,
526n/a 3,
650n/a 4
770412 ],
870412 "type": "integer"
970412}
Responses1 of 1 documented received
codedescriptionhitsavg
20021920ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request16125ms
404Not Found6024ms
401Unauthorized457ms
415210ms
Examples3 / 3 used
Body: application/json
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: application/x-www-form-urlencoded
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: multipart/form-data
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
workflows 6 operations 3 covered 3 partial 0 uncovered 0 not measured 36% #
Query Parameters2 of 2 keywords covered
page1 / 1
#validinvalidschema
11613505{
21613505 "type": "integer"
31613505}
page_size1 / 1
11589498{
21589498 "type": "integer"
31589498}
Responses1 of 1 documented received
codedescriptionhitsavg
20017669ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1214ms
404Not Found20104ms
Body198 of 546 keywords covered
application/json182 / 182
WorkflowRequest
#validinvalidschema
111612190{
211702171 "properties": {
316921646 "actions": {
416921631 "items": {
539681815 "$ref": "#/components/schemas/WorkflowActionRequest"
616921631 },
7332315 "type": "array"
816921646 },
9275210 "enabled": {
10275210 "type": "boolean"
11275210 },
12332117 "name": {
1333262 "maxLength": 256,
1433235 "minLength": 1,
15332810 "type": "string"
16332117 },
17268513 "order": {
18268513 "type": "integer"
19268513 },
202838500 "triggers": {
212838490 "items": {
224786516 "$ref": "#/components/schemas/WorkflowTriggerRequest"
232838490 },
24332810 "type": "array"
252838500 }
2611702171 },
2733329 "required": [
2833383 "actions",
2933383 "name",
3033383 "triggers"
3133329 ],
32334110 "type": "object"
3311612190}
Referenced Components (9)188 of 188 keywords
ScheduleDateFieldEnum3 of 3 keywords
1146818{
2146818 "enum": [
3797n/a "added",
4237n/a "created",
5237n/a "modified",
6197n/a "custom_field"
7146818 ],
8147115 "type": "string"
9146818}
SourcesEnum3 of 3 keywords
1582423{
2582423 "enum": [
31549n/a 1,
41591n/a 2,
51600n/a 3,
61084n/a 4
7582423 ],
8582423 "type": "integer"
9582423}
WorkflowActionEmailRequest15 of 15 keywords
13181531{
232787 "properties": {
339318 "body": {
43933 "minLength": 1,
539615 "type": "string"
639318 },
725315 "id": {
8268n/a "nullable": true,
925315 "type": "integer"
1025315 },
1123715 "include_document": {
1223715 "type": "boolean"
1323715 },
1439021 "subject": {
153933 "maxLength": 256,
163933 "minLength": 1,
1739615 "type": "string"
1839021 },
1939318 "to": {
203933 "minLength": 1,
2139615 "type": "string"
2239318 }
2332787 },
2440512 "required": [
254116 "body",
264116 "subject",
274116 "to"
2840512 ],
294171432 "type": "object"
303181531}
WorkflowActionRequest73 of 73 keywords
139681815{
231231800 "properties": {
3181815 "ai_create_missing": {
4181815 "type": "boolean"
5181815 },
6187219 "ai_overwrite_existing": {
7187219 "type": "boolean"
8187219 },
91273n/a "ai_suggestion_fields": {
101273n/a "nullable": true
111273n/a },
12180633 "assign_change_groups": {
13180618 "items": {
14279618 "type": "integer"
15180618 },
16182415 "type": "array"
17180633 },
18184633 "assign_change_users": {
19184618 "items": {
20329918 "type": "integer"
21184618 },
22186415 "type": "array"
23184633 },
24192519 "assign_correspondent": {
251944n/a "nullable": true,
26192519 "type": "integer"
27192519 },
28188733 "assign_custom_fields": {
29188718 "items": {
30337118 "type": "integer"
31188718 },
32190515 "type": "array"
33188733 },
341263n/a "assign_custom_fields_values": {
351263n/a "nullable": true,
361263n/a },
37188615 "assign_document_type": {
381901n/a "nullable": true,
39188615 "type": "integer"
40188615 },
41181815 "assign_owner": {
421833n/a "nullable": true,
43181815 "type": "integer"
44181815 },
45189215 "assign_storage_path": {
461907n/a "nullable": true,
47189215 "type": "integer"
48189215 },
49185030 "assign_tags": {
50185015 "items": {
513431n/a "nullable": true,
52341615 "type": "integer"
53185015 },
54186515 "type": "array"
55185030 },
56184412 "assign_title": {
571856n/a "nullable": true,
58184412 "type": "string"
59184412 },
60183733 "assign_view_groups": {
61183718 "items": {
62312518 "type": "integer"
63183718 },
64185515 "type": "array"
65183733 },
66181833 "assign_view_users": {
67181818 "items": {
68282218 "type": "integer"
69181818 },
70183615 "type": "array"
71181833 },
723181531 "email": {
731n/a "allOf": [
743181531 {
753181531 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
763181531 }
771n/a ],
781849n/a "nullable": true
793181531 },
80184519 "id": {
811864n/a "nullable": true,
82184519 "type": "integer"
83184519 },
841243n/a "passwords": {
851243n/a "nullable": true
861243n/a },
87183415 "remove_all_correspondents": {
88183415 "type": "boolean"
89183415 },
90184615 "remove_all_custom_fields": {
91184615 "type": "boolean"
92184615 },
93182315 "remove_all_document_types": {
94182315 "type": "boolean"
95182315 },
96177415 "remove_all_owners": {
97177415 "type": "boolean"
98177415 },
99182115 "remove_all_permissions": {
100182115 "type": "boolean"
101182115 },
102187715 "remove_all_storage_paths": {
103187715 "type": "boolean"
104187715 },
105183021 "remove_all_tags": {
106183021 "type": "boolean"
107183021 },
108184233 "remove_change_groups": {
109184218 "items": {
110328618 "type": "integer"
111184218 },
112186015 "type": "array"
113184233 },
114174133 "remove_change_users": {
115174118 "items": {
116281118 "type": "integer"
117174118 },
118175915 "type": "array"
119174133 },
120183333 "remove_correspondents": {
121183318 "items": {
122336918 "type": "integer"
123183318 },
124185115 "type": "array"
125183333 },
126177433 "remove_custom_fields": {
127177418 "items": {
128301218 "type": "integer"
129177418 },
130179215 "type": "array"
131177433 },
132176733 "remove_document_types": {
133176718 "items": {
134322118 "type": "integer"
135176718 },
136178515 "type": "array"
137176733 },
138179033 "remove_owners": {
139179018 "items": {
140308518 "type": "integer"
141179018 },
142180815 "type": "array"
143179033 },
144179633 "remove_storage_paths": {
145179618 "items": {
146277118 "type": "integer"
147179618 },
148181415 "type": "array"
149179633 },
150181133 "remove_tags": {
151181118 "items": {
152318618 "type": "integer"
153181118 },
154182915 "type": "array"
155181133 },
156183733 "remove_view_groups": {
157183718 "items": {
158321618 "type": "integer"
159183718 },
160185515 "type": "array"
161183733 },
162179533 "remove_view_users": {
163179518 "items": {
164328018 "type": "integer"
165179518 },
166181315 "type": "array"
167179533 },
168181226 "type": {
1691n/a "allOf": [
170181226 {
171181226 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
172181226 }
1731n/a ],
17418203 "maximum": 9223372036854775807,
17518185 "minimum": 0,
176181226 },
1774271418 "webhook": {
1781n/a "allOf": [
1794271418 {
1804271418 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
1814271418 }
1821n/a ],
1831845n/a "nullable": true
1844271418 }
18531231800 },
186576815 "type": "object"
18739681815}
WorkflowActionTypeEnum3 of 3 keywords
1181226{
2181226 "enum": [
31262n/a 1,
469n/a 2,
573n/a 3,
671n/a 4,
788n/a 5,
890n/a 6,
988n/a 7,
1071n/a 8
11181226 ],
12182018 "type": "integer"
13181226}
WorkflowActionWebhookRequest17 of 17 keywords
14271418{
243098 "properties": {
330715 "as_json": {
430715 "type": "boolean"
530715 },
631012 "body": {
7322n/a "nullable": true,
831012 "type": "string"
931012 },
10148n/a "headers": {
11148n/a "nullable": true,
12148n/a },
1330317 "id": {
14320n/a "nullable": true,
1530317 "type": "integer"
1630317 },
1730315 "include_document": {
1830315 "type": "boolean"
1930315 },
20142n/a "params": {
21142n/a "nullable": true,
22142n/a },
2350124 "url": {
245046 "maxLength": 256,
255073 "minLength": 1,
2651015 "type": "string"
2750124 },
2831815 "use_params": {
2931815 "type": "boolean"
3031815 }
3143098 },
325256 "required": [
335256 "url"
345256 ],
355311314 "type": "object"
364271418}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
1147916{
2147916 "enum": [
3694n/a 0,
4151n/a 1,
5147n/a 2,
6152n/a 3,
7174n/a 4,
8161n/a 5
9147916 ],
10148312 "type": "integer"
11147916}
WorkflowTriggerRequest68 of 68 keywords
14786516{
24792499 "properties": {
314988 "filter_custom_field_query": {
41506n/a "nullable": true,
514988 "type": "string"
614988 },
7150910 "filter_filename": {
810402 "maxLength": 256,
91519n/a "nullable": true,
1015118 "type": "string"
11150910 },
12146922 "filter_has_all_tags": {
13146912 "items": {
14453912 "type": "integer"
15146912 },
16148110 "type": "array"
17146922 },
18148722 "filter_has_any_correspondents": {
19148712 "items": {
20418712 "type": "integer"
21148712 },
22149910 "type": "array"
23148722 },
24147422 "filter_has_any_document_types": {
25147412 "items": {
26477112 "type": "integer"
27147412 },
28148610 "type": "array"
29147422 },
30144628 "filter_has_any_storage_paths": {
31144612 "items": {
32425612 "type": "integer"
33144612 },
34145816 "type": "array"
35144628 },
36144010 "filter_has_correspondent": {
371450n/a "nullable": true,
38144010 "type": "integer"
39144010 },
40144814 "filter_has_document_type": {
411462n/a "nullable": true,
42144814 "type": "integer"
43144814 },
44143341 "filter_has_not_correspondents": {
45143316 "items": {
46450229 "type": "integer"
47143316 },
48144925 "type": "array"
49143341 },
50147522 "filter_has_not_document_types": {
51147512 "items": {
52437212 "type": "integer"
53147512 },
54148710 "type": "array"
55147522 },
56142722 "filter_has_not_storage_paths": {
57142712 "items": {
58447812 "type": "integer"
59142712 },
60143910 "type": "array"
61142722 },
62150822 "filter_has_not_tags": {
63150812 "items": {
64468112 "type": "integer"
65150812 },
66152010 "type": "array"
67150822 },
68149915 "filter_has_storage_path": {
691514n/a "nullable": true,
70149915 "type": "integer"
71149915 },
72140922 "filter_has_tags": {
73140912 "items": {
74403312 "type": "integer"
75140912 },
76142110 "type": "array"
77140922 },
78145410 "filter_mailrule": {
791464n/a "nullable": true,
80145410 "type": "integer"
81145410 },
82147716 "filter_path": {
8310632 "maxLength": 256,
841493n/a "nullable": true,
85147914 "type": "string"
86147716 },
87151110 "id": {
881521n/a "nullable": true,
89151110 "type": "integer"
90151110 },
91142014 "is_insensitive": {
92142014 "type": "boolean"
93142014 },
94148013 "match": {
9514803 "maxLength": 256,
96148310 "type": "string"
97148013 },
98147916 "matching_algorithm": {
991n/a "allOf": [
100147916 {
101147916 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
102147916 }
1031n/a ],
10414832 "maximum": 9223372036854775807,
10514832 "minimum": 0
106147916 },
107140915 "schedule_date_custom_field": {
1081424n/a "nullable": true,
109140915 "type": "integer"
110140915 },
111146818 "schedule_date_field": {
1121n/a "allOf": [
113146818 {
114146818 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
115146818 }
1161n/a ],
117146818 },
118146315 "schedule_is_recurring": {
119146315 "type": "boolean"
120146315 },
121138329 "schedule_offset_days": {
122138329 "format": "int64",
12313905 "maximum": 9223372036854775807,
12413914 "minimum": -9223372036854775808,
125139220 "type": "integer"
126138329 },
127146224 "schedule_recurring_interval_days": {
128146521 "format": "int64",
12914683 "maximum": 9223372036854775807,
13014656 "minimum": 1,
131146818 "type": "integer"
132146224 },
133140933 "sources": {
134140923 "items": {
135582423 "$ref": "#/components/schemas/SourcesEnum"
136140923 },
137143210 "type": "array"
138140933 },
139527312 "type": {
1401n/a "allOf": [
141527312 {
142527312 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
143527312 }
1441n/a ],
145527312 }
1464792499 },
14752857 "required": [
14852857 "type"
14952857 ],
150529210 "type": "object"
1514786516}
WorkflowTriggerTypeEnum3 of 3 keywords
1527312{
2527312 "enum": [
31922n/a 1,
41088n/a 2,
51163n/a 3,
61100n/a 4
7527312 ],
8527312 "type": "integer"
9527312}
application/x-www-form-urlencoded8 / 182
WorkflowRequest
102901{
2872814 "properties": {
301963 "actions": {
401963 "items": {
5070509 "$ref": "#/components/schemas/WorkflowActionRequest"
601963 },
719630 "type": "array"
801963 },
922866 "enabled": {
1022866 "type": "boolean"
1122866 },
12286038 "name": {
1328908 "maxLength": 256,
14286830 "minLength": 1,
152898n/a "type": "string"
16286038 },
17226132 "order": {
18226132 "type": "integer"
19226132 },
2001452 "triggers": {
2101452 "items": {
22050802 "$ref": "#/components/schemas/WorkflowTriggerRequest"
2301452 },
2414520 "type": "array"
2501452 }
26872814 },
276312270 "required": [
281963938 "actions",
2928983 "name",
3014521449 "triggers"
316312270 ],
322901n/a "type": "object"
3302901}
Referenced Components (9)0 of 188 keywords
ScheduleDateFieldEnum0 of 3 keywords
100{
200 "enum": [
30n/a "added",
40n/a "created",
50n/a "modified",
60n/a "custom_field"
700 ],
800 "type": "string"
900}
SourcesEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
WorkflowActionEmailRequest0 of 15 keywords
100{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2900 "type": "object"
3000}
WorkflowActionRequest0 of 73 keywords
1070509{
200 "properties": {
300 "ai_create_missing": {
400 "type": "boolean"
500 },
600 "ai_overwrite_existing": {
700 "type": "boolean"
800 },
90n/a "ai_suggestion_fields": {
100n/a "nullable": true
110n/a },
1200 "assign_change_groups": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "assign_change_users": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "assign_correspondent": {
250n/a "nullable": true,
2600 "type": "integer"
2700 },
2800 "assign_custom_fields": {
2900 "items": {
3000 "type": "integer"
3100 },
3200 "type": "array"
3300 },
340n/a "assign_custom_fields_values": {
350n/a "nullable": true,
360n/a },
3700 "assign_document_type": {
380n/a "nullable": true,
3900 "type": "integer"
4000 },
4100 "assign_owner": {
420n/a "nullable": true,
4300 "type": "integer"
4400 },
4500 "assign_storage_path": {
460n/a "nullable": true,
4700 "type": "integer"
4800 },
4900 "assign_tags": {
5000 "items": {
510n/a "nullable": true,
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "assign_title": {
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "assign_view_groups": {
6100 "items": {
6200 "type": "integer"
6300 },
6400 "type": "array"
6500 },
6600 "assign_view_users": {
6700 "items": {
6800 "type": "integer"
6900 },
7000 "type": "array"
7100 },
7200 "email": {
730n/a "allOf": [
7400 {
7500 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7600 }
770n/a ],
780n/a "nullable": true
7900 },
8000 "id": {
810n/a "nullable": true,
8200 "type": "integer"
8300 },
840n/a "passwords": {
850n/a "nullable": true
860n/a },
8700 "remove_all_correspondents": {
8800 "type": "boolean"
8900 },
9000 "remove_all_custom_fields": {
9100 "type": "boolean"
9200 },
9300 "remove_all_document_types": {
9400 "type": "boolean"
9500 },
9600 "remove_all_owners": {
9700 "type": "boolean"
9800 },
9900 "remove_all_permissions": {
10000 "type": "boolean"
10100 },
10200 "remove_all_storage_paths": {
10300 "type": "boolean"
10400 },
10500 "remove_all_tags": {
10600 "type": "boolean"
10700 },
10800 "remove_change_groups": {
10900 "items": {
11000 "type": "integer"
11100 },
11200 "type": "array"
11300 },
11400 "remove_change_users": {
11500 "items": {
11600 "type": "integer"
11700 },
11800 "type": "array"
11900 },
12000 "remove_correspondents": {
12100 "items": {
12200 "type": "integer"
12300 },
12400 "type": "array"
12500 },
12600 "remove_custom_fields": {
12700 "items": {
12800 "type": "integer"
12900 },
13000 "type": "array"
13100 },
13200 "remove_document_types": {
13300 "items": {
13400 "type": "integer"
13500 },
13600 "type": "array"
13700 },
13800 "remove_owners": {
13900 "items": {
14000 "type": "integer"
14100 },
14200 "type": "array"
14300 },
14400 "remove_storage_paths": {
14500 "items": {
14600 "type": "integer"
14700 },
14800 "type": "array"
14900 },
15000 "remove_tags": {
15100 "items": {
15200 "type": "integer"
15300 },
15400 "type": "array"
15500 },
15600 "remove_view_groups": {
15700 "items": {
15800 "type": "integer"
15900 },
16000 "type": "array"
16100 },
16200 "remove_view_users": {
16300 "items": {
16400 "type": "integer"
16500 },
16600 "type": "array"
16700 },
16800 "type": {
1690n/a "allOf": [
17000 {
17100 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17200 }
1730n/a ],
17400 "maximum": 9223372036854775807,
17500 "minimum": 0,
17600 },
17700 "webhook": {
1780n/a "allOf": [
17900 {
18000 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18100 }
1820n/a ],
1830n/a "nullable": true
18400 }
18500 },
186070509 "type": "object"
187070509}
WorkflowActionTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4,
70n/a 5,
80n/a 6,
90n/a 7,
100n/a 8
1100 ],
1200 "type": "integer"
1300}
WorkflowActionWebhookRequest0 of 17 keywords
100{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3500 "type": "object"
3600}
WorkflowTriggerMatchingAlgorithmEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5
900 ],
1000 "type": "integer"
1100}
WorkflowTriggerRequest0 of 68 keywords
1050802{
200 "properties": {
300 "filter_custom_field_query": {
40n/a "nullable": true,
500 "type": "string"
600 },
700 "filter_filename": {
800 "maxLength": 256,
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "filter_has_all_tags": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "filter_has_any_correspondents": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "filter_has_any_document_types": {
2500 "items": {
2600 "type": "integer"
2700 },
2800 "type": "array"
2900 },
3000 "filter_has_any_storage_paths": {
3100 "items": {
3200 "type": "integer"
3300 },
3400 "type": "array"
3500 },
3600 "filter_has_correspondent": {
370n/a "nullable": true,
3800 "type": "integer"
3900 },
4000 "filter_has_document_type": {
410n/a "nullable": true,
4200 "type": "integer"
4300 },
4400 "filter_has_not_correspondents": {
4500 "items": {
4600 "type": "integer"
4700 },
4800 "type": "array"
4900 },
5000 "filter_has_not_document_types": {
5100 "items": {
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "filter_has_not_storage_paths": {
5700 "items": {
5800 "type": "integer"
5900 },
6000 "type": "array"
6100 },
6200 "filter_has_not_tags": {
6300 "items": {
6400 "type": "integer"
6500 },
6600 "type": "array"
6700 },
6800 "filter_has_storage_path": {
690n/a "nullable": true,
7000 "type": "integer"
7100 },
7200 "filter_has_tags": {
7300 "items": {
7400 "type": "integer"
7500 },
7600 "type": "array"
7700 },
7800 "filter_mailrule": {
790n/a "nullable": true,
8000 "type": "integer"
8100 },
8200 "filter_path": {
8300 "maxLength": 256,
840n/a "nullable": true,
8500 "type": "string"
8600 },
8700 "id": {
880n/a "nullable": true,
8900 "type": "integer"
9000 },
9100 "is_insensitive": {
9200 "type": "boolean"
9300 },
9400 "match": {
9500 "maxLength": 256,
9600 "type": "string"
9700 },
9800 "matching_algorithm": {
990n/a "allOf": [
10000 {
10100 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10200 }
1030n/a ],
10400 "maximum": 9223372036854775807,
10500 "minimum": 0
10600 },
10700 "schedule_date_custom_field": {
1080n/a "nullable": true,
10900 "type": "integer"
11000 },
11100 "schedule_date_field": {
1120n/a "allOf": [
11300 {
11400 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11500 }
1160n/a ],
11700 },
11800 "schedule_is_recurring": {
11900 "type": "boolean"
12000 },
12100 "schedule_offset_days": {
12200 "format": "int64",
12300 "maximum": 9223372036854775807,
12400 "minimum": -9223372036854775808,
12500 "type": "integer"
12600 },
12700 "schedule_recurring_interval_days": {
12800 "format": "int64",
12900 "maximum": 9223372036854775807,
13000 "minimum": 1,
13100 "type": "integer"
13200 },
13300 "sources": {
13400 "items": {
13500 "$ref": "#/components/schemas/SourcesEnum"
13600 },
13700 "type": "array"
13800 },
13900 "type": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14300 }
1440n/a ],
14500 }
14600 },
14700 "required": [
14800 "type"
14900 ],
150050802 "type": "object"
151050802}
WorkflowTriggerTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
multipart/form-data8 / 182
WorkflowRequest
103081{
2513029 "properties": {
302002 "actions": {
402002 "items": {
503735 "$ref": "#/components/schemas/WorkflowActionRequest"
602002 },
720020 "type": "array"
802002 },
9277716 "enabled": {
10277716 "type": "boolean"
11277716 },
12306413 "name": {
1330716 "maxLength": 256,
1430707 "minLength": 1,
153077n/a "type": "string"
16306413 },
17276521 "order": {
18276521 "type": "integer"
19276521 },
2001369 "triggers": {
2101369 "items": {
2203516 "$ref": "#/components/schemas/WorkflowTriggerRequest"
2301369 },
2413690 "type": "array"
2501369 }
26513029 },
273812700 "required": [
2820021079 "actions",
2930774 "name",
3013691712 "triggers"
313812700 ],
323081n/a "type": "object"
3303081}
Referenced Components (9)0 of 188 keywords
ScheduleDateFieldEnum0 of 3 keywords
100{
200 "enum": [
30n/a "added",
40n/a "created",
50n/a "modified",
60n/a "custom_field"
700 ],
800 "type": "string"
900}
SourcesEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
WorkflowActionEmailRequest0 of 15 keywords
100{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2900 "type": "object"
3000}
WorkflowActionRequest0 of 73 keywords
103735{
200 "properties": {
300 "ai_create_missing": {
400 "type": "boolean"
500 },
600 "ai_overwrite_existing": {
700 "type": "boolean"
800 },
90n/a "ai_suggestion_fields": {
100n/a "nullable": true
110n/a },
1200 "assign_change_groups": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "assign_change_users": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "assign_correspondent": {
250n/a "nullable": true,
2600 "type": "integer"
2700 },
2800 "assign_custom_fields": {
2900 "items": {
3000 "type": "integer"
3100 },
3200 "type": "array"
3300 },
340n/a "assign_custom_fields_values": {
350n/a "nullable": true,
360n/a },
3700 "assign_document_type": {
380n/a "nullable": true,
3900 "type": "integer"
4000 },
4100 "assign_owner": {
420n/a "nullable": true,
4300 "type": "integer"
4400 },
4500 "assign_storage_path": {
460n/a "nullable": true,
4700 "type": "integer"
4800 },
4900 "assign_tags": {
5000 "items": {
510n/a "nullable": true,
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "assign_title": {
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "assign_view_groups": {
6100 "items": {
6200 "type": "integer"
6300 },
6400 "type": "array"
6500 },
6600 "assign_view_users": {
6700 "items": {
6800 "type": "integer"
6900 },
7000 "type": "array"
7100 },
7200 "email": {
730n/a "allOf": [
7400 {
7500 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7600 }
770n/a ],
780n/a "nullable": true
7900 },
8000 "id": {
810n/a "nullable": true,
8200 "type": "integer"
8300 },
840n/a "passwords": {
850n/a "nullable": true
860n/a },
8700 "remove_all_correspondents": {
8800 "type": "boolean"
8900 },
9000 "remove_all_custom_fields": {
9100 "type": "boolean"
9200 },
9300 "remove_all_document_types": {
9400 "type": "boolean"
9500 },
9600 "remove_all_owners": {
9700 "type": "boolean"
9800 },
9900 "remove_all_permissions": {
10000 "type": "boolean"
10100 },
10200 "remove_all_storage_paths": {
10300 "type": "boolean"
10400 },
10500 "remove_all_tags": {
10600 "type": "boolean"
10700 },
10800 "remove_change_groups": {
10900 "items": {
11000 "type": "integer"
11100 },
11200 "type": "array"
11300 },
11400 "remove_change_users": {
11500 "items": {
11600 "type": "integer"
11700 },
11800 "type": "array"
11900 },
12000 "remove_correspondents": {
12100 "items": {
12200 "type": "integer"
12300 },
12400 "type": "array"
12500 },
12600 "remove_custom_fields": {
12700 "items": {
12800 "type": "integer"
12900 },
13000 "type": "array"
13100 },
13200 "remove_document_types": {
13300 "items": {
13400 "type": "integer"
13500 },
13600 "type": "array"
13700 },
13800 "remove_owners": {
13900 "items": {
14000 "type": "integer"
14100 },
14200 "type": "array"
14300 },
14400 "remove_storage_paths": {
14500 "items": {
14600 "type": "integer"
14700 },
14800 "type": "array"
14900 },
15000 "remove_tags": {
15100 "items": {
15200 "type": "integer"
15300 },
15400 "type": "array"
15500 },
15600 "remove_view_groups": {
15700 "items": {
15800 "type": "integer"
15900 },
16000 "type": "array"
16100 },
16200 "remove_view_users": {
16300 "items": {
16400 "type": "integer"
16500 },
16600 "type": "array"
16700 },
16800 "type": {
1690n/a "allOf": [
17000 {
17100 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17200 }
1730n/a ],
17400 "maximum": 9223372036854775807,
17500 "minimum": 0,
17600 },
17700 "webhook": {
1780n/a "allOf": [
17900 {
18000 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18100 }
1820n/a ],
1830n/a "nullable": true
18400 }
18500 },
18603735 "type": "object"
18703735}
WorkflowActionTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4,
70n/a 5,
80n/a 6,
90n/a 7,
100n/a 8
1100 ],
1200 "type": "integer"
1300}
WorkflowActionWebhookRequest0 of 17 keywords
100{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3500 "type": "object"
3600}
WorkflowTriggerMatchingAlgorithmEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5
900 ],
1000 "type": "integer"
1100}
WorkflowTriggerRequest0 of 68 keywords
103516{
200 "properties": {
300 "filter_custom_field_query": {
40n/a "nullable": true,
500 "type": "string"
600 },
700 "filter_filename": {
800 "maxLength": 256,
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "filter_has_all_tags": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "filter_has_any_correspondents": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "filter_has_any_document_types": {
2500 "items": {
2600 "type": "integer"
2700 },
2800 "type": "array"
2900 },
3000 "filter_has_any_storage_paths": {
3100 "items": {
3200 "type": "integer"
3300 },
3400 "type": "array"
3500 },
3600 "filter_has_correspondent": {
370n/a "nullable": true,
3800 "type": "integer"
3900 },
4000 "filter_has_document_type": {
410n/a "nullable": true,
4200 "type": "integer"
4300 },
4400 "filter_has_not_correspondents": {
4500 "items": {
4600 "type": "integer"
4700 },
4800 "type": "array"
4900 },
5000 "filter_has_not_document_types": {
5100 "items": {
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "filter_has_not_storage_paths": {
5700 "items": {
5800 "type": "integer"
5900 },
6000 "type": "array"
6100 },
6200 "filter_has_not_tags": {
6300 "items": {
6400 "type": "integer"
6500 },
6600 "type": "array"
6700 },
6800 "filter_has_storage_path": {
690n/a "nullable": true,
7000 "type": "integer"
7100 },
7200 "filter_has_tags": {
7300 "items": {
7400 "type": "integer"
7500 },
7600 "type": "array"
7700 },
7800 "filter_mailrule": {
790n/a "nullable": true,
8000 "type": "integer"
8100 },
8200 "filter_path": {
8300 "maxLength": 256,
840n/a "nullable": true,
8500 "type": "string"
8600 },
8700 "id": {
880n/a "nullable": true,
8900 "type": "integer"
9000 },
9100 "is_insensitive": {
9200 "type": "boolean"
9300 },
9400 "match": {
9500 "maxLength": 256,
9600 "type": "string"
9700 },
9800 "matching_algorithm": {
990n/a "allOf": [
10000 {
10100 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10200 }
1030n/a ],
10400 "maximum": 9223372036854775807,
10500 "minimum": 0
10600 },
10700 "schedule_date_custom_field": {
1080n/a "nullable": true,
10900 "type": "integer"
11000 },
11100 "schedule_date_field": {
1120n/a "allOf": [
11300 {
11400 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11500 }
1160n/a ],
11700 },
11800 "schedule_is_recurring": {
11900 "type": "boolean"
12000 },
12100 "schedule_offset_days": {
12200 "format": "int64",
12300 "maximum": 9223372036854775807,
12400 "minimum": -9223372036854775808,
12500 "type": "integer"
12600 },
12700 "schedule_recurring_interval_days": {
12800 "format": "int64",
12900 "maximum": 9223372036854775807,
13000 "minimum": 1,
13100 "type": "integer"
13200 },
13300 "sources": {
13400 "items": {
13500 "$ref": "#/components/schemas/SourcesEnum"
13600 },
13700 "type": "array"
13800 },
13900 "type": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14300 }
1440n/a ],
14500 }
14600 },
14700 "required": [
14800 "type"
14900 ],
15003516 "type": "object"
15103516}
WorkflowTriggerTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
Responses1 of 1 documented received
codedescriptionhitsavg
20110117ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request95545ms
401Unauthorized1124ms
500Internal Server Error1212ms
41524ms
Examples1 / 3 used
Body: application/json
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: application/x-www-form-urlencoded
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: multipart/form-data
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
11585{
21585 "type": "integer"
31585}
Responses1 of 1 documented received
codedescriptionhitsavg
204No response body6713ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found734ms
401Unauthorized2311ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
161914{
261914 "type": "integer"
361914}
Responses1 of 1 documented received
codedescriptionhitsavg
2003465ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2333ms
401Unauthorized546ms
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
129927{
229927 "type": "integer"
329927}
Body195 of 543 keywords covered
application/json181 / 181
PatchedWorkflowRequest
1444732{
2260727 "properties": {
3484481 "actions": {
4484476 "items": {
5265489 "$ref": "#/components/schemas/WorkflowActionRequest"
6484476 },
79605 "type": "array"
8484481 },
99035 "enabled": {
109035 "type": "boolean"
119035 },
129039 "name": {
139061 "maxLength": 256,
149043 "minLength": 1,
159075 "type": "string"
169039 },
178936 "order": {
188936 "type": "integer"
198936 },
20680226 "triggers": {
21680221 "items": {
22254236 "$ref": "#/components/schemas/WorkflowTriggerRequest"
23680221 },
249015 "type": "array"
25680226 }
26260727 },
2711715 "type": "object"
28444732}
Referenced Components (9)188 of 188 keywords
ScheduleDateFieldEnum3 of 3 keywords
12796{
22796 "enum": [
3259n/a "added",
49n/a "created",
53n/a "modified",
68n/a "custom_field"
72796 ],
82805 "type": "string"
92796}
SourcesEnum3 of 3 keywords
18716{
28716 "enum": [
3274n/a 1,
4279n/a 2,
5289n/a 3,
629n/a 4
78716 ],
88716 "type": "integer"
98716}
WorkflowActionEmailRequest15 of 15 keywords
117458{
22038 "properties": {
34215 "body": {
4421 "minLength": 1,
54314 "type": "string"
64215 },
7435 "id": {
848n/a "nullable": true,
9435 "type": "integer"
10435 },
11455 "include_document": {
12455 "type": "boolean"
13455 },
14507 "subject": {
15511 "maxLength": 256,
16511 "minLength": 1,
17525 "type": "string"
18507 },
19516 "to": {
20511 "minLength": 1,
21525 "type": "string"
22516 }
232038 },
24554 "required": [
25572 "body",
26572 "subject",
27572 "to"
28554 ],
2959416 "type": "object"
3017458}
WorkflowActionRequest73 of 73 keywords
1265489{
2133484 "properties": {
34865 "ai_create_missing": {
44865 "type": "boolean"
54865 },
64795 "ai_overwrite_existing": {
74795 "type": "boolean"
84795 },
9469n/a "ai_suggestion_fields": {
10469n/a "nullable": true
11469n/a },
1248511 "assign_change_groups": {
134856 "items": {
141076 "type": "integer"
154856 },
164915 "type": "array"
1748511 },
1847611 "assign_change_users": {
194766 "items": {
20906 "type": "integer"
214766 },
224825 "type": "array"
2347611 },
244735 "assign_correspondent": {
25478n/a "nullable": true,
264735 "type": "integer"
274735 },
2847811 "assign_custom_fields": {
294786 "items": {
301876 "type": "integer"
314786 },
324845 "type": "array"
3347811 },
34464n/a "assign_custom_fields_values": {
35464n/a "nullable": true,
36464n/a },
374865 "assign_document_type": {
38491n/a "nullable": true,
394865 "type": "integer"
404865 },
414695 "assign_owner": {
42474n/a "nullable": true,
434695 "type": "integer"
444695 },
454635 "assign_storage_path": {
46468n/a "nullable": true,
474635 "type": "integer"
484635 },
4946410 "assign_tags": {
504645 "items": {
51105n/a "nullable": true,
521005 "type": "integer"
534645 },
544695 "type": "array"
5546410 },
564664 "assign_title": {
57470n/a "nullable": true,
584664 "type": "string"
594664 },
6046511 "assign_view_groups": {
614656 "items": {
62476 "type": "integer"
634656 },
644715 "type": "array"
6546511 },
6646313 "assign_view_users": {
674638 "items": {
687110 "type": "integer"
694638 },
704715 "type": "array"
7146313 },
7217458 "email": {
731n/a "allOf": [
7417458 {
7517458 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7617458 }
771n/a ],
78475n/a "nullable": true
7917458 },
804595 "id": {
81464n/a "nullable": true,
824595 "type": "integer"
834595 },
84454n/a "passwords": {
85454n/a "nullable": true
86454n/a },
874665 "remove_all_correspondents": {
884665 "type": "boolean"
894665 },
904625 "remove_all_custom_fields": {
914625 "type": "boolean"
924625 },
934545 "remove_all_document_types": {
944545 "type": "boolean"
954545 },
964565 "remove_all_owners": {
974565 "type": "boolean"
984565 },
994565 "remove_all_permissions": {
1004565 "type": "boolean"
1014565 },
1024585 "remove_all_storage_paths": {
1034585 "type": "boolean"
1044585 },
1054555 "remove_all_tags": {
1064555 "type": "boolean"
1074555 },
10845020 "remove_change_groups": {
1094506 "items": {
1101036 "type": "integer"
1114506 },
11245614 "type": "array"
11345020 },
11445511 "remove_change_users": {
1154556 "items": {
116916 "type": "integer"
1174556 },
1184615 "type": "array"
11945511 },
12044111 "remove_correspondents": {
1214416 "items": {
122246 "type": "integer"
1234416 },
1244475 "type": "array"
12544111 },
12644611 "remove_custom_fields": {
1274466 "items": {
128756 "type": "integer"
1294466 },
1304525 "type": "array"
13144611 },
13245211 "remove_document_types": {
1334526 "items": {
134456 "type": "integer"
1354526 },
1364585 "type": "array"
13745211 },
13844011 "remove_owners": {
1394406 "items": {
140286 "type": "integer"
1414406 },
1424465 "type": "array"
14344011 },
14444611 "remove_storage_paths": {
1454466 "items": {
1461226 "type": "integer"
1474466 },
1484525 "type": "array"
14944611 },
15044111 "remove_tags": {
1514416 "items": {
152596 "type": "integer"
1534416 },
1544475 "type": "array"
15544111 },
15644511 "remove_view_groups": {
1574456 "items": {
158886 "type": "integer"
1594456 },
1604515 "type": "array"
16144511 },
16243911 "remove_view_users": {
1634396 "items": {
164686 "type": "integer"
1654396 },
1664455 "type": "array"
16743911 },
1684458 "type": {
1691n/a "allOf": [
1704458 {
1714458 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
1724458 }
1731n/a ],
1744471 "maximum": 9223372036854775807,
1754471 "minimum": 0,
1764458 },
17741415 "webhook": {
1781n/a "allOf": [
17941415 {
18041415 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18141415 }
1821n/a ],
183456n/a "nullable": true
18441415 }
185133484 },
1867495 "type": "object"
187265489}
WorkflowActionTypeEnum3 of 3 keywords
14458{
24458 "enum": [
3422n/a 1,
43n/a 2,
53n/a 3,
64n/a 4,
72n/a 5,
83n/a 6,
96n/a 7,
102n/a 8
114458 ],
124476 "type": "integer"
134458}
WorkflowActionWebhookRequest17 of 17 keywords
141415{
24231 "properties": {
3565 "as_json": {
4565 "type": "boolean"
5565 },
6604 "body": {
764n/a "nullable": true,
8604 "type": "string"
9604 },
1058n/a "headers": {
1158n/a "nullable": true,
1258n/a },
13555 "id": {
1460n/a "nullable": true,
15555 "type": "integer"
16555 },
17555 "include_document": {
18555 "type": "boolean"
19555 },
2055n/a "params": {
2155n/a "nullable": true,
2255n/a },
23657 "url": {
24661 "maxLength": 256,
25661 "minLength": 1,
26675 "type": "string"
27657 },
28525 "use_params": {
29525 "type": "boolean"
30525 }
314231 },
32722 "required": [
33722 "url"
34722 ],
3574382 "type": "object"
3641415}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
12798{
22798 "enum": [
3258n/a 0,
41n/a 1,
53n/a 2,
63n/a 3,
75n/a 4,
89n/a 5
92798 ],
102816 "type": "integer"
112798}
WorkflowTriggerRequest68 of 68 keywords
1254236{
2255230 "properties": {
33044 "filter_custom_field_query": {
4308n/a "nullable": true,
53044 "type": "string"
63044 },
73065 "filter_filename": {
82871 "maxLength": 256,
9311n/a "nullable": true,
103074 "type": "string"
113065 },
1230111 "filter_has_all_tags": {
133016 "items": {
141796 "type": "integer"
153016 },
163075 "type": "array"
1730111 },
1829011 "filter_has_any_correspondents": {
192906 "items": {
20786 "type": "integer"
212906 },
222965 "type": "array"
2329011 },
2429233 "filter_has_any_document_types": {
2529228 "items": {
2616869 "type": "integer"
2729228 },
283205 "type": "array"
2929233 },
3029611 "filter_has_any_storage_paths": {
312966 "items": {
321336 "type": "integer"
332966 },
343025 "type": "array"
3529611 },
362885 "filter_has_correspondent": {
37293n/a "nullable": true,
382885 "type": "integer"
392885 },
403045 "filter_has_document_type": {
41309n/a "nullable": true,
423045 "type": "integer"
433045 },
4427611 "filter_has_not_correspondents": {
452766 "items": {
46696 "type": "integer"
472766 },
482825 "type": "array"
4927611 },
5028911 "filter_has_not_document_types": {
512896 "items": {
521596 "type": "integer"
532896 },
542955 "type": "array"
5528911 },
5628911 "filter_has_not_storage_paths": {
572896 "items": {
581926 "type": "integer"
592896 },
602955 "type": "array"
6128911 },
6230411 "filter_has_not_tags": {
633046 "items": {
641386 "type": "integer"
653046 },
663105 "type": "array"
6730411 },
682895 "filter_has_storage_path": {
69294n/a "nullable": true,
702895 "type": "integer"
712895 },
7228811 "filter_has_tags": {
732886 "items": {
742246 "type": "integer"
752886 },
762945 "type": "array"
7728811 },
782875 "filter_mailrule": {
79292n/a "nullable": true,
802875 "type": "integer"
812875 },
822915 "filter_path": {
832771 "maxLength": 256,
84296n/a "nullable": true,
852924 "type": "string"
862915 },
872795 "id": {
88284n/a "nullable": true,
892795 "type": "integer"
902795 },
912845 "is_insensitive": {
922845 "type": "boolean"
932845 },
942796 "match": {
952791 "maxLength": 256,
962805 "type": "string"
972796 },
982798 "matching_algorithm": {
991n/a "allOf": [
1002798 {
1012798 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
1022798 }
1031n/a ],
1042811 "maximum": 9223372036854775807,
1052811 "minimum": 0
1062798 },
1072867 "schedule_date_custom_field": {
108293n/a "nullable": true,
1092867 "type": "integer"
1102867 },
1112796 "schedule_date_field": {
1121n/a "allOf": [
1132796 {
1142796 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1152796 }
1161n/a ],
1172796 },
1182855 "schedule_is_recurring": {
1192855 "type": "boolean"
1202855 },
12127330 "schedule_offset_days": {
12227330 "format": "int64",
1232751 "maximum": 9223372036854775807,
1242751 "minimum": -9223372036854775808,
12527528 "type": "integer"
12627330 },
1272728 "schedule_recurring_interval_days": {
1282737 "format": "int64",
1292741 "maximum": 9223372036854775807,
1302732 "minimum": 1,
1312746 "type": "integer"
1322728 },
13327111 "sources": {
1342716 "items": {
1358716 "$ref": "#/components/schemas/SourcesEnum"
1362716 },
1372775 "type": "array"
13827111 },
1394786 "type": {
1401n/a "allOf": [
1414786 {
1424786 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
1434786 }
1441n/a ],
1454786 }
146255230 },
1474841 "required": [
1484841 "type"
1494841 ],
1504855 "type": "object"
151254236}
WorkflowTriggerTypeEnum3 of 3 keywords
14786{
24786 "enum": [
3356n/a 1,
434n/a 2,
548n/a 3,
640n/a 4
74786 ],
84786 "type": "integer"
94786}
application/x-www-form-urlencoded7 / 181
PatchedWorkflowRequest
157665{
231665 "properties": {
30415 "actions": {
40415 "items": {
5013000 "$ref": "#/components/schemas/WorkflowActionRequest"
60415 },
74150 "type": "array"
80415 },
96592 "enabled": {
106592 "type": "boolean"
116592 },
126673 "name": {
136682 "maxLength": 256,
146691 "minLength": 1,
15670n/a "type": "string"
166673 },
176615 "order": {
186615 "type": "integer"
196615 },
200270 "triggers": {
210270 "items": {
2206417 "$ref": "#/components/schemas/WorkflowTriggerRequest"
230270 },
242700 "type": "array"
250270 }
2631665 },
27722n/a "type": "object"
2857665}
Referenced Components (9)0 of 188 keywords
ScheduleDateFieldEnum0 of 3 keywords
100{
200 "enum": [
30n/a "added",
40n/a "created",
50n/a "modified",
60n/a "custom_field"
700 ],
800 "type": "string"
900}
SourcesEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
WorkflowActionEmailRequest0 of 15 keywords
100{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2900 "type": "object"
3000}
WorkflowActionRequest0 of 73 keywords
1013000{
200 "properties": {
300 "ai_create_missing": {
400 "type": "boolean"
500 },
600 "ai_overwrite_existing": {
700 "type": "boolean"
800 },
90n/a "ai_suggestion_fields": {
100n/a "nullable": true
110n/a },
1200 "assign_change_groups": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "assign_change_users": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "assign_correspondent": {
250n/a "nullable": true,
2600 "type": "integer"
2700 },
2800 "assign_custom_fields": {
2900 "items": {
3000 "type": "integer"
3100 },
3200 "type": "array"
3300 },
340n/a "assign_custom_fields_values": {
350n/a "nullable": true,
360n/a },
3700 "assign_document_type": {
380n/a "nullable": true,
3900 "type": "integer"
4000 },
4100 "assign_owner": {
420n/a "nullable": true,
4300 "type": "integer"
4400 },
4500 "assign_storage_path": {
460n/a "nullable": true,
4700 "type": "integer"
4800 },
4900 "assign_tags": {
5000 "items": {
510n/a "nullable": true,
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "assign_title": {
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "assign_view_groups": {
6100 "items": {
6200 "type": "integer"
6300 },
6400 "type": "array"
6500 },
6600 "assign_view_users": {
6700 "items": {
6800 "type": "integer"
6900 },
7000 "type": "array"
7100 },
7200 "email": {
730n/a "allOf": [
7400 {
7500 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7600 }
770n/a ],
780n/a "nullable": true
7900 },
8000 "id": {
810n/a "nullable": true,
8200 "type": "integer"
8300 },
840n/a "passwords": {
850n/a "nullable": true
860n/a },
8700 "remove_all_correspondents": {
8800 "type": "boolean"
8900 },
9000 "remove_all_custom_fields": {
9100 "type": "boolean"
9200 },
9300 "remove_all_document_types": {
9400 "type": "boolean"
9500 },
9600 "remove_all_owners": {
9700 "type": "boolean"
9800 },
9900 "remove_all_permissions": {
10000 "type": "boolean"
10100 },
10200 "remove_all_storage_paths": {
10300 "type": "boolean"
10400 },
10500 "remove_all_tags": {
10600 "type": "boolean"
10700 },
10800 "remove_change_groups": {
10900 "items": {
11000 "type": "integer"
11100 },
11200 "type": "array"
11300 },
11400 "remove_change_users": {
11500 "items": {
11600 "type": "integer"
11700 },
11800 "type": "array"
11900 },
12000 "remove_correspondents": {
12100 "items": {
12200 "type": "integer"
12300 },
12400 "type": "array"
12500 },
12600 "remove_custom_fields": {
12700 "items": {
12800 "type": "integer"
12900 },
13000 "type": "array"
13100 },
13200 "remove_document_types": {
13300 "items": {
13400 "type": "integer"
13500 },
13600 "type": "array"
13700 },
13800 "remove_owners": {
13900 "items": {
14000 "type": "integer"
14100 },
14200 "type": "array"
14300 },
14400 "remove_storage_paths": {
14500 "items": {
14600 "type": "integer"
14700 },
14800 "type": "array"
14900 },
15000 "remove_tags": {
15100 "items": {
15200 "type": "integer"
15300 },
15400 "type": "array"
15500 },
15600 "remove_view_groups": {
15700 "items": {
15800 "type": "integer"
15900 },
16000 "type": "array"
16100 },
16200 "remove_view_users": {
16300 "items": {
16400 "type": "integer"
16500 },
16600 "type": "array"
16700 },
16800 "type": {
1690n/a "allOf": [
17000 {
17100 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17200 }
1730n/a ],
17400 "maximum": 9223372036854775807,
17500 "minimum": 0,
17600 },
17700 "webhook": {
1780n/a "allOf": [
17900 {
18000 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18100 }
1820n/a ],
1830n/a "nullable": true
18400 }
18500 },
186013000 "type": "object"
187013000}
WorkflowActionTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4,
70n/a 5,
80n/a 6,
90n/a 7,
100n/a 8
1100 ],
1200 "type": "integer"
1300}
WorkflowActionWebhookRequest0 of 17 keywords
100{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3500 "type": "object"
3600}
WorkflowTriggerMatchingAlgorithmEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5
900 ],
1000 "type": "integer"
1100}
WorkflowTriggerRequest0 of 68 keywords
106417{
200 "properties": {
300 "filter_custom_field_query": {
40n/a "nullable": true,
500 "type": "string"
600 },
700 "filter_filename": {
800 "maxLength": 256,
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "filter_has_all_tags": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "filter_has_any_correspondents": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "filter_has_any_document_types": {
2500 "items": {
2600 "type": "integer"
2700 },
2800 "type": "array"
2900 },
3000 "filter_has_any_storage_paths": {
3100 "items": {
3200 "type": "integer"
3300 },
3400 "type": "array"
3500 },
3600 "filter_has_correspondent": {
370n/a "nullable": true,
3800 "type": "integer"
3900 },
4000 "filter_has_document_type": {
410n/a "nullable": true,
4200 "type": "integer"
4300 },
4400 "filter_has_not_correspondents": {
4500 "items": {
4600 "type": "integer"
4700 },
4800 "type": "array"
4900 },
5000 "filter_has_not_document_types": {
5100 "items": {
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "filter_has_not_storage_paths": {
5700 "items": {
5800 "type": "integer"
5900 },
6000 "type": "array"
6100 },
6200 "filter_has_not_tags": {
6300 "items": {
6400 "type": "integer"
6500 },
6600 "type": "array"
6700 },
6800 "filter_has_storage_path": {
690n/a "nullable": true,
7000 "type": "integer"
7100 },
7200 "filter_has_tags": {
7300 "items": {
7400 "type": "integer"
7500 },
7600 "type": "array"
7700 },
7800 "filter_mailrule": {
790n/a "nullable": true,
8000 "type": "integer"
8100 },
8200 "filter_path": {
8300 "maxLength": 256,
840n/a "nullable": true,
8500 "type": "string"
8600 },
8700 "id": {
880n/a "nullable": true,
8900 "type": "integer"
9000 },
9100 "is_insensitive": {
9200 "type": "boolean"
9300 },
9400 "match": {
9500 "maxLength": 256,
9600 "type": "string"
9700 },
9800 "matching_algorithm": {
990n/a "allOf": [
10000 {
10100 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10200 }
1030n/a ],
10400 "maximum": 9223372036854775807,
10500 "minimum": 0
10600 },
10700 "schedule_date_custom_field": {
1080n/a "nullable": true,
10900 "type": "integer"
11000 },
11100 "schedule_date_field": {
1120n/a "allOf": [
11300 {
11400 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11500 }
1160n/a ],
11700 },
11800 "schedule_is_recurring": {
11900 "type": "boolean"
12000 },
12100 "schedule_offset_days": {
12200 "format": "int64",
12300 "maximum": 9223372036854775807,
12400 "minimum": -9223372036854775808,
12500 "type": "integer"
12600 },
12700 "schedule_recurring_interval_days": {
12800 "format": "int64",
12900 "maximum": 9223372036854775807,
13000 "minimum": 1,
13100 "type": "integer"
13200 },
13300 "sources": {
13400 "items": {
13500 "$ref": "#/components/schemas/SourcesEnum"
13600 },
13700 "type": "array"
13800 },
13900 "type": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14300 }
1440n/a ],
14500 }
14600 },
14700 "required": [
14800 "type"
14900 ],
15006417 "type": "object"
15106417}
WorkflowTriggerTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
multipart/form-data7 / 181
PatchedWorkflowRequest
131847{
219847 "properties": {
30529 "actions": {
40529 "items": {
50612 "$ref": "#/components/schemas/WorkflowActionRequest"
60529 },
75290 "type": "array"
80529 },
98495 "enabled": {
108495 "type": "boolean"
118495 },
128482 "name": {
138491 "maxLength": 256,
148491 "minLength": 1,
15850n/a "type": "string"
168482 },
178496 "order": {
188496 "type": "integer"
198496 },
200312 "triggers": {
210312 "items": {
220362 "$ref": "#/components/schemas/WorkflowTriggerRequest"
230312 },
243120 "type": "array"
250312 }
2619847 },
27878n/a "type": "object"
2831847}
Referenced Components (9)0 of 188 keywords
ScheduleDateFieldEnum0 of 3 keywords
100{
200 "enum": [
30n/a "added",
40n/a "created",
50n/a "modified",
60n/a "custom_field"
700 ],
800 "type": "string"
900}
SourcesEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
WorkflowActionEmailRequest0 of 15 keywords
100{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2900 "type": "object"
3000}
WorkflowActionRequest0 of 73 keywords
10612{
200 "properties": {
300 "ai_create_missing": {
400 "type": "boolean"
500 },
600 "ai_overwrite_existing": {
700 "type": "boolean"
800 },
90n/a "ai_suggestion_fields": {
100n/a "nullable": true
110n/a },
1200 "assign_change_groups": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "assign_change_users": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "assign_correspondent": {
250n/a "nullable": true,
2600 "type": "integer"
2700 },
2800 "assign_custom_fields": {
2900 "items": {
3000 "type": "integer"
3100 },
3200 "type": "array"
3300 },
340n/a "assign_custom_fields_values": {
350n/a "nullable": true,
360n/a },
3700 "assign_document_type": {
380n/a "nullable": true,
3900 "type": "integer"
4000 },
4100 "assign_owner": {
420n/a "nullable": true,
4300 "type": "integer"
4400 },
4500 "assign_storage_path": {
460n/a "nullable": true,
4700 "type": "integer"
4800 },
4900 "assign_tags": {
5000 "items": {
510n/a "nullable": true,
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "assign_title": {
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "assign_view_groups": {
6100 "items": {
6200 "type": "integer"
6300 },
6400 "type": "array"
6500 },
6600 "assign_view_users": {
6700 "items": {
6800 "type": "integer"
6900 },
7000 "type": "array"
7100 },
7200 "email": {
730n/a "allOf": [
7400 {
7500 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7600 }
770n/a ],
780n/a "nullable": true
7900 },
8000 "id": {
810n/a "nullable": true,
8200 "type": "integer"
8300 },
840n/a "passwords": {
850n/a "nullable": true
860n/a },
8700 "remove_all_correspondents": {
8800 "type": "boolean"
8900 },
9000 "remove_all_custom_fields": {
9100 "type": "boolean"
9200 },
9300 "remove_all_document_types": {
9400 "type": "boolean"
9500 },
9600 "remove_all_owners": {
9700 "type": "boolean"
9800 },
9900 "remove_all_permissions": {
10000 "type": "boolean"
10100 },
10200 "remove_all_storage_paths": {
10300 "type": "boolean"
10400 },
10500 "remove_all_tags": {
10600 "type": "boolean"
10700 },
10800 "remove_change_groups": {
10900 "items": {
11000 "type": "integer"
11100 },
11200 "type": "array"
11300 },
11400 "remove_change_users": {
11500 "items": {
11600 "type": "integer"
11700 },
11800 "type": "array"
11900 },
12000 "remove_correspondents": {
12100 "items": {
12200 "type": "integer"
12300 },
12400 "type": "array"
12500 },
12600 "remove_custom_fields": {
12700 "items": {
12800 "type": "integer"
12900 },
13000 "type": "array"
13100 },
13200 "remove_document_types": {
13300 "items": {
13400 "type": "integer"
13500 },
13600 "type": "array"
13700 },
13800 "remove_owners": {
13900 "items": {
14000 "type": "integer"
14100 },
14200 "type": "array"
14300 },
14400 "remove_storage_paths": {
14500 "items": {
14600 "type": "integer"
14700 },
14800 "type": "array"
14900 },
15000 "remove_tags": {
15100 "items": {
15200 "type": "integer"
15300 },
15400 "type": "array"
15500 },
15600 "remove_view_groups": {
15700 "items": {
15800 "type": "integer"
15900 },
16000 "type": "array"
16100 },
16200 "remove_view_users": {
16300 "items": {
16400 "type": "integer"
16500 },
16600 "type": "array"
16700 },
16800 "type": {
1690n/a "allOf": [
17000 {
17100 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17200 }
1730n/a ],
17400 "maximum": 9223372036854775807,
17500 "minimum": 0,
17600 },
17700 "webhook": {
1780n/a "allOf": [
17900 {
18000 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18100 }
1820n/a ],
1830n/a "nullable": true
18400 }
18500 },
1860612 "type": "object"
1870612}
WorkflowActionTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4,
70n/a 5,
80n/a 6,
90n/a 7,
100n/a 8
1100 ],
1200 "type": "integer"
1300}
WorkflowActionWebhookRequest0 of 17 keywords
100{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3500 "type": "object"
3600}
WorkflowTriggerMatchingAlgorithmEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5
900 ],
1000 "type": "integer"
1100}
WorkflowTriggerRequest0 of 68 keywords
10362{
200 "properties": {
300 "filter_custom_field_query": {
40n/a "nullable": true,
500 "type": "string"
600 },
700 "filter_filename": {
800 "maxLength": 256,
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "filter_has_all_tags": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "filter_has_any_correspondents": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "filter_has_any_document_types": {
2500 "items": {
2600 "type": "integer"
2700 },
2800 "type": "array"
2900 },
3000 "filter_has_any_storage_paths": {
3100 "items": {
3200 "type": "integer"
3300 },
3400 "type": "array"
3500 },
3600 "filter_has_correspondent": {
370n/a "nullable": true,
3800 "type": "integer"
3900 },
4000 "filter_has_document_type": {
410n/a "nullable": true,
4200 "type": "integer"
4300 },
4400 "filter_has_not_correspondents": {
4500 "items": {
4600 "type": "integer"
4700 },
4800 "type": "array"
4900 },
5000 "filter_has_not_document_types": {
5100 "items": {
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "filter_has_not_storage_paths": {
5700 "items": {
5800 "type": "integer"
5900 },
6000 "type": "array"
6100 },
6200 "filter_has_not_tags": {
6300 "items": {
6400 "type": "integer"
6500 },
6600 "type": "array"
6700 },
6800 "filter_has_storage_path": {
690n/a "nullable": true,
7000 "type": "integer"
7100 },
7200 "filter_has_tags": {
7300 "items": {
7400 "type": "integer"
7500 },
7600 "type": "array"
7700 },
7800 "filter_mailrule": {
790n/a "nullable": true,
8000 "type": "integer"
8100 },
8200 "filter_path": {
8300 "maxLength": 256,
840n/a "nullable": true,
8500 "type": "string"
8600 },
8700 "id": {
880n/a "nullable": true,
8900 "type": "integer"
9000 },
9100 "is_insensitive": {
9200 "type": "boolean"
9300 },
9400 "match": {
9500 "maxLength": 256,
9600 "type": "string"
9700 },
9800 "matching_algorithm": {
990n/a "allOf": [
10000 {
10100 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10200 }
1030n/a ],
10400 "maximum": 9223372036854775807,
10500 "minimum": 0
10600 },
10700 "schedule_date_custom_field": {
1080n/a "nullable": true,
10900 "type": "integer"
11000 },
11100 "schedule_date_field": {
1120n/a "allOf": [
11300 {
11400 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11500 }
1160n/a ],
11700 },
11800 "schedule_is_recurring": {
11900 "type": "boolean"
12000 },
12100 "schedule_offset_days": {
12200 "format": "int64",
12300 "maximum": 9223372036854775807,
12400 "minimum": -9223372036854775808,
12500 "type": "integer"
12600 },
12700 "schedule_recurring_interval_days": {
12800 "format": "int64",
12900 "maximum": 9223372036854775807,
13000 "minimum": 1,
13100 "type": "integer"
13200 },
13300 "sources": {
13400 "items": {
13500 "$ref": "#/components/schemas/SourcesEnum"
13600 },
13700 "type": "array"
13800 },
13900 "type": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14300 }
1440n/a ],
14500 }
14600 },
14700 "required": [
14800 "type"
14900 ],
1500362 "type": "object"
1510362}
WorkflowTriggerTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
Responses1 of 1 documented received
codedescriptionhitsavg
20033719ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found25973ms
401Unauthorized368ms
400Bad Request279ms
500Internal Server Error29ms
Examples1 / 3 used
Body: application/json
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: application/x-www-form-urlencoded
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: multipart/form-data
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Path Parameters1 of 1 keywords covered
id1 / 1
#validinvalidschema
1417715{
2417715 "type": "integer"
3417715}
Body198 of 546 keywords covered
application/json182 / 182
WorkflowRequest
1502746{
2505738 "properties": {
3741501 "actions": {
4741496 "items": {
5571513 "$ref": "#/components/schemas/WorkflowActionRequest"
6741496 },
712375 "type": "array"
8741501 },
99695 "enabled": {
109695 "type": "boolean"
119695 },
1212348 "name": {
1312352 "maxLength": 256,
1412361 "minLength": 1,
1512375 "type": "string"
1612348 },
179216 "order": {
189216 "type": "integer"
199216 },
201024218 "triggers": {
211024213 "items": {
22558213 "$ref": "#/components/schemas/WorkflowTriggerRequest"
231024213 },
2412375 "type": "array"
251024218 }
26505738 },
2712403 "required": [
2812421 "actions",
2912421 "name",
3012421 "triggers"
3112403 ],
3212435 "type": "object"
33502746}
Referenced Components (9)188 of 188 keywords
ScheduleDateFieldEnum3 of 3 keywords
12916{
22916 "enum": [
3262n/a "added",
411n/a "created",
57n/a "modified",
611n/a "custom_field"
72916 ],
82925 "type": "string"
92916}
SourcesEnum3 of 3 keywords
19096{
29096 "enum": [
3278n/a 1,
4296n/a 2,
5285n/a 3,
650n/a 4
79096 ],
89096 "type": "integer"
99096}
WorkflowActionEmailRequest15 of 15 keywords
155466{
25829 "properties": {
3806 "body": {
4801 "minLength": 1,
5815 "type": "string"
6806 },
7665 "id": {
871n/a "nullable": true,
9665 "type": "integer"
10665 },
11695 "include_document": {
12695 "type": "boolean"
13695 },
14797 "subject": {
15801 "maxLength": 256,
16801 "minLength": 1,
17815 "type": "string"
18797 },
19806 "to": {
20801 "minLength": 1,
21815 "type": "string"
22806 }
235829 },
24844 "required": [
25862 "body",
26862 "subject",
27862 "to"
28844 ],
2988433 "type": "object"
3055466}
WorkflowActionRequest73 of 73 keywords
1571513{
2393508 "properties": {
35465 "ai_create_missing": {
45465 "type": "boolean"
55465 },
65129 "ai_overwrite_existing": {
75129 "type": "boolean"
85129 },
9473n/a "ai_suggestion_fields": {
10473n/a "nullable": true
11473n/a },
1252711 "assign_change_groups": {
135276 "items": {
144496 "type": "integer"
155276 },
165335 "type": "array"
1752711 },
1854711 "assign_change_users": {
195476 "items": {
203916 "type": "integer"
215476 },
225535 "type": "array"
2354711 },
245155 "assign_correspondent": {
25520n/a "nullable": true,
265155 "type": "integer"
275155 },
2853611 "assign_custom_fields": {
295366 "items": {
304226 "type": "integer"
315366 },
325425 "type": "array"
3353611 },
34468n/a "assign_custom_fields_values": {
35468n/a "nullable": true,
36468n/a },
375005 "assign_document_type": {
38505n/a "nullable": true,
395005 "type": "integer"
405005 },
415105 "assign_owner": {
42515n/a "nullable": true,
435105 "type": "integer"
445105 },
455215 "assign_storage_path": {
46526n/a "nullable": true,
475215 "type": "integer"
485215 },
4951710 "assign_tags": {
505175 "items": {
51379n/a "nullable": true,
523745 "type": "integer"
535175 },
545225 "type": "array"
5551710 },
565034 "assign_title": {
57507n/a "nullable": true,
585034 "type": "string"
595034 },
6050011 "assign_view_groups": {
615006 "items": {
622966 "type": "integer"
635006 },
645065 "type": "array"
6550011 },
6649511 "assign_view_users": {
674956 "items": {
682656 "type": "integer"
694956 },
705015 "type": "array"
7149511 },
7255466 "email": {
731n/a "allOf": [
7455466 {
7555466 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7655466 }
771n/a ],
78521n/a "nullable": true
7955466 },
805375 "id": {
81542n/a "nullable": true,
825375 "type": "integer"
835375 },
84458n/a "passwords": {
85458n/a "nullable": true
86458n/a },
875275 "remove_all_correspondents": {
885275 "type": "boolean"
895275 },
905595 "remove_all_custom_fields": {
915595 "type": "boolean"
925595 },
934865 "remove_all_document_types": {
944865 "type": "boolean"
954865 },
965135 "remove_all_owners": {
975135 "type": "boolean"
985135 },
995005 "remove_all_permissions": {
1005005 "type": "boolean"
1015005 },
1025465 "remove_all_storage_paths": {
1035465 "type": "boolean"
1045465 },
1055245 "remove_all_tags": {
1065245 "type": "boolean"
1075245 },
10848811 "remove_change_groups": {
1094886 "items": {
1102106 "type": "integer"
1114886 },
1124945 "type": "array"
11348811 },
11449511 "remove_change_users": {
1154956 "items": {
1161796 "type": "integer"
1174956 },
1185015 "type": "array"
11949511 },
12050911 "remove_correspondents": {
1215096 "items": {
1223286 "type": "integer"
1235096 },
1245155 "type": "array"
12550911 },
12646811 "remove_custom_fields": {
1274686 "items": {
1281476 "type": "integer"
1294686 },
1304745 "type": "array"
13146811 },
13249311 "remove_document_types": {
1334936 "items": {
1341746 "type": "integer"
1354936 },
1364995 "type": "array"
13749311 },
13848911 "remove_owners": {
1394896 "items": {
1402976 "type": "integer"
1414896 },
1424955 "type": "array"
14348911 },
14448411 "remove_storage_paths": {
1454846 "items": {
1462676 "type": "integer"
1474846 },
1484905 "type": "array"
14948411 },
15047711 "remove_tags": {
1514776 "items": {
1523006 "type": "integer"
1534776 },
1544835 "type": "array"
15547711 },
15646811 "remove_view_groups": {
1574686 "items": {
1581086 "type": "integer"
1594686 },
1604745 "type": "array"
16146811 },
16249011 "remove_view_users": {
1634906 "items": {
1643566 "type": "integer"
1654906 },
1664965 "type": "array"
16749011 },
16851810 "type": {
1691n/a "allOf": [
17051810 {
17151810 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17251810 }
1731n/a ],
1745212 "maximum": 9223372036854775807,
1755212 "minimum": 0,
17651810 },
17759435 "webhook": {
1781n/a "allOf": [
17959435 {
18059435 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18159435 }
1821n/a ],
183494n/a "nullable": true
18459435 }
185393508 },
18610795 "type": "object"
187571513}
WorkflowActionTypeEnum3 of 3 keywords
151810{
251810 "enum": [
3432n/a 1,
439n/a 2,
59n/a 3,
610n/a 4,
73n/a 5,
87n/a 6,
912n/a 7,
106n/a 8
1151810 ],
125226 "type": "integer"
1351810}
WorkflowActionWebhookRequest17 of 17 keywords
159435{
26031 "properties": {
3765 "as_json": {
4765 "type": "boolean"
5765 },
6724 "body": {
776n/a "nullable": true,
8724 "type": "string"
9724 },
1058n/a "headers": {
1158n/a "nullable": true,
1258n/a },
13695 "id": {
1474n/a "nullable": true,
15695 "type": "integer"
16695 },
17735 "include_document": {
18735 "type": "boolean"
19735 },
2055n/a "params": {
2155n/a "nullable": true,
2255n/a },
23837 "url": {
24841 "maxLength": 256,
25841 "minLength": 1,
26855 "type": "string"
27837 },
28705 "use_params": {
29705 "type": "boolean"
30705 }
316031 },
32902 "required": [
33902 "url"
34902 ],
3592402 "type": "object"
3659435}
WorkflowTriggerMatchingAlgorithmEnum3 of 3 keywords
13479{
23479 "enum": [
3272n/a 0,
426n/a 1,
510n/a 2,
611n/a 3,
718n/a 4,
810n/a 5
93479 ],
103506 "type": "integer"
113479}
WorkflowTriggerRequest68 of 68 keywords
1558213{
2559207 "properties": {
33364 "filter_custom_field_query": {
4340n/a "nullable": true,
53364 "type": "string"
63364 },
73595 "filter_filename": {
83231 "maxLength": 256,
9364n/a "nullable": true,
103604 "type": "string"
113595 },
1233211 "filter_has_all_tags": {
133326 "items": {
144686 "type": "integer"
153326 },
163385 "type": "array"
1733211 },
1835611 "filter_has_any_correspondents": {
193566 "items": {
202766 "type": "integer"
213566 },
223625 "type": "array"
2335611 },
2431311 "filter_has_any_document_types": {
253136 "items": {
262326 "type": "integer"
273136 },
283195 "type": "array"
2931311 },
3034211 "filter_has_any_storage_paths": {
313426 "items": {
322586 "type": "integer"
333426 },
343485 "type": "array"
3534211 },
363625 "filter_has_correspondent": {
37367n/a "nullable": true,
383625 "type": "integer"
393625 },
403465 "filter_has_document_type": {
41351n/a "nullable": true,
423465 "type": "integer"
433465 },
4433211 "filter_has_not_correspondents": {
453326 "items": {
463786 "type": "integer"
473326 },
483385 "type": "array"
4933211 },
5034311 "filter_has_not_document_types": {
513436 "items": {
524676 "type": "integer"
533436 },
543495 "type": "array"
5534311 },
5634511 "filter_has_not_storage_paths": {
573456 "items": {
583636 "type": "integer"
593456 },
603515 "type": "array"
6134511 },
6234011 "filter_has_not_tags": {
633406 "items": {
643856 "type": "integer"
653406 },
663465 "type": "array"
6734011 },
683455 "filter_has_storage_path": {
69350n/a "nullable": true,
703455 "type": "integer"
713455 },
7233211 "filter_has_tags": {
733326 "items": {
744506 "type": "integer"
753326 },
763385 "type": "array"
7733211 },
783445 "filter_mailrule": {
79349n/a "nullable": true,
803445 "type": "integer"
813445 },
823325 "filter_path": {
832901 "maxLength": 256,
84337n/a "nullable": true,
853334 "type": "string"
863325 },
873325 "id": {
88337n/a "nullable": true,
893325 "type": "integer"
903325 },
913065 "is_insensitive": {
923065 "type": "boolean"
933065 },
943346 "match": {
953341 "maxLength": 256,
963355 "type": "string"
973346 },
983479 "matching_algorithm": {
991n/a "allOf": [
1003479 {
1013479 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
1023479 }
1031n/a ],
1043501 "maximum": 9223372036854775807,
1053492 "minimum": 0
1063479 },
1073385 "schedule_date_custom_field": {
108343n/a "nullable": true,
1093385 "type": "integer"
1103385 },
1112916 "schedule_date_field": {
1121n/a "allOf": [
1132916 {
1142916 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
1152916 }
1161n/a ],
1172916 },
1183705 "schedule_is_recurring": {
1193705 "type": "boolean"
1203705 },
1213158 "schedule_offset_days": {
1223158 "format": "int64",
1233171 "maximum": 9223372036854775807,
1243171 "minimum": -9223372036854775808,
1253176 "type": "integer"
1263158 },
1273238 "schedule_recurring_interval_days": {
1283247 "format": "int64",
1293251 "maximum": 9223372036854775807,
1303242 "minimum": 1,
1313256 "type": "integer"
1323238 },
13329611 "sources": {
1342966 "items": {
1359096 "$ref": "#/components/schemas/SourcesEnum"
1362966 },
1373025 "type": "array"
13829611 },
1397596 "type": {
1401n/a "allOf": [
1417596 {
1427596 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
1437596 }
1441n/a ],
1457596 }
146559207 },
1477651 "required": [
1487651 "type"
1497651 ],
1507665 "type": "object"
151558213}
WorkflowTriggerTypeEnum3 of 3 keywords
17596{
27596 "enum": [
3478n/a 1,
496n/a 2,
575n/a 3,
6110n/a 4
77596 ],
87596 "type": "integer"
97596}
application/x-www-form-urlencoded8 / 182
WorkflowRequest
101155{
2281127 "properties": {
30755 "actions": {
40755 "items": {
5025216 "$ref": "#/components/schemas/WorkflowActionRequest"
60755 },
77550 "type": "array"
80755 },
910814 "enabled": {
1010814 "type": "boolean"
1110814 },
1211485 "name": {
1311512 "maxLength": 256,
1411503 "minLength": 1,
151153n/a "type": "string"
1611485 },
1710796 "order": {
1810796 "type": "integer"
1910796 },
200412 "triggers": {
210412 "items": {
22011779 "$ref": "#/components/schemas/WorkflowTriggerRequest"
230412 },
244120 "type": "array"
250412 }
26281127 },
27541101 "required": [
28755400 "actions",
2911532 "name",
30412743 "triggers"
31541101 ],
321155n/a "type": "object"
3301155}
Referenced Components (9)0 of 188 keywords
ScheduleDateFieldEnum0 of 3 keywords
100{
200 "enum": [
30n/a "added",
40n/a "created",
50n/a "modified",
60n/a "custom_field"
700 ],
800 "type": "string"
900}
SourcesEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
WorkflowActionEmailRequest0 of 15 keywords
100{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2900 "type": "object"
3000}
WorkflowActionRequest0 of 73 keywords
1025216{
200 "properties": {
300 "ai_create_missing": {
400 "type": "boolean"
500 },
600 "ai_overwrite_existing": {
700 "type": "boolean"
800 },
90n/a "ai_suggestion_fields": {
100n/a "nullable": true
110n/a },
1200 "assign_change_groups": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "assign_change_users": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "assign_correspondent": {
250n/a "nullable": true,
2600 "type": "integer"
2700 },
2800 "assign_custom_fields": {
2900 "items": {
3000 "type": "integer"
3100 },
3200 "type": "array"
3300 },
340n/a "assign_custom_fields_values": {
350n/a "nullable": true,
360n/a },
3700 "assign_document_type": {
380n/a "nullable": true,
3900 "type": "integer"
4000 },
4100 "assign_owner": {
420n/a "nullable": true,
4300 "type": "integer"
4400 },
4500 "assign_storage_path": {
460n/a "nullable": true,
4700 "type": "integer"
4800 },
4900 "assign_tags": {
5000 "items": {
510n/a "nullable": true,
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "assign_title": {
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "assign_view_groups": {
6100 "items": {
6200 "type": "integer"
6300 },
6400 "type": "array"
6500 },
6600 "assign_view_users": {
6700 "items": {
6800 "type": "integer"
6900 },
7000 "type": "array"
7100 },
7200 "email": {
730n/a "allOf": [
7400 {
7500 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7600 }
770n/a ],
780n/a "nullable": true
7900 },
8000 "id": {
810n/a "nullable": true,
8200 "type": "integer"
8300 },
840n/a "passwords": {
850n/a "nullable": true
860n/a },
8700 "remove_all_correspondents": {
8800 "type": "boolean"
8900 },
9000 "remove_all_custom_fields": {
9100 "type": "boolean"
9200 },
9300 "remove_all_document_types": {
9400 "type": "boolean"
9500 },
9600 "remove_all_owners": {
9700 "type": "boolean"
9800 },
9900 "remove_all_permissions": {
10000 "type": "boolean"
10100 },
10200 "remove_all_storage_paths": {
10300 "type": "boolean"
10400 },
10500 "remove_all_tags": {
10600 "type": "boolean"
10700 },
10800 "remove_change_groups": {
10900 "items": {
11000 "type": "integer"
11100 },
11200 "type": "array"
11300 },
11400 "remove_change_users": {
11500 "items": {
11600 "type": "integer"
11700 },
11800 "type": "array"
11900 },
12000 "remove_correspondents": {
12100 "items": {
12200 "type": "integer"
12300 },
12400 "type": "array"
12500 },
12600 "remove_custom_fields": {
12700 "items": {
12800 "type": "integer"
12900 },
13000 "type": "array"
13100 },
13200 "remove_document_types": {
13300 "items": {
13400 "type": "integer"
13500 },
13600 "type": "array"
13700 },
13800 "remove_owners": {
13900 "items": {
14000 "type": "integer"
14100 },
14200 "type": "array"
14300 },
14400 "remove_storage_paths": {
14500 "items": {
14600 "type": "integer"
14700 },
14800 "type": "array"
14900 },
15000 "remove_tags": {
15100 "items": {
15200 "type": "integer"
15300 },
15400 "type": "array"
15500 },
15600 "remove_view_groups": {
15700 "items": {
15800 "type": "integer"
15900 },
16000 "type": "array"
16100 },
16200 "remove_view_users": {
16300 "items": {
16400 "type": "integer"
16500 },
16600 "type": "array"
16700 },
16800 "type": {
1690n/a "allOf": [
17000 {
17100 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17200 }
1730n/a ],
17400 "maximum": 9223372036854775807,
17500 "minimum": 0,
17600 },
17700 "webhook": {
1780n/a "allOf": [
17900 {
18000 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18100 }
1820n/a ],
1830n/a "nullable": true
18400 }
18500 },
186025216 "type": "object"
187025216}
WorkflowActionTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4,
70n/a 5,
80n/a 6,
90n/a 7,
100n/a 8
1100 ],
1200 "type": "integer"
1300}
WorkflowActionWebhookRequest0 of 17 keywords
100{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3500 "type": "object"
3600}
WorkflowTriggerMatchingAlgorithmEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5
900 ],
1000 "type": "integer"
1100}
WorkflowTriggerRequest0 of 68 keywords
1011779{
200 "properties": {
300 "filter_custom_field_query": {
40n/a "nullable": true,
500 "type": "string"
600 },
700 "filter_filename": {
800 "maxLength": 256,
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "filter_has_all_tags": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "filter_has_any_correspondents": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "filter_has_any_document_types": {
2500 "items": {
2600 "type": "integer"
2700 },
2800 "type": "array"
2900 },
3000 "filter_has_any_storage_paths": {
3100 "items": {
3200 "type": "integer"
3300 },
3400 "type": "array"
3500 },
3600 "filter_has_correspondent": {
370n/a "nullable": true,
3800 "type": "integer"
3900 },
4000 "filter_has_document_type": {
410n/a "nullable": true,
4200 "type": "integer"
4300 },
4400 "filter_has_not_correspondents": {
4500 "items": {
4600 "type": "integer"
4700 },
4800 "type": "array"
4900 },
5000 "filter_has_not_document_types": {
5100 "items": {
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "filter_has_not_storage_paths": {
5700 "items": {
5800 "type": "integer"
5900 },
6000 "type": "array"
6100 },
6200 "filter_has_not_tags": {
6300 "items": {
6400 "type": "integer"
6500 },
6600 "type": "array"
6700 },
6800 "filter_has_storage_path": {
690n/a "nullable": true,
7000 "type": "integer"
7100 },
7200 "filter_has_tags": {
7300 "items": {
7400 "type": "integer"
7500 },
7600 "type": "array"
7700 },
7800 "filter_mailrule": {
790n/a "nullable": true,
8000 "type": "integer"
8100 },
8200 "filter_path": {
8300 "maxLength": 256,
840n/a "nullable": true,
8500 "type": "string"
8600 },
8700 "id": {
880n/a "nullable": true,
8900 "type": "integer"
9000 },
9100 "is_insensitive": {
9200 "type": "boolean"
9300 },
9400 "match": {
9500 "maxLength": 256,
9600 "type": "string"
9700 },
9800 "matching_algorithm": {
990n/a "allOf": [
10000 {
10100 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10200 }
1030n/a ],
10400 "maximum": 9223372036854775807,
10500 "minimum": 0
10600 },
10700 "schedule_date_custom_field": {
1080n/a "nullable": true,
10900 "type": "integer"
11000 },
11100 "schedule_date_field": {
1120n/a "allOf": [
11300 {
11400 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11500 }
1160n/a ],
11700 },
11800 "schedule_is_recurring": {
11900 "type": "boolean"
12000 },
12100 "schedule_offset_days": {
12200 "format": "int64",
12300 "maximum": 9223372036854775807,
12400 "minimum": -9223372036854775808,
12500 "type": "integer"
12600 },
12700 "schedule_recurring_interval_days": {
12800 "format": "int64",
12900 "maximum": 9223372036854775807,
13000 "minimum": 1,
13100 "type": "integer"
13200 },
13300 "sources": {
13400 "items": {
13500 "$ref": "#/components/schemas/SourcesEnum"
13600 },
13700 "type": "array"
13800 },
13900 "type": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14300 }
1440n/a ],
14500 }
14600 },
14700 "required": [
14800 "type"
14900 ],
150011779 "type": "object"
151011779}
WorkflowTriggerTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
multipart/form-data8 / 182
WorkflowRequest
101737{
2271710 "properties": {
301072 "actions": {
401072 "items": {
501286 "$ref": "#/components/schemas/WorkflowActionRequest"
601072 },
710720 "type": "array"
801072 },
9169410 "enabled": {
10169410 "type": "boolean"
11169410 },
1217314 "name": {
1317332 "maxLength": 256,
1417332 "minLength": 1,
151735n/a "type": "string"
1617314 },
17169417 "order": {
18169417 "type": "integer"
19169417 },
200656 "triggers": {
210656 "items": {
220825 "$ref": "#/components/schemas/WorkflowTriggerRequest"
230656 },
246560 "type": "array"
250656 }
26271710 },
27441693 "required": [
281072665 "actions",
2917352 "name",
306561081 "triggers"
31441693 ],
321737n/a "type": "object"
3301737}
Referenced Components (9)0 of 188 keywords
ScheduleDateFieldEnum0 of 3 keywords
100{
200 "enum": [
30n/a "added",
40n/a "created",
50n/a "modified",
60n/a "custom_field"
700 ],
800 "type": "string"
900}
SourcesEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
WorkflowActionEmailRequest0 of 15 keywords
100{
200 "properties": {
300 "body": {
400 "minLength": 1,
500 "type": "string"
600 },
700 "id": {
80n/a "nullable": true,
900 "type": "integer"
1000 },
1100 "include_document": {
1200 "type": "boolean"
1300 },
1400 "subject": {
1500 "maxLength": 256,
1600 "minLength": 1,
1700 "type": "string"
1800 },
1900 "to": {
2000 "minLength": 1,
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "body",
2600 "subject",
2700 "to"
2800 ],
2900 "type": "object"
3000}
WorkflowActionRequest0 of 73 keywords
101286{
200 "properties": {
300 "ai_create_missing": {
400 "type": "boolean"
500 },
600 "ai_overwrite_existing": {
700 "type": "boolean"
800 },
90n/a "ai_suggestion_fields": {
100n/a "nullable": true
110n/a },
1200 "assign_change_groups": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "assign_change_users": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "assign_correspondent": {
250n/a "nullable": true,
2600 "type": "integer"
2700 },
2800 "assign_custom_fields": {
2900 "items": {
3000 "type": "integer"
3100 },
3200 "type": "array"
3300 },
340n/a "assign_custom_fields_values": {
350n/a "nullable": true,
360n/a },
3700 "assign_document_type": {
380n/a "nullable": true,
3900 "type": "integer"
4000 },
4100 "assign_owner": {
420n/a "nullable": true,
4300 "type": "integer"
4400 },
4500 "assign_storage_path": {
460n/a "nullable": true,
4700 "type": "integer"
4800 },
4900 "assign_tags": {
5000 "items": {
510n/a "nullable": true,
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "assign_title": {
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "assign_view_groups": {
6100 "items": {
6200 "type": "integer"
6300 },
6400 "type": "array"
6500 },
6600 "assign_view_users": {
6700 "items": {
6800 "type": "integer"
6900 },
7000 "type": "array"
7100 },
7200 "email": {
730n/a "allOf": [
7400 {
7500 "$ref": "#/components/schemas/WorkflowActionEmailRequest"
7600 }
770n/a ],
780n/a "nullable": true
7900 },
8000 "id": {
810n/a "nullable": true,
8200 "type": "integer"
8300 },
840n/a "passwords": {
850n/a "nullable": true
860n/a },
8700 "remove_all_correspondents": {
8800 "type": "boolean"
8900 },
9000 "remove_all_custom_fields": {
9100 "type": "boolean"
9200 },
9300 "remove_all_document_types": {
9400 "type": "boolean"
9500 },
9600 "remove_all_owners": {
9700 "type": "boolean"
9800 },
9900 "remove_all_permissions": {
10000 "type": "boolean"
10100 },
10200 "remove_all_storage_paths": {
10300 "type": "boolean"
10400 },
10500 "remove_all_tags": {
10600 "type": "boolean"
10700 },
10800 "remove_change_groups": {
10900 "items": {
11000 "type": "integer"
11100 },
11200 "type": "array"
11300 },
11400 "remove_change_users": {
11500 "items": {
11600 "type": "integer"
11700 },
11800 "type": "array"
11900 },
12000 "remove_correspondents": {
12100 "items": {
12200 "type": "integer"
12300 },
12400 "type": "array"
12500 },
12600 "remove_custom_fields": {
12700 "items": {
12800 "type": "integer"
12900 },
13000 "type": "array"
13100 },
13200 "remove_document_types": {
13300 "items": {
13400 "type": "integer"
13500 },
13600 "type": "array"
13700 },
13800 "remove_owners": {
13900 "items": {
14000 "type": "integer"
14100 },
14200 "type": "array"
14300 },
14400 "remove_storage_paths": {
14500 "items": {
14600 "type": "integer"
14700 },
14800 "type": "array"
14900 },
15000 "remove_tags": {
15100 "items": {
15200 "type": "integer"
15300 },
15400 "type": "array"
15500 },
15600 "remove_view_groups": {
15700 "items": {
15800 "type": "integer"
15900 },
16000 "type": "array"
16100 },
16200 "remove_view_users": {
16300 "items": {
16400 "type": "integer"
16500 },
16600 "type": "array"
16700 },
16800 "type": {
1690n/a "allOf": [
17000 {
17100 "$ref": "#/components/schemas/WorkflowActionTypeEnum"
17200 }
1730n/a ],
17400 "maximum": 9223372036854775807,
17500 "minimum": 0,
17600 },
17700 "webhook": {
1780n/a "allOf": [
17900 {
18000 "$ref": "#/components/schemas/WorkflowActionWebhookRequest"
18100 }
1820n/a ],
1830n/a "nullable": true
18400 }
18500 },
18601286 "type": "object"
18701286}
WorkflowActionTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4,
70n/a 5,
80n/a 6,
90n/a 7,
100n/a 8
1100 ],
1200 "type": "integer"
1300}
WorkflowActionWebhookRequest0 of 17 keywords
100{
200 "properties": {
300 "as_json": {
400 "type": "boolean"
500 },
600 "body": {
70n/a "nullable": true,
800 "type": "string"
900 },
100n/a "headers": {
110n/a "nullable": true,
120n/a },
1300 "id": {
140n/a "nullable": true,
1500 "type": "integer"
1600 },
1700 "include_document": {
1800 "type": "boolean"
1900 },
200n/a "params": {
210n/a "nullable": true,
220n/a },
2300 "url": {
2400 "maxLength": 256,
2500 "minLength": 1,
2600 "type": "string"
2700 },
2800 "use_params": {
2900 "type": "boolean"
3000 }
3100 },
3200 "required": [
3300 "url"
3400 ],
3500 "type": "object"
3600}
WorkflowTriggerMatchingAlgorithmEnum0 of 3 keywords
100{
200 "enum": [
30n/a 0,
40n/a 1,
50n/a 2,
60n/a 3,
70n/a 4,
80n/a 5
900 ],
1000 "type": "integer"
1100}
WorkflowTriggerRequest0 of 68 keywords
10825{
200 "properties": {
300 "filter_custom_field_query": {
40n/a "nullable": true,
500 "type": "string"
600 },
700 "filter_filename": {
800 "maxLength": 256,
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "filter_has_all_tags": {
1300 "items": {
1400 "type": "integer"
1500 },
1600 "type": "array"
1700 },
1800 "filter_has_any_correspondents": {
1900 "items": {
2000 "type": "integer"
2100 },
2200 "type": "array"
2300 },
2400 "filter_has_any_document_types": {
2500 "items": {
2600 "type": "integer"
2700 },
2800 "type": "array"
2900 },
3000 "filter_has_any_storage_paths": {
3100 "items": {
3200 "type": "integer"
3300 },
3400 "type": "array"
3500 },
3600 "filter_has_correspondent": {
370n/a "nullable": true,
3800 "type": "integer"
3900 },
4000 "filter_has_document_type": {
410n/a "nullable": true,
4200 "type": "integer"
4300 },
4400 "filter_has_not_correspondents": {
4500 "items": {
4600 "type": "integer"
4700 },
4800 "type": "array"
4900 },
5000 "filter_has_not_document_types": {
5100 "items": {
5200 "type": "integer"
5300 },
5400 "type": "array"
5500 },
5600 "filter_has_not_storage_paths": {
5700 "items": {
5800 "type": "integer"
5900 },
6000 "type": "array"
6100 },
6200 "filter_has_not_tags": {
6300 "items": {
6400 "type": "integer"
6500 },
6600 "type": "array"
6700 },
6800 "filter_has_storage_path": {
690n/a "nullable": true,
7000 "type": "integer"
7100 },
7200 "filter_has_tags": {
7300 "items": {
7400 "type": "integer"
7500 },
7600 "type": "array"
7700 },
7800 "filter_mailrule": {
790n/a "nullable": true,
8000 "type": "integer"
8100 },
8200 "filter_path": {
8300 "maxLength": 256,
840n/a "nullable": true,
8500 "type": "string"
8600 },
8700 "id": {
880n/a "nullable": true,
8900 "type": "integer"
9000 },
9100 "is_insensitive": {
9200 "type": "boolean"
9300 },
9400 "match": {
9500 "maxLength": 256,
9600 "type": "string"
9700 },
9800 "matching_algorithm": {
990n/a "allOf": [
10000 {
10100 "$ref": "#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum"
10200 }
1030n/a ],
10400 "maximum": 9223372036854775807,
10500 "minimum": 0
10600 },
10700 "schedule_date_custom_field": {
1080n/a "nullable": true,
10900 "type": "integer"
11000 },
11100 "schedule_date_field": {
1120n/a "allOf": [
11300 {
11400 "$ref": "#/components/schemas/ScheduleDateFieldEnum"
11500 }
1160n/a ],
11700 },
11800 "schedule_is_recurring": {
11900 "type": "boolean"
12000 },
12100 "schedule_offset_days": {
12200 "format": "int64",
12300 "maximum": 9223372036854775807,
12400 "minimum": -9223372036854775808,
12500 "type": "integer"
12600 },
12700 "schedule_recurring_interval_days": {
12800 "format": "int64",
12900 "maximum": 9223372036854775807,
13000 "minimum": 1,
13100 "type": "integer"
13200 },
13300 "sources": {
13400 "items": {
13500 "$ref": "#/components/schemas/SourcesEnum"
13600 },
13700 "type": "array"
13800 },
13900 "type": {
1400n/a "allOf": [
14100 {
14200 "$ref": "#/components/schemas/WorkflowTriggerTypeEnum"
14300 }
1440n/a ],
14500 }
14600 },
14700 "required": [
14800 "type"
14900 ],
1500825 "type": "object"
1510825}
WorkflowTriggerTypeEnum0 of 3 keywords
100{
200 "enum": [
30n/a 1,
40n/a 2,
50n/a 3,
60n/a 4
700 ],
800 "type": "integer"
900}
Responses1 of 1 documented received
codedescriptionhitsavg
20021737ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request343111ms
404Not Found5264ms
401Unauthorized1516ms
500Internal Server Error222ms
415113ms
Examples1 / 3 used
Body: application/json
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: application/x-www-form-urlencoded
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
Body: multipart/form-data
[ 1, 2, 3 ]WorkflowTriggerRequest.sources
390 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:41309/api/bulk_edit_objects/method not documented1
DELETE0.0.0.0:41309/api/config/method not documented1
DELETE0.0.0.0:41309/api/correspondents/method not documented1
DELETE0.0.0.0:41309/api/custom_fields/method not documented1
DELETE0.0.0.0:41309/api/document_types/method not documented1
DELETE0.0.0.0:41309/api/documents/method not documented1
DELETE0.0.0.0:41309/api/documents/bulk_download/method not documented1
DELETE0.0.0.0:41309/api/documents/bulk_edit/method not documented1
DELETE0.0.0.0:41309/api/documents/chat/method not documented1
DELETE0.0.0.0:41309/api/documents/delete/method not documented1

... and 380 more groups