The CData Sync App provides a straightforward way to continuously pipeline your Monday data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Monday connector can be used from the CData Sync application to pull data from Monday and move it to any of the supported destinations.
The Sync App leverages the Monday API to enable bidirectional access to Monday.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
Monday AuditLog API only supports authentication via API Token.
To generate the audit log API token:
After you retrieve the API token, set the following conenction properties:
You are now ready to connect to Monday AuditLog API.
Monday GraphQL API supports authentication via either API Token or the OAuth standard.
To connect to Sync App via an API Token, set the AuthScheme to Token and obtain the APIToken as follows:
The following subsections describe how to authenticate to Monday from three common authentication flows:
For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Monday, see Connection.
When the access token expires, the Sync App refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token, do the following:
This section details a selection of advanced features of the Monday Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Monday and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Sync App models entities in the Monday API as views and stored procedures. These are defined in schema files, which are simple, text-based configuration files.
See Information Data Model for the available entities in the Information schema.
See AuditLog Data Model for the available entities in the AuditLog schema.
See Workspace Data Model for the possible entities in a Workspace-type schema.
This section shows the available API objects and provides more information on executing SQL to Monday APIs.
Tables are tables that can be modified.
Views are tables that cannot be modified. Typically, model data that is read-only and cannot be updated are shown as views.
Stored Procedures are function-like interfaces to the data source.
The Sync App models the data in Monday as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Boards | Get a collection of boards. |
| BoardTeams | Get a board's team subscribers. |
| BoardUsers | Get a board's subscribers. |
| DocBlocks | Get a document's content blocks. |
| Docs | Get a collection of docs. |
| Folders | Get a collection of folders. Note that this won't return folders from closed workspaces to which you are not subscribed. |
| Groups | Get a board's visible groups. |
| Tags | Get a collection of tags. |
| TeamUsers | Get a team's users. |
| Updates | Get a collection of updates. |
| Webhooks | Get a collection of webhooks. |
| Workspaces | Get a collection of workspaces. |
| WorkspaceTeams | Get the teams subscribed to the workspace. |
| WorkspaceUsers | Get the users subscribed to the workspace. |
Get a collection of boards.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Boards WHERE Id = '2182296646'
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030')
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030') AND BoardKind = 'public'
SELECT * FROM Boards WHERE BoardKind = 'public'
INSERT statements are mapped to the 'create_board' GraphQL mutation.
The following inputs can be used in INSERT statements:
Name, Description, BoardKind, BoardFolderId, WorkspaceId, TemplateId, BoardOwnerIds, BoardOwnerTeamIds, BoardSubscriberIds, BoardSubscriberTeamIds, Empty
INSERT INTO Boards (WorkspaceId,BoardKind,Name,Description,BoardFolderId,BoardOwnerIds,BoardSubscriberTeamIds,Empty) VALUES ('3820334','public','NewBoard','A newly created board.','12689416','51688059,51085546','960990',true)
UPDATE statements are mapped to the 'update_board' and 'archive_board' GraphQL mutations.
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):
Id, Name, Description, Communication, State, BoardAttributes
UPDATE Boards SET Name='AnotherName' WHERE Id='5549166043'
UPDATE Boards SET State='archived' WHERE Id='5549166043'
DELETE statements are mapped to the 'delete_board' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Boards WHERE Id='5549166043'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The unique identifier of the board. | |
| CreatorId | String | False |
Users.Id |
The user's unique identifier. |
| Name | String | False |
The board's name. | |
| ItemTerminology | String | False |
The Board's item nickname, one of a predefined set of values, or a custom user value. | |
| ItemsCount | Int | False |
The number of items on the board. | |
| TopGroupId | String | False |
Groups.Id |
The group's unique identifier. |
| Description | String | False |
The board's description. | |
| UpdatedAt | Datetime | False |
The last time the board was updated at. | |
| Type | String | False |
The board object type. | |
| BoardKind | String | False |
The board's kind (public / private / share). | |
| BoardFolderId | String | False |
Folders.Id |
The board's folder unique identifier. |
| Communication | String | False |
Get the board communication value - typically meeting ID. | |
| Permissions | String | False |
The board's permissions. | |
| TagsIds | String | False |
Tags.Id |
A comma separated list of the tags' unique identifiers. |
| State | String | False |
The board's state (all / active / archived / deleted). | |
| WorkspaceId | String | False |
Workspaces.Id |
The board's workspace unique identifier (null for main workspace). |
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 |
| TemplateId | String |
Optional board template id. |
| BoardOwnerIds | String |
Optional, comma-seperated list of board owner user ids. |
| BoardOwnerTeamIds | String |
Optional, comma-seperated list of board owner team ids. |
| BoardSubscriberIds | String |
Optional, comma-seperated list of board subscriber ids. |
| BoardSubscriberTeamIds | String |
Optional, comma-seperated list of subscriber team ids. |
| Empty | Bool |
Optional flag to create an empty board (without any default items). |
Get a board's team subscribers.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM BoardTeams WHERE BoardId='5557271485'
INSERT statements are mapped to the 'add_teams_to_board' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardTeams (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
DELETE statements are mapped to the 'delete_teams_from_board' GraphQL mutation.
You can delete entries by specifying the Id and BoardId.
DELETE FROM BoardTeams WHERE Id='51688059' AND BoardId='5546871560'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
Teams.Id |
The board team's unique identifier. |
| BoardId [KEY] | String | False |
Boards.Id |
The unique identifier of the board. |
| Kind | String | False |
The team's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Get a board's subscribers.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM BoardUsers WHERE BoardId='5525287714'
SELECT * FROM BoardUsers WHERE Kind='owner'
INSERT statements are mapped to the 'add_users_to_board' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardUsers (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
DELETE statements are mapped to the 'delete_subscribers_from_board' GraphQL mutation.
You can delete entries by specifying the Id and BoardId.
DELETE FROM BoardUsers WHERE Id='51688059' AND BoardId='5546871560'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
Users.Id |
The board owner's unique identifier. |
| BoardId [KEY] | String | False |
Boards.Id |
The unique identifier of the board. |
| Kind | String | False |
The user's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Get a document's content blocks.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM DocBlocks WHERE DocId = '9014425'
SELECT * FROM DocBlocks WHERE DocId IN ('9014425','9014490')
INSERT statements are mapped to the 'create_doc_block' GraphQL mutation.
The following inputs can be used in INSERT statements:
ParentBlockId, DocId, Content, Type, AfterBlockId
INSERT INTO DocBlocks (DocId,Type,Content,AfterBlockId) VALUES ('9180448','code','{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"Test"}]}','53ab947f-226f-49f5-8d43-1021f9f36431')
UPDATE statements are mapped to the 'update_doc_block' GraphQL mutation.
The following inputs can be used in UPDATE statements:
Id, Content
UPDATE DocBlocks SET Content='{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"NewValue"}]}' WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
DELETE statements are mapped to the 'delete_doc_block' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM DocBlocks WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The block's unique identifier. | |
| ParentBlockId | String | False |
The block's parent block unique identifier. | |
| DocId | String | False |
Docs.Id |
The block's document unique identifier. |
| CreatedById | String | False |
Users.Id |
The user's unique identifier. |
| Position | Double | False |
The block's position on the document. | |
| Content | String | False |
The block's content. | |
| Type | String | False |
The block content type. | |
| CreatedAt | Date | False |
The block's creation date. | |
| UpdatedAt | Date | False |
The block's last updated date. |
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 |
| AfterBlockId | String |
After which block to insert this one. If not provided, will be inserted first in the document. |
Get a collection of docs.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Docs WHERE Id = '9014425'
SELECT * FROM Docs WHERE Id IN ('9014425','9014490')
SELECT * FROM Docs WHERE ObjectId = '5499548740'
SELECT * FROM Docs WHERE ObjectId IN ('5499548740','5499563743')
SELECT * FROM Docs WHERE WorkspaceId = '3578971'
INSERT statements are mapped to the 'create_doc' GraphQL mutation.
The following inputs can be used in INSERT statements:
WorkspaceId, DocKind, Name
INSERT INTO Docs (WorkspaceId,DocKind,Name) VALUES ('3820334','public','CreatedDoc')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The document's unique identifier. | |
| DocFolderId | String | False |
Folders.Id |
The document's folder unique identifier (null for first level). |
| ObjectId | String | False |
The associated board or object's unique identifier. | |
| WorkspaceId | String | False |
Workspaces.Id |
The document's workspace unique identifier (null for main workspace). |
| CreatedById | String | False |
Users.Id |
The user's unique identifier. |
| DocKind | String | False |
The document's kind (public / private / share). | |
| Name | String | False |
The document's name. | |
| RelativeUrl | String | False |
The document's relative url. | |
| Settings | String | False |
The document's settings. | |
| Url | String | False |
The document's direct url. | |
| CreatedAt | Date | False |
The document's creation date. |
Get a collection of folders. Note that this won't return folders from closed workspaces to which you are not subscribed.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Folders WHERE Id = '12622355'
SELECT * FROM Folders WHERE WorkspaceId = '3578971'
INSERT statements are mapped to the 'create_folder' GraphQL mutation.
The following inputs can be used in INSERT statements:
ParentId, WorkspaceId, Color, Name
INSERT INTO Folders (WorkspaceId,Name,Color) VALUES ('3578971','TestFolder','BRIGHT_BLUE')
UPDATE statements are mapped to the 'update_folder' GraphQL mutation.
The following inputs can be used in UPDATE statements:
Id, ParentId, Color, Name
UPDATE Folders SET Color='SUNSET',Name='UpdatedName' WHERE Id='12678064'
DELETE statements are mapped to the 'delete_folder' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Folders WHERE Id='12678064'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The folder's unique identifier. | |
| OwnerId | String | False |
Users.Id |
The folder's user owner unique identifier. |
| ParentId | String | False |
The unique identifiers of the folder's parent folder. | |
| SubFolderIds | String | False |
The unique identifiers of the sub-folders inside the folder. | |
| WorkspaceId | String | False |
Workspaces.Id |
The workspace's unique identifier. |
| Color | String | False |
The folder's color. | |
| Name | String | False |
The folder's name. | |
| CreatedAt | Datetime | False |
The folder's creation date. |
Get a board's visible groups.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
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 statements are mapped to the 'create_group' GraphQL mutation.
The following inputs can be used in INSERT statements:
BoardId, Title, RelativeTo, PositionRelativeMethod
INSERT INTO Groups (BoardId,Title,RelativeTo,PositionRelativeMethod) VALUES ('5525287714','NewGroup','testgroup','after_at')
UPDATE statements are mapped to the 'update_group' and 'archive_group' GraphQL mutations.
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):
Id, BoardId, Archived, Color, Title, RelativePositionAfter, RelativePositionBefore
UPDATE Groups SET Color='lime-green' WHERE BoardId='5525287714' AND Id='newgroup'
UPDATE Groups SET Archived='true' WHERE BoardId='5525287714' AND Id='newgroup'
DELETE statements are mapped to the 'delete_group' GraphQL mutation.
You can delete entries by specifying the Id and BoardId.
DELETE FROM Groups WHERE BoardId='5525287714' AND Id='testgroup'
| 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. | |
| 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 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). |
| 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. |
Get a collection of tags.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE IsPrivate = false
SELECT * FROM Tags WHERE Id = '13327214'
SELECT * FROM Tags WHERE Id IN ('13327214', '13327217')
INSERT statements are mapped to the 'create_or_get_tag' GraphQL mutation.
The following inputs can be used in INSERT statements:
Name, BoardId
INSERT INTO Tags (Name) VALUES ('TestTagName')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The tag's unique identifier. | |
| Color | String | False |
The tag's color. | |
| Name | String | False |
The tag's name. | |
| IsPrivate | Bool | False |
Whether or not the tag is private. | |
| BoardId | String | False |
A private board id to filter by or create a tag at (not needed for public boards). |
Get a collection of updates.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Updates WHERE Id = '173981152'
SELECT * FROM Updates WHERE ItemId = '1388002886'
SELECT * FROM Updates WHERE BoardId = '1388002765'
INSERT statements are mapped to the 'create_update' GraphQL mutation.
The following inputs can be used in INSERT statements:
Body, ItemId, ParentId
INSERT INTO Updates (ItemId,Body,ParentId) VALUES ('5525287847','This is a new reply.','2553498004')
DELETE statements are mapped to the 'delete_update' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Updates WHERE Id='2553512994'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The update's unique identifier. | |
| Body | String | False |
The update's html formatted body. | |
| CreatedAt | Datetime | False |
The update's creation date. | |
| CreatorId | String | False |
Users.Id |
The unique identifier of the update creator. |
| ItemId | String | False |
The update's item ID. | |
| TextBody | String | False |
The update's text body. | |
| UpdatedAt | Datetime | False |
The update's last edit date. | |
| AssetsIds | String | False |
Assets.Id |
A comma separated list of the update's assets/files unique identifiers. |
| Replies | String | False |
The update's replies. |
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 |
| ParentId | String |
The parent update's unique identifier. This can be used to create a reply to an update. |
Get a collection of webhooks.
The Sync App uses the Monday API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Webhooks WHERE BoardId='5574930939'
INSERT statements are mapped to the 'create_webhook' GraphQL mutation.
The following inputs can be used in INSERT statements:
BoardId, Config, Event, Url
INSERT INTO Webhooks (BoardId,Config,Event,Url) VALUES ('5574930939','{\"columnId\":\"status\", \"columnValue\":{\"$any$\":true}}','change_status_column_value','https://test.com/')
DELETE statements are mapped to the 'delete_webhook' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Webhooks WHERE Id='242031214'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The webhooks's unique identifier. | |
| BoardId | String | False |
Board unique identifier. | |
| Config | String | False |
The webhooks's config. | |
| Event | String | False |
The event webhook will listen to. | |
| AppWebhooksOnly | Bool | False |
Filters webhooks that were created by the app initiating the request. |
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 |
| Url | String |
The webhook URL. |
Get a collection of workspaces.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Workspaces WHERE Id='3578971'
SELECT * FROM Workspaces WHERE Kind='open'
SELECT * FROM Workspaces WHERE State='active'
INSERT statements are mapped to the 'create_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Description, Kind, Name
INSERT INTO Workspaces (Name,Kind,Description) VALUES ('New Workspace','open','This is my new workspace.')
UPDATE statements are mapped to the 'update_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, Description, Name, Kind
UPDATE Workspaces Set Description='testDescription', Name='testName', Kind='open' WHERE Id='3819431'
DELETE statements are mapped to the 'delete_workspace' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Workspaces WHERE Id='3819431'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The workspace's unique identifier. | |
| Description | String | False |
The workspace's description. | |
| Kind | String | False |
The workspace's kind (open / closed). | |
| Name | String | False |
The workspace's name. | |
| State | String | False |
The workspace's state (all / active / archived / deleted). | |
| CreatedAt | Datetime | False |
The workspace's creation date. | |
| AccountProductId | String | False |
The account product id. | |
| AccountProductKind | String | False |
The account product kind (core / marketing / crm / software / projectManagement / project_management / forms / whiteboard). | |
| SettingsIconColor | String | False |
The icon color in hex value. Used as a background for the image. | |
| SettingsIconImage | String | False |
The public image URL, which is temporary in the case of a file that was uploaded by the user, so you'll need to pull a new version at least once an hour. In case it is null, you can use the first letter of the workspace name. |
Get the teams subscribed to the workspace.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM WorkspaceTeams WHERE Kind='owner'
SELECT * FROM WorkspaceTeams WorkspaceId='3820334'
INSERT statements are mapped to the 'add_teams_to_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','subscriber')
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','owner')
DELETE statements are mapped to the 'delete_teams_from_workspace' GraphQL mutation.
You can delete entries by specifying the Id and WorkspaceId.
DELETE FROM WorkspaceTeams WHERE Id='961021' AND WorkspaceId='3820334'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The team's unique identifier. | |
| WorkspaceId [KEY] | String | False |
The workspace's unique identifier. | |
| Kind | String | False |
The team's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Get the users subscribed to the workspace.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM WorkspaceUsers WHERE WorkspaceId='3578971'
SELECT * FROM WorkspaceUsers WHERE Kind='owner'
INSERT statements are mapped to the 'add_users_to_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceUsers (Id,WorkspaceId,Kind) VALUES ('51688059','3820334','subscriber')
DELETE statements are mapped to the 'delete_users_from_workspace' GraphQL mutation.
You can delete entries by specifying the Id and WorkspaceId.
DELETE FROM WorkspaceUsers WHERE Id='51688059' AND WorkspaceId='3820334'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The user's unique identifier. | |
| WorkspaceId [KEY] | String | False |
The workspace's unique identifier. | |
| Kind | String | False |
The user's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| ActivityLogs | Get a board's log events. |
| Assets | Get a collection of assets by ids. |
| BoardViews | Get a board's views. |
| Teams | Get a collection of teams. |
| Users | Get a collection of users. |
Get a board's log events.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM ActivityLogs WHERE BoardId IN ('2307103055', '2182296646')
SELECT * FROM ActivityLogs WHERE UserId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ColumnId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE GroupId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ItemId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE CreatedAt > '2022-02-17 05:12:04.419' AND CreatedAt < '2022-02-17 05:12:04.861'
SELECT * FROM ActivityLogs WHERE CreatedAt >= '2022-02-17 05:12:04.419' AND CreatedAt <= '2022-02-17 05:12:04.861'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the activity log event. | |
| BoardId | String |
Boards.id | The unique identifier of the board. |
| AccountId | String | The account ID that initiated the event. | |
| UserId | String |
Users.Id | The user ID of the user who initiated the event. |
| CreatedAt | Datetime | The time of the event. | |
| Data | String | The item's column values in string form. | |
| Entity | String | The entity of the event that was changed (pulse / board). | |
| Event | String | The action that took place. | |
| ColumnId | String | Column id to filter. | |
| GroupId | String |
Groups.Id | Group id to filter. |
| ItemId | String | Item id to filter. |
Get a collection of assets by ids.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Assets WHERE Id = '397532775'
SELECT * FROM Assets WHERE Id IN ('397532775', '397532776')
| Name | Type | References | Description |
| Id [KEY] | String | The file's unique identifier. | |
| Name | String | The file's name. | |
| CreatedAt | Datetime | The file's creation date. | |
| FileExtension | String | The file's extension. | |
| FileSize | Int | The file's size in bytes. | |
| OriginalGeometry | String | The original geometry of the asset. | |
| PublicUrl | String | The public url to the asset, valid for 1 hour. | |
| UploadedById | String |
Users.Id | The user's unique identifier. |
| Url | String | The url to view the asset. | |
| UrlThumbnail | String | The url to view the asset in thumbnail mode. Only available for images. |
Get a board's views.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'
SELECT * FROM BoardViews WHERE BoardId IN ('2182296646', '2181960030')
| Name | Type | References | Description |
| Id [KEY] | String | The view's unique identifier. | |
| BoardId | String |
Boards.Id | The unique identifier of the board. |
| Name | String | The view's name. | |
| Settings | String | The view's settings in a string form. | |
| Type | String | The view's type. | |
| ViewSpecificData | String | Specific board view data (supported only for forms). | |
| SourceViewId | String | The view's template id if it was duplicated from another view. |
Get a collection of teams.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Teams WHERE Id = '565332'
SELECT * FROM Teams WHERE Id IN ('565332, 565333')
| Name | Type | References | Description |
| Id [KEY] | String | The team's unique identifier. | |
| Name | String | The team's name. | |
| PictureUrl | String | The team's picture url. |
Get a collection of users.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App. 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.
SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE ID = '27278379'
SELECT * FROM Users WHERE ID IN ('27278379', '27278377')
SELECT * FROM Users WHERE Email = '[email protected]'
SELECT * FROM Users WHERE Email IN ('[email protected]', '[email protected]')
| Name | Type | References | Description |
| Id [KEY] | String | The user's unique identifier. | |
| TeamsIds | String |
Teams.Id | A list of teams unique identifiers to which the user belongs. |
| Name | String | The user's name. | |
| Phone | String | The user's phone number. | |
| Birthday | Date | The user's birthday. | |
| CurrentLanguage | String | The current user's language. | |
| CountryCode | String | The user's country code. | |
| CreatedAt | Datetime | The user's creation date. | |
| LastActivity | Datetime | Last date and time when user was active. | |
| String | The user's email. | ||
| Enabled | Bool | Whether or not the user is enabled. | |
| IsAdmin | Bool | Whether or not the user is an account admin. | |
| IsGuest | Bool | Whether or not the user is a guest. | |
| IsPending | Bool | Whether or not the user is a pending user | |
| IsVerified | Bool | Whether or not the user verified their email. | |
| IsViewOnly | Bool | Whether or not the user is a view only user. | |
| JoinDate | Date | The date the user joined the account. | |
| Location | String | The user's location. | |
| MobilePhone | String | The user's mobile phone number. | |
| PhotoOriginal | String | The user's photo in the original size. | |
| PhotoSmall | String | The user's photo in small size (150x150). | |
| PhotoThumb | String | The user's photo in thumbnail size (100x100). | |
| PhotoThumbSmall | String | The user's photo in small thumbnail size (50x50). | |
| PhotoTiny | String | The user's photo in tiny size (30x30). | |
| TimeZoneIdentifier | String | The user's timezone identifier. | |
| Title | String | The user's title. | |
| Url | String | The user's profile url. | |
| UtcHoursDiff | Int | The user's utc hours difference. | |
| SignUpProductKind | String | The product to which the user signed up to first. | |
| AccountFirstDayOfTheWeek | String | The first day of the week for the account (sunday / monday) | |
| AccountId | String | The account's unique identifier. | |
| AccountLogo | String | The account's logo. | |
| AccountName | String | The account's name. | |
| AccountPlanMaxUsers | Int | The maximum users allowed in the plan. | |
| AccountPlanPeriod | String | The plan's time period. | |
| AccountPlanTier | String | The plan's tier. | |
| AccountPlanVersion | Int | The plan's version. | |
| AccountShowTimelineWeekends | Bool | Whether or not to show weekends in the timeline. | |
| AccountSlug | String | The account's slug. | |
| AccountTier | String | The account's tier. | |
| AccountCountryCode | String | The account's country two-letter code in ISO3166 format. | |
| AccountSignUpProductKind | String | The product the account signed up to first. | |
| AccountProducts | String | The account's active products. | |
| OutOfOfficeActive | Bool | Is the status active? | |
| OutOfOfficeDisableNotifications | Bool | Are notification disabled? | |
| OutOfOfficeStartDate | Date | The status start date. | |
| OutOfOfficeEndDate | Date | The status end date. | |
| OutOfOfficeType | String | Out of office type. | |
| NonActive | Bool | Return non active users in the account. |
This section shows the available API objects and provides more information on executing SQL to Monday APIs.
Views are tables that cannot be modified. Typically, model data that is read-only and cannot be updated are shown as views.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AuditLogs | Get a board's audit log events. |
Get a board's audit log events.
All available values for the event filter are listed and explained below:
The following queries are executed server-side:
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z'
SELECT * FROM AuditLogs WHERE Event IN ('export-board-activity-log', 'delete-board')
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z' AND Event = 'delete-board' AND UserId = 27 AND IpAddress = '123.123'
| Name | Type | References | Description |
| Timestamp | Datetime | The timestamp of the event | |
| AccountId | String | The account ID that initiated the event. | |
| UserId | Integer | The user ID of the user who initiated the event. | |
| Event | String | The action that took place.
The allowed values are export-board-activity-log, export-account-data, download-attachment, export-board, export-dashboard, export-content-directory, login, forgot-password, logout, failed-login, user-reactivated, user-deactivated, user-details-deleted, user-invite, cancel-user-invite, user-role-change, delete-board, delete-workspace, create-team, delete-team, security-settings-change, board-broadcast-enabled, add-user-to-team, remove-user-from-team, add-user-to-product, remove-user-from-product, add-team-to-product, remove-team-from-product, api-complexity-breach-over-time. | |
| Slug | String | The slug of the event that took place. | |
| IpAddress | String | The IP Address recorded for this event. | |
| UserAgent | String | The User Agent of the event. | |
| ClientName | String | Name of the software client. | |
| ClientVersion | String | Version of the software client. | |
| OsName | String | Name of the operating system. | |
| OsVersion | String | Version of the operating system. | |
| DeviceName | String | The name of the device. | |
| DeviceType | String | The type of the device. | |
| ActivityMetadata | String | Additional activity metadata for the event |
This section shows the available API objects and provides more information on executing SQL to Monday APIs.
Tables are tables that can be modified.
Stored Procedures are function-like interfaces to the data source.
The Sync App models the data in Monday as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Board | An example board. |
| BoardSubitems | An example subitems board. |
An example board.
Note that multiple filters are supported server-side provided they are all connected with either only AND or only OR logical operators.
The following columns are sorted server-side when including an ORDER BY clause:
The following queries are processed server side:
SELECT * FROM Board
SELECT * FROM Board WHERE ItemId = '5465844671'
SELECT * FROM Board WHERE ItemId IN ('5465844671','5465844679')
SELECT * FROM Board WHERE Item = 'Item 2'
SELECT * FROM Board WHERE Item != 'Item 2'
SELECT * FROM Board WHERE Item NOT IN ('Item 1','Item 2')
SELECT * FROM Board WHERE Item Contains 'Item'
SELECT * FROM Board WHERE CONTAINS(Item,'Item')
SELECT * FROM Board WHERE NOT CONTAINS(Item,'Item')
SELECT * FROM Board WHERE Check = True
SELECT * FROM Board WHERE Check != True
SELECT * FROM Board WHERE Check IS TRUE
SELECT * FROM Board WHERE Check IS NOT TRUE
SELECT * FROM Board WHERE Check = False
SELECT * FROM Board WHERE Check != False
SELECT * FROM Board WHERE Check IS FALSE
SELECT * FROM Board WHERE Check IS NOT FALSE
SELECT * FROM Board WHERE BoardRelationLinkedItemIds = ''
SELECT * FROM Board WHERE BoardRelationLinkedItemIds != ''
SELECT * FROM Board WHERE BoardRelationDisplayValue = ''
SELECT * FROM Board WHERE BoardRelationDisplayValue != ''
SELECT * FROM Board WHERE CountryCode = 'US'
SELECT * FROM Board WHERE CountryCode != 'US'
SELECT * FROM Board WHERE CountryCode IN ('US','UK')
SELECT * FROM Board WHERE CountryCode NOT IN ('US','UK')
SELECT * FROM Board WHERE CountryCode IS NULL
SELECT * FROM Board WHERE CountryCode IS NOT NULL
SELECT * FROM Board WHERE DependentOnDisplayValue = '[]'
SELECT * FROM Board WHERE DependentOnDisplayValue != '[]'
SELECT * FROM Board WHERE Hour='07:32:00'
SELECT * FROM Board WHERE Numbers IN (12, 55)
SELECT * FROM Board WHERE Numbers = 10
SELECT * FROM Board WHERE Numbers != 10
SELECT * FROM Board WHERE Numbers > 10
SELECT * FROM Board WHERE Numbers >= 10
SELECT * FROM Board WHERE Numbers < 10
SELECT * FROM Board WHERE Numbers <= 10
SELECT * FROM Board WHERE Text='test' AND Numbers=10
SELECT * FROM Board WHERE Text='test' OR Numbers=10
SELECT * FROM Board ORDER BY Item
SELECT * FROM Board ORDER BY CreatedAt
SELECT * FROM Board ORDER BY UpdatedAt
SELECT * FROM Board ORDER BY Numbers ASC NULLS LAST
INSERT statements are mapped to the 'create_item' GraphQL mutation.
The following inputs can be used in INSERT statements:
GroupId, ItemName, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
INSERT INTO Board (Item,GroupId,Check) VALUES ('Test','topics',true)
INSERT INTO Board (Item,GroupId,CountryCode,CountryName) VALUES ('Test','topics','US','United States')
INSERT INTO Board (Item,GroupId,Date) VALUES ('Test','topics','2023-11-16')
INSERT INTO Board (Item,GroupId,Datetime) VALUES ('Test','topics','2023-11-16 09:00:00.0-05:00')
INSERT INTO Board (Item,GroupId,DependentLinkedItemsIds) VALUES ('Test','topics','[5561036960, 5561037791]')
INSERT INTO Board (Item,GroupId,DropdownText) VALUES ('Test','topics','label1,label2')
INSERT INTO Board (Item,GroupId,DropdownText,CreateLabelsIfMissing) VALUES ('Test','topics','label3,label4','true')
INSERT INTO Board (Item,GroupId,DropdownValue) VALUES ('Test','topics','{"ids":[1,2]}')
INSERT INTO Board (Item,GroupId,Email,EmailLabel) VALUES ('Test','topics','[email protected]','Mail')
INSERT INTO Board (Item,GroupId,Hour) VALUES ('Test','topics','09:00:00')
INSERT INTO Board (Item,GroupId,LinkUrl,LinkUrlText) VALUES ('Test','topics','https://www.test.com/', 'TestLink')
INSERT INTO Board (Item,GroupId,LocationLat,LocationLng,LocationAddress) VALUES ('Test','topics',29.9772962,31.1324955,'Giza Pyramid Complex')
INSERT INTO Board (Item,GroupId,LongText) VALUES ('Test','topics','TestText')
INSERT INTO Board (Item,GroupId,Numbers) VALUES ('Test','topics','-10')
INSERT INTO Board (Item,GroupId,PeopleValue) VALUES ('Test','topics','{"personsAndTeams":[{"id":51688059,"kind":"person"},{"id":51085546,"kind":"person"}]}')
INSERT INTO Board (Item,GroupId,PhoneCountryShortName,Phone) VALUES ('Test','topics','US','12345678900')
INSERT INTO Board (Item,GroupId,Rating) VALUES ('Test','topics','5')
INSERT INTO Board (Item,GroupId,StatusIndex) VALUES ('Test','topics','2')
INSERT INTO Board (Item,GroupId,StatusIndex,StatusLabel,CreateLabelsIfMissing) VALUES ('Test','topics','15','NewLabel','true')
INSERT INTO Board (Item,GroupId,StatusLabel) VALUES ('Test','topics','Working on it')
INSERT INTO Board (Item,GroupId,TagsIds) VALUES ('Test','topics','[20826704,20826705]')
INSERT INTO Board (Item,GroupId,BoardLinkedItemIds) VALUES ('Test','topics','[5561037791,5561036960]')
INSERT INTO Board (Item,GroupId,Text) VALUES ('Test','topics','TestText')
INSERT INTO Board (Item,GroupId,TimelineFrom,TimelineTo) VALUES ('Test','topics','2023-11-01','2023-12-04')
INSERT INTO Board (Item,GroupId,WeekStartDate,WeekEndDate) VALUES ('Test','topics','2023-11-05','2023-11-11')
INSERT INTO Board (Item,GroupId,World_Clock) VALUES ('Test','topics','Africa/Algiers')
UPDATE statements are mapped to the 'change_multiple_column_values','move_item_to_group', and 'archive_item' GraphQL mutations.
The following inputs can be used in UPDATE statements:
ItemId, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock, GroupId, State
Note that GroupId, State and column values cannot be updated in the same statement.
Also note that certain types require specifying all related columns to update the object's value (this includes Email, Link, Location, Phone, Timeline, Week).
UPDATE Board SET GroupId='new_group' WHERE ItemId='5562458608'
UPDATE Board SET State='archived' WHERE ItemId='5562458608'
UPDATE Board SET Check = false WHERE ItemId='5561890829'
UPDATE Board SET CountryCode='US',CountryName='United States' WHERE ItemId='5561890829'
UPDATE Board SET CountryCode=NULL,CountryName=NULL WHERE ItemId='5561890829'
UPDATE Board SET Date='2023-11-25' WHERE ItemId='5561890829'
UPDATE Board SET Date=NULL WHERE ItemId='5561890829'
UPDATE Board SET Datetime='2023-11-23 04:00:00.0' WHERE ItemId='5561890829'
UPDATE Board SET DependentLinkedItemsIds='[5562459384, 5562458774]' WHERE ItemId='5561890829'
UPDATE Board SET DependentLinkedItemsIds=NULL WHERE ItemId='5561890829'
UPDATE Board SET DropdownText='Label1,Label2' WHERE ItemId='5561890829'
UPDATE Board SET DropdownText='Label6,Label7',CreateLabelsIfMissing='true' WHERE ItemId='5561890829'
UPDATE Board SET DropdownValue='{"ids":[2,3]}' WHERE ItemId='5561890829'
UPDATE Board SET DropdownValue=NULL WHERE ItemId='5561890829'
UPDATE Board SET Email='[email protected]',EmailLabel='NewMail' WHERE ItemId='5561890829'
UPDATE Board SET Email=NULL,EmailLabel=NULL WHERE ItemId='5561890829'
UPDATE Board SET Hour='21:00:00' WHERE ItemId='5561890829'
UPDATE Board SET Hour=NULL WHERE ItemId='5561890829'
UPDATE Board SET LinkUrl='https://www.test.com',LinkUrlText='TestText' WHERE ItemId='5561890829'
UPDATE Board SET LinkUrl=NULL,LinkUrlText=NULL WHERE ItemId='5561890829'
UPDATE Board SET LocationAddress=NULL,LocationLat=NULL,LocationLng=NULL WHERE ItemId='5561890829'
UPDATE Board SET LocationLat='82',LocationLng='135',LocationAddress='TestLocation' WHERE ItemId='5561890829'
UPDATE Board SET LongText='changed text' WHERE ItemId='5561890829'
UPDATE Board SET LongText=NULL WHERE ItemId='5561890829'
UPDATE Board SET Numbers=10 WHERE ItemId='5561890829'
UPDATE Board SET Numbers=NULL WHERE ItemId='5561890829'
UPDATE Board SET PeopleValue='{"personsAndTeams":[{"id":51085546,"kind":"person"},{"id":961021,"kind":"team"}]}' WHERE ItemId='5561890829'
UPDATE Board SET PeopleValue=NULL WHERE ItemId='5561890829'
UPDATE Board SET Phone=NULL,PhoneCountryShortName=NULL WHERE ItemId='5561890829'
UPDATE Board SET PhoneCountryShortName='US',Phone='16102347959' WHERE ItemId='5561890829'
UPDATE Board SET Rating='1' WHERE ItemId='5561890829'
UPDATE Board SET Rating=NULL WHERE ItemId='5561890829'
UPDATE Board SET StatusIndex='2' WHERE ItemId='5561890829'
UPDATE Board SET StatusIndex=NULL WHERE ItemId='5561890829'
UPDATE Board SET StatusLabel='NewLabel',StatusIndex='159',CreateLabelsIfMissing='true' WHERE ItemId='5561890829'
UPDATE Board SET StatusLabel='Working on it' WHERE ItemId='5561890829'
UPDATE Board SET TagsIds='[20826705,20833783]' WHERE ItemId='5561890829'
UPDATE Board SET TagsIds=NULL WHERE ItemId='5561890829'
UPDATE Board SET BoardLinkedItemIds = NULL WHERE ItemId='5561890829'
UPDATE Board SET BoardLinkedItemIds='[5562459384, 5561890829, 5562458774]' WHERE ItemId='5561890829'
UPDATE Board SET Text='changedText' WHERE ItemId='5561890829'
UPDATE Board SET Text=NULL WHERE ItemId='5561890829'
UPDATE Board SET TimelineFrom='2023-01-01', TimelineTo='2023-10-10' WHERE ItemId='5561890829'
UPDATE Board SET TimelineFrom=NULL, TimelineTo=NULL WHERE ItemId='5561890829'
UPDATE Board SET WeekStartDate='2023-11-13', WeekEndDate='2023-11-19' WHERE ItemId='5561890829'
UPDATE Board SET WeekStartDate=NULL, WeekEndDate=NULL WHERE ItemId='5561890829'
UPDATE Board SET WorldClock='America/New York' WHERE ItemId='5561890829'
UPDATE Board SET WorldClock=NULL WHERE ItemId='5561890829'
DELETE statements are mapped to the 'delete_item' GraphQL mutation.
You can delete items by specifying the ItemId.
DELETE FROM Board WHERE ItemId='5561890829'
| Name | Type | ReadOnly | References | Description |
| ItemId [KEY] | String | False |
The item's unique identifier. | |
| CreatorId | String | False |
The item's creator unique identifier. | |
| CreatedAt | Datetime | False |
The item's create date. | |
| UpdatedAt | Datetime | False |
The item's last updated date. | |
| State | String | False |
The item's state (all, active, archived, deleted). | |
| RelativeLink | String | False |
The item's relative path. | |
| ItemEmail | String | False |
The item's email. | |
| AssetsIds | String | False |
A comma separated list of the items' assets/files unique identifiers. | |
| GroupId | String | False |
The title of the group that contains this item. | |
| GroupTitle | String | False |
The title of the group that contains this item. | |
| Item | String | False |
The item's name. | |
| BoardRelationDisplayValue | String | False |
A string representing all the names of the linked items, separated by commas. | |
| BoardRelationLinkedItemIds | String | False |
The linked item IDs. | |
| ButtonLabel | String | False |
The button's label. | |
| ButtonColor | String | False |
The button's color in hex value. | |
| ButtonValue | String | False |
The column's value in json format. | |
| Check | Bool | False |
The column's boolean value. | |
| ColorPickerColor | String | False |
The color in hex value. | |
| ColorPickerValue | String | False |
The column's value in json format. | |
| CountryCode | String | False |
The country's two-letter code. | |
| CountryName | String | False |
The country's name. | |
| DateIcon | String | False |
The string representation of selected icon. | |
| Date | Date | False |
The column's date value. | |
| Datetime | Datetime | False |
The column's datetime value. | |
| DependencyDisplayValue | String | False |
Choose the item your task will be dependent on. If the “dependent on” item’s date is changing, the other dates will adjust automatically A string representing all the names of the linked items, separated by commas. | |
| DependencyLinkedItemsIds | String | False |
Choose the item your task will be dependent on. If the “dependent on” item’s date is changing, the other dates will adjust automatically The linked items ids. | |
| DocFileId | String | False |
The file's unique identifier. | |
| DocFileCreatorId | String | False |
The ID of user who created the file. | |
| DocFileObjectId | String | False |
The associated board or object's unique identifier. | |
| DocFileUrl | String | False |
The file's url. | |
| DropdownText | String | False |
The column's textual value in string form. | |
| DropdownValue | String | False |
The column's value in json format. | |
| String | False |
The column's email value. | ||
| EmailLabel | String | False |
The column's text value. It can be the same as email when user didn't enter any text. | |
| FileText | String | False |
The column's textual value in string form. | |
| FileValue | String | False |
The column's value in json format. | |
| Hour | Time | False |
The column's time value. | |
| IntegrationIssueId | String | False |
ID of the issue. | |
| IntegrationEntityId | String | False |
ID of the entity. | |
| IntegrationIssueApiUrl | String | False |
URL of the issue. | |
| IntegrationValue | String | False |
The column's value in json format. | |
| LastUpdated | String | False |
ID of the user who updated the item. | |
| LinkUrl | String | False |
Url. | |
| LinkUrlText | String | False |
Url text. | |
| LocationLat | Double | False |
Latitude. | |
| LocationLng | Double | False |
Longitude. | |
| LocationPlaceId | String | False |
Place ID of the location. | |
| LocationAddress | String | False |
Address. | |
| LocationCity | String | False |
City. | |
| LocationCityShort | String | False |
City. | |
| LocationCountry | String | False |
Country. | |
| LocationCountryShort | String | False |
Country short name (e.g. PE for Peru). | |
| LocationStreet | String | False |
Street. | |
| LocationStreetNumber | String | False |
Number of building in the street. | |
| LocationStreetNumberShort | String | False |
Short number of building in the street. | |
| LocationStreetShort | String | False |
Street. | |
| LongText | String | False |
Long text. | |
| MirrorDisplayValue | String | False |
The display value of the mirrored items' column. | |
| MirroredItems | String | False |
The mirrored items. | |
| Numbers | Double | False |
Number. | |
| PeopleText | String | False |
The column's textual value in string form. | |
| PeopleValue | String | False |
The column's value in json format. | |
| PhoneCountryShortName | String | False |
ISO-2 country code. | |
| Phone | String | False |
Phone number. | |
| Rating | Int | False |
Rating value. | |
| StatusIndex | Int | False |
The index of the status in the board. | |
| StatusIsDone | Bool | False |
Whether the status is done. | |
| StatusLabel | String | False |
The label of the status. | |
| StatusUpdateId | String | False |
The ID of an update attached to the status. | |
| StatusLabelStyleColor | String | False |
The style of the status label. The label's color in hex format. | |
| StatusLabelStyleBorder | String | False |
The style of the status label. The label's border color in hex format. | |
| TagsText | String | False |
The column's textual value in string form. | |
| TagsIds | String | False |
Tag IDs. | |
| Text | String | False |
The column's textual value in string form. | |
| TimeTrackingRunning | Bool | False |
Whether the time tracker is running. | |
| TimeTrackingStartedAt | Datetime | False |
The date when the time tracker was started. | |
| TimeTrackingDuration | Int | False |
Total duration of the time tracker in seconds. | |
| TimelineFrom | Date | False |
The start date of the timeline. | |
| TimelineTo | Date | False |
The end date of the timeline. | |
| TimelineVisualizationType | String | False |
The visualization type for the timeline. | |
| VoteCount | Int | False |
The total number of votes. | |
| VoterIds | String | False |
A list of IDs of users who voted. | |
| WeekStartDate | Date | False |
The start date of the week. | |
| WeekEndDate | Date | False |
The end date of the week. | |
| WorldClock | String | False |
Timezone. |
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 |
| CreateLabelsIfMissing | Bool |
Create Status/Dropdown labels if they're missing. Requires permission to change board structure. |
An example subitems board.
SELECT C.ItemId AS ChildId, C.Subitem AS ChildName, P.ItemId AS ParentId, P.Item AS ParentName FROM BoardSubitems C INNER JOIN Board P ON C.ParentItemId=P.ItemId
INSERT statements are mapped to the 'create_subitem' GraphQL mutation.
The following inputs can be used in INSERT statements:
ParentItemId, GroupId, ItemName, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
INSERT INTO BoardSubitems (ParentItemId, Subitem) VALUES ('5562458608','NewSubItem')
UPDATE statements are mapped to the 'change_multiple_column_values' GraphQL mutation.
The following inputs can be used in UPDATE statements:
ItemId, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
UPDATE BoardSubitems SET WorldClock='Europe/Amsterdam' WHERE ItemId='5573109452'
DELETE statements are mapped to the 'delete_item' GraphQL mutation.
You can delete entries by specifying the ItemId.
| Name | Type | ReadOnly | References | Description |
| ItemId [KEY] | String | False |
The item's unique identifier. | |
| ParentItemId | String | False |
The item's parent unique identifier. | |
| CreatorId | String | False |
The item's creator unique identifier. | |
| CreatedAt | Datetime | False |
The item's create date. | |
| UpdatedAt | Datetime | False |
The item's last updated date. | |
| State | String | False |
The item's state (all, active, archived, deleted). | |
| RelativeLink | String | False |
The item's relative path. | |
| ItemEmail | String | False |
The item's email. | |
| AssetsIds | String | False |
A comma separated list of the items' assets/files unique identifiers. | |
| GroupId | String | False |
The title of the group that contains this item. | |
| GroupTitle | String | False |
The title of the group that contains this item. | |
| Subitem | String | False |
The item's name. | |
| OwnerText | String | False |
The column's textual value in string form. | |
| OwnerValue | String | False |
The column's value in json format. | |
| StatusIndex | Int | False |
The index of the status in the board. | |
| StatusIsDone | Bool | False |
Whether the status is done. | |
| StatusLabel | String | False |
The label of the status. | |
| StatusUpdateId | String | False |
The ID of an update attached to the status. | |
| StatusLabelStyleColor | String | False |
The style of the status label. The label's color in hex format. | |
| StatusLabelStyleBorder | String | False |
The style of the status label. The label's border color in hex format. | |
| DateIcon | String | False |
The string representation of selected icon. | |
| Date | Date | False |
The column's date value. | |
| Datetime | Datetime | False |
The column's datetime value. |
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 |
| CreateLabelsIfMissing | Bool |
Create Status/Dropdown labels if they're missing. Requires permission to change board structure. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| Schema | Specifies which Monday schema to use. |
| AuthScheme | The type of authentication to use when connecting to Monday. |
| APIToken | The API token obtained from your Monday account. |
| Domain | Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com. |
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| MaxPointsPerCall | Specifies how many points a call will cost. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| Schema | Specifies which Monday schema to use. |
| AuthScheme | The type of authentication to use when connecting to Monday. |
| APIToken | The API token obtained from your Monday account. |
| Domain | Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com. |
Specifies which Monday schema to use.
Possible values include 'Information' for general views with information on your account, 'AuditLog' for the Audit Log API, and values corresponding to dynamically generated schemas based on the workspaces in your account.
The type of authentication to use when connecting to Monday.
The API token obtained from your Monday account.
Admin Tab
If you are an admin user on your monday.com account, you are able to access your API tokens from the "Admin" tab with the following steps:
Developer Tab
If you are a member user on your monday.com account, you are able to access your API tokens from the Developer tab with the following steps:
Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com.
Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Sync App opens a connection to Monday and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Monday Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxPointsPerCall | Specifies how many points a call will cost. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Specifies how many points a call will cost.
The total cost of a single query cannot exceed 5,000,000 points at any given time. Trial and free accounts using personal API tokens cannot exceed 1,000,000 points per minute.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.