Skip to content

Items By Multiple Column Values

This is a module containing: Monday query_items_by_multiple_column_values* tasks

query_items_by_multiple_column_values(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', return_fields=None) async

Get your data from monday.com.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@task
async def query_items_by_multiple_column_values(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get your data from monday.com.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique identifier.
        column_values: The column values to search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all / active / archived / deleted), the
            default is active.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    )

    op_stack = ("items_by_multiple_column_values",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]

query_items_by_multiple_column_values_assets(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', assets_source=None, column_ids=None, return_fields=None) async

The item's assets/files.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
assets_source AssetsSource

The assets source (all / columns / gallery).

None
column_ids Iterable[str]

Ids of the columns you want to get assets from.

None
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
@task
async def query_items_by_multiple_column_values_assets(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    assets_source: graphql_schema.AssetsSource = None,
    column_ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The item's assets/files.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        assets_source: The assets source (all / columns / gallery).
        column_ids: Ids of the columns you want to get assets from.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).assets(
        **strip_kwargs(
            assets_source=assets_source,
            column_ids=column_ids,
        )
    )

    op_stack = (
        "items_by_multiple_column_values",
        "assets",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["assets"]

query_items_by_multiple_column_values_board(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', return_fields=None) async

The board that contains this item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
@task
async def query_items_by_multiple_column_values_board(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The board that contains this item.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).board(**strip_kwargs())

    op_stack = (
        "items_by_multiple_column_values",
        "board",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["board"]

query_items_by_multiple_column_values_column_values(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', ids=None, return_fields=None) async

The item's column values.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
ids Iterable[str]

A list of column ids to return.

None
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
@task
async def query_items_by_multiple_column_values_column_values(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The item's column values.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        ids: A list of column ids to return.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).column_values(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "items_by_multiple_column_values",
        "column_values",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["column_values"]

query_items_by_multiple_column_values_creator(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', return_fields=None) async

The item's creator.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
@task
async def query_items_by_multiple_column_values_creator(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The item's creator.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "items_by_multiple_column_values",
        "creator",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["creator"]

query_items_by_multiple_column_values_group(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', return_fields=None) async

The group that contains this item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
@task
async def query_items_by_multiple_column_values_group(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The group that contains this item.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).group(**strip_kwargs())

    op_stack = (
        "items_by_multiple_column_values",
        "group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["group"]

query_items_by_multiple_column_values_parent_item(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', return_fields=None) async

The parent item of a subitem.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
@task
async def query_items_by_multiple_column_values_parent_item(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The parent item of a subitem.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).parent_item(**strip_kwargs())

    op_stack = (
        "items_by_multiple_column_values",
        "parent_item",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["parent_item"]

query_items_by_multiple_column_values_subscribers(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', return_fields=None) async

The pulses's subscribers.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
@task
async def query_items_by_multiple_column_values_subscribers(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The pulses's subscribers.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "items_by_multiple_column_values",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["subscribers"]

query_items_by_multiple_column_values_updates(board_id, column_id, column_values, monday_credentials, limit=None, page=1, column_type=None, state='active', updates_limit=25, updates_page=1, return_fields=None) async

The item's updates.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_id str

The column's unique identifier.

required
column_values Iterable[str]

The column values to search items by.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get.

None
page int

Page number to get, starting at 1.

1
column_type str

The column type.

None
state State

The state of the item (all / active / archived / deleted), the default is active.

'active'
updates_limit int

Number of items to get, the default is 25.

25
updates_page int

Page number to get, starting at 1.

1
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/items_by_multiple_column_values.py
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
@task
async def query_items_by_multiple_column_values_updates(
    board_id: int,
    column_id: str,
    column_values: Iterable[str],
    monday_credentials: MondayCredentials,
    limit: int = None,
    page: int = 1,
    column_type: str = None,
    state: graphql_schema.State = "active",
    updates_limit: int = 25,
    updates_page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The item's updates.

    Args:
        board_id: The board's unique identifier.
        column_id: The column's unique
            identifier.
        column_values: The column values to
            search items by.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get.
        page: Page number to get, starting at 1.
        column_type: The column type.
        state: The state of the item (all /
            active / archived / deleted), the default is active.
        updates_limit: Number of items to get, the default is 25.
        updates_page: Page number to get, starting at 1.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.items_by_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_id=column_id,
            column_values=column_values,
            limit=limit,
            page=page,
            column_type=column_type,
            state=state,
        )
    ).updates(
        **strip_kwargs(
            limit=updates_limit,
            page=updates_page,
        )
    )

    op_stack = (
        "items_by_multiple_column_values",
        "updates",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["items_by_multiple_column_values"]["updates"]