Cmdlets for Monday

Build 24.0.9060

Groups

Get a board's visible groups.

Table-Specific Information

SELECT

The cmdlet uses the Monday API to process some of the filters. The cmdlet processes other filters client-side within the cmdlet. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

  • Id supports the '=','IN' comparison operators.
  • BoardId supports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Groups WHERE Id = 'topics'
SELECT * FROM Groups WHERE Id IN ('topics', 'group_title')
SELECT * FROM Groups WHERE BoardId IN ('2182296646', '21822966')
SELECT * FROM Groups WHERE BoardId = '2182296646' AND Id = 'topics'

INSERT

The following inputs can be used in INSERT statements:

BoardId, Title, RelativeTo, PositionRelativeMethod

INSERT INTO Groups (BoardId,Title,Color,RelativeTo,PositionRelativeMethod) VALUES ('5525287714','NewGroup','#9CD326','testgroup','after_at')

UPDATE

The following inputs can be used in UPDATE statements (note that due to API limitations only one column's value can be updated per statement):

Archived, Color, Title, RelativePositionAfter, RelativePositionBefore

UPDATE Groups SET Color='#9CD326' WHERE BoardId='5525287714' AND Id='newgroup'
UPDATE Groups SET Archived='true' WHERE BoardId='5525287714' AND Id='newgroup'

DELETE

You can delete entries by specifying the Id and BoardId.

DELETE FROM Groups WHERE BoardId='5525287714' AND Id='testgroup'

Columns

Name Type ReadOnly References Description
Id [KEY] String False

The group's unique identifier.

BoardId [KEY] String False

Boards.Id

The unique identifier of the board.

Archived Bool False

Whether or not the group is archived.

Color String False

The group's color.

The allowed values are #037F4C, #FDAB3D, #579BFC, #E2445C, #00C875, #C4C4C4, #0086C0, #A25DDC, #FFCB00, #9CD326, #7F5347, #BB3354, #808080, #784BD1, #FF642E, #FF158A, #66CCFF, #FF5AC4.

Deleted Bool False

Whether or not the group is deleted.

Position String False

The group's position in the board.

Title String False

The group's title.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
RelativeTo String

The group to set the position next to.

PositionRelativeMethod String

The position relative method to another group (before_at / after_at).

The allowed values are before_at, after_at.

RelativePositionAfter String

The group's relative position after another group in the board.

RelativePositionBefore String

The group's relative position before another group in the board.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060